correct after #2213 vertical keys processing in dialog
[far2l.git] / man / far2l.1
blob14617759d2b0b881b443a4f671b03ec63b48236f
1 .\" -*- mode: troff; coding: UTF-8 -*-
2 .\"TOPICS "Topics:"
3 .TH FAR2L 1 "28-04-24" "FAR2L Version 2.6.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 or empty new file.
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 .TP
63 \fB\-set:\fI\,PARAMETER\/\fR=\fI\,VALUE\/\fR
64 Override the configuration parameter, see far:config for details.
65 .EX
66 Example: far2l -set:Language.Main=English -set:Screen.Clock=0 -set:XLat.Flags=0xff -set:System.FindFolders=false
67 .EE
68 .\"NODE "BACKEND OPTIONS"
69 .\"DONT_SPLIT"
70 .SH "BACKEND-SPECIFIC OPTIONS"
71 .TP
72 \fB\-\-tty\fP
73 force using TTY backend only (disable GUI/TTY autodetection)
74 .TP
75 \fB\-\-notty\fP
76 don't fallback to TTY backend if GUI backend failed
77 .TP
78 \fB\-\-norgb\fP
79 don't use true (24-bit) colors
80 .TP
81 \fB\-\-nodetect\fP, \fB\-\-nodetect\fP=[f|][x|xi]
82 don't detect if TTY backend supports FAR2L or X11/Xi extensions
83 .TP
84 \fB\-\-mortal\fP
85 terminate instead of going to background on getting SIGHUP (default if in Linux TTY)
86 .TP
87 \fB\-\-immortal\fP
88 go to background instead of terminating on getting SIGHUP (default if not in Linux TTY)
89 .TP
90 \fB\-\-x11\fP
91 force GUI backend to run on X11
92 .TP
93 \fB\-\-wayland\fP
94 force GUI backend to run on Wayland
95 .TP
96 \fB\-\-ee\fP, \fB\-\-ee\fP=\fI\,N\/\fR
97 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)
98 .TP
99 \fB\-\-primary-selection\fP
100 use PRIMARY selection instead of CLIPBOARD X11 selection (only for GUI backend)
102 \fB\-\-maximize\fP
103 force maximize window upon launch (only for GUI backend)
105 \fB\-\-nomaximize\fP
106 dont maximize window upon launch even if its has saved maximized state (only for GUI backend)
108 \fB\-\-clipboard=\fI\,SCRIPT\/\fR\fP
109 use external clipboard handler script that implements get/set text clipboard data via its stdin/stdout
111 Backend-specific options also can be set via the \fB\,FAR2L_ARGS\/\fR environment variable
113 (for example: export FAR2L_ARGS="--tty --nodetect --ee" and then simple far2l to force start only TTY backend).
115 .\"NODE "FULL HELP"
116 .SH "FULL HELP"
117 far2l historically has its own contextual help system that can be found via pressing F1 key wherever in its TUI.
118 .\"NODE "LICENSE"
119 .SH "LICENSE"
120 This program is distributed under the terms of the GNU General Public
121 License as published by the Free Software Foundation. See the built\-in
122 help for details on the License and the lack of warranty.
123 .\"NODE "AVAILABILITY"
124 .SH "AVAILABILITY"
125 The latest version of this program can be found at
126         https://github.com/elfmz/far2l
127 .\"NODE "SEE ALSO"
128 .SH "SEE ALSO"
129 mc(1), ed(1), gpm(1), terminfo(1), view(1), sh(1), bash(1),
130 tcsh(1), zsh(1).
133 Linux fork of FAR Manager v2 on the World Wide Web:
134         https://github.com/elfmz/far2l
136 .\"NODE "AUTHORS"
137 .SH "AUTHORS"
138 Authors and contributors are listed in the copyright file.
139 .\"NODE "BUGS"
140 .SH "BUGS"
141 If you want to report a problem with the program, please create bugreport
142 at https://github.com/elfmz/far2l/issues.
144 Provide a detailed description of the bug, the version of the program
145 you are running.
146 If the program crashes, we would appreciate a stack trace.