Bump version to 2.6.0
[far2l.git] / man / far2l.1
blob06ff1f1089d8897063d2ba30a0f5bd89dfe1438c
1 .\" -*- mode: troff; coding: UTF-8 -*-
2 .\"TOPICS "Topics:"
3 .TH FAR2L 1 "25-12-22" "FAR2L Version 2.4.1" "Linux fork of FAR Manager v2"
4 .\"SKIP_SECTION"
5 .SH "NAME"
6 far2l \- Oldschool file manager, with built\-in terminal and other usefulness\'es.
7 .\"SKIP_SECTION"
8 .SH "SYNOPSIS"
9 .B far2l
10 [\fI\,OPTION\/\fR] [\fB\-cd \fI\,APATH\/\fR \fB \-cd \fI\,PPATH\/\fR]]
11 .\"NODE "DESCRIPTION"
12 .SH "DESCRIPTION"
13 .B far2l
14 is a Linux fork of FAR Manager v2, directory browser/file manager for
15 Unix\-like operating systems.
16 .\"NODE "OPTIONS"
17 .\"DONT_SPLIT"
18 .SH "OPTIONS"
19 .TP
20 \fB\-h\fR
21 Display this help and exit.
22 .TP
23 \fB\-a\fR
24 Disable display of characters with codes 0 - 31 and 255.
25 .TP
26 \fB\-ag\fR
27 Disable display of pseudographics with codes > 127.
28 .TP
29 \fB\-an\fR
30 Disable display of pseudographics characters completely.
31 .TP
32 \fB\-co\fR
33 Forces FAR to load plugins from the cache only.
34 .TP
35 \fB\-cd\fR \fI\,APATH\/\fR|\fI\,PPATH\/\fR
36 Change panel's directory to specified path.
37 \fI\,APATH\/\fR \- path to a folder (or a file or an archive or command with prefix)
38 for the active panel.
39 \fI\,PPATH\/\fR \- path to a folder (or a file or an archive or command with prefix)
40 for the passive panel.
41 .TP
42 \fB\-m\fR
43 Do not load macros.
44 .TP
45 \fB\-ma\fR
46 Do not execute auto run macros.
47 .TP
48 \fB\-u\fR \fI\,IDENTITY\/\fR OR \fI\,/PATH/NAME\/\fR
49       Allows to specify separate settings \fI\,IDENTITY\/\fR or FS location.
50 .TP
51 \fB\-v\fR \fI\,FILENAME\/\fR
52 View the specified file.
53 .TP
54 \fB\-v\fR \- \fI\,COMMAND LINE\/\fR
55  Executes given \fI\,COMMAND LINE\/\fR and opens viewer with its output.
56 .TP
57 \fB\-e\fR[\fI\,LINE\/\fR[:\fI\,POS\/\fR]] \fI\,FILENAME\/\fR
58  Edit the specified file with optional cursor position specification.
59 .TP
60 \fB\-e\fR[\fI\,LINE\/\fR[:\fI\,POS\/\fR]] \fI\,COMMAND LINE\/\fR
61 Executes given command line and opens editor with its output.
62 .\"NODE "BACKEND OPTIONS"
63 .\"DONT_SPLIT"
64 .SH "BACKEND-SPECIFIC OPTIONS"
65 .TP
66 \fB\-\-tty\fP
67 force using TTY backend only (disable GUI/TTY autodetection)
68 .TP
69 \fB\-\-notty\fP
70 don't fallback to TTY backend if GUI backend failed
71 .TP
72 \fB\-\-norgb\fP
73 don't use true (24-bit) colors
74 .TP
75 \fB\-\-nodetect\fP, \fB\-\-nodetect\fP=[f|][x|xi]
76 don't detect if TTY backend supports FAR2L or X11/Xi extensions
77 .TP
78 \fB\-\-mortal\fP
79 terminate instead of going to background on getting SIGHUP (default if in Linux TTY)
80 .TP
81 \fB\-\-immortal\fP
82 go to background instead of terminating on getting SIGHUP (default if not in Linux TTY)
83 .TP
84 \fB\-\-ee\fP, \fB\-\-ee\fP=\fI\,N\/\fR
85 ESC expiration in \fI\,N\/\fR msec (100 if unspecified) to avoid need for double ESC presses (valid only in TTY mode without FAR2L extensions)
86 .TP
87 \fB\-\-primary-selection\fP
88 use PRIMARY selection instead of CLIPBOARD X11 selection (only for GUI backend)
89 .\"NODE "FULL HELP"
90 .SH "FULL HELP"
91 far2l historically has its own contextual help system that can be found via pressing F1 key wherever in its TUI.
92 .\"NODE "LICENSE"
93 .SH "LICENSE"
94 This program is distributed under the terms of the GNU General Public
95 License as published by the Free Software Foundation. See the built\-in
96 help for details on the License and the lack of warranty.
97 .\"NODE "AVAILABILITY"
98 .SH "AVAILABILITY"
99 The latest version of this program can be found at
100         https://github.com/elfmz/far2l
101 .\"NODE "SEE ALSO"
102 .SH "SEE ALSO"
103 mc(1), ed(1), gpm(1), terminfo(1), view(1), sh(1), bash(1),
104 tcsh(1), zsh(1).
107 Linux fork of FAR Manager v2 on the World Wide Web:
108         https://github.com/elfmz/far2l
110 .\"NODE "AUTHORS"
111 .SH "AUTHORS"
112 Authors and contributors are listed in the copyright file.
113 .\"NODE "BUGS"
114 .SH "BUGS"
115 If you want to report a problem with the program, please create bugreport
116 at https://github.com/elfmz/far2l/issues.
118 Provide a detailed description of the bug, the version of the program
119 you are running.
120 If the program crashes, we would appreciate a stack trace.