summary refs log tree commit diff stats
path: root/doc/ranger.1
blob: 29958cb4679f1a7fb003771a9e1c472673940c23 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd
.TH RANGER 1 ranger-1.0.4
.SH NAME
ranger - file manager with a high range overview
.\"-----------------------------------------
.SH SYNOPSIS
.B ranger
.R [OPTIONS] [FILE]
.\"-----------------------------------------
.SH DESCRIPTION
ranger is a file manager with an ncurses frontend that is designed for
smooth interaction with the human visual interface and compatibility with
the muscle memory of individuals with long term exposure to common CLI tools
of unix-like operating systems.
.\"-----------------------------------------
.SH OPTIONS
.TP
--version
Print the version and exit.
.TP
-h, --help
Print a list of options and exit.
.TP
-d, --debug
Activate the debug mode:  Whenever an error occurs, ranger will exit and
print a full backtrace.  The default behaviour is to merely print the
name of the exception in the statusbar/log and to try to keep running.
.TP
-c, --clean
Activate the clean mode:  Ranger will not access or create any configuration
files nor will it leave any traces on your system.  This is useful when
your configuration is broken, when you want to avoid clutter, etc.
.TP
-r \fIdir\fR, --confdir=\fIdir\fR
Define a different configuration directory.  The default is $HOME/.ranger.
.TP
-m \fIn\fR, --mode=\fIn\fR
When a filename is supplied, make it run in mode \fIn\fR. Check the
documentation for more information on modes.
.TP
-f \fIflags\fR, --flags=\fIflags\fR
When a filename is supplied, make it run with the flags \fIflags\fR. Check the
documentation for more information on flags.
.\"-----------------------------------------
.SH USAGE
.\"-----------------------------------------
.SS Keybindings
Many keybindings take an additional numeric argument.  Type \fI5j\fR to move
down 5 lines, \fI10<Space>\fR to mark 10 files or \fI3?\fR to read the
third chapter of the documentation.
.TP
h, j, k, l
Move left, down, up, right
.TP
^D or J, ^U or K
Move a half page down, up
.TP
H, L
Move back and forward in the history
.TP
gg
Move to the top
.TP
G
Move to the bottom
.TP
yy
Yank the selection.  (mark the files as copied)
.TP
dd
Cut the selection
.TP
pp
Paste the copied/cut files.  By default, this will not overwrite existing
files.  To overwrite them, use \fBpo\fR.
.TP
m\fIX\fR
Create a bookmark with the name \fIX\fR
.TP
`\fIX\fR
Move to the bookmark with the name \fIX\fR
.TP
n, N
Find the next file, the previous file.  You can define what to look for
by typing c\fIX\fR.  If nothing is specified, pressing n will get you to
the newest file in the directory.
.TP
o\fIX\fR
Change the sort method (like in mutt)
.TP
z\fIX\fR
Change settings
.TP
f
Quickly navigate by entering a part of the filename
.TP
Space
Mark a file
.TP
v, V
Toggle the mark-status of all files, unmark all files
.TP
/
Open the search console
.TP
:
Open the command console
.TP
?
Opens the help screen with more keybindings and documentation
.\"-----------------------------------------
.SS Mouse Usage
.TP
Left Mouse Button
Click on something and you'll move there.
To run a file, "enter" it, like a directory, by clicking on the preview.
.TP
Right Mouse Button
Enter a directory
.TP
Scroll Wheel
Scroll
.\"-----------------------------------------
.SS Commands
.TP
:delete
Destroy all files in the selection with a roundhouse kick.  Ranger will
ask for a confirmation if you attempt to delete multiple (marked) files or
non-empty directories.
.TP
:rename \fInewname\fR
Rename the current file.  Also try the keybinding A for appending something
to a file name.
.TP
:quit
Quit ranger.  The current directory will be bookmarked as ' so you can
re-enter it by typing `` or '' the next time you start ranger.
.\"-----------------------------------------
.SH TIPS
.SS
Change the directory after exit
A script like this in your bashrc would make you change the directory
of your parent shell after exiting ranger:
.nf

ranger() {
    $(which ranger) $@ &&
    cd "$(grep \\^\\' ~/.ranger/bookmarks | cut -b3-)"
}
.\"-----------------------------------------
.SH CONFIGURATION
The files in
.B ranger/defaults/
can be copied into your configuration directory (by default, this is
$HOME/.ranger) and customized according to your wishes.  
.B ranger/defaults/options.py
doesn't have to be copied completely though: Just define those settings
you want to change and they will override the default values.
Colorschemes can be placed in $HOME/.ranger/colorschemes.
.P
All configuration is done in Python.
Each configuration file should contain sufficient documentation.
.\"-----------------------------------------
.SH COPYRIGHT
Copyright \(co
2009, 2010
Roman Zimbelmann
.P
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

There is NO warranty;
not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.\"-----------------------------------------
.SH SEE ALSO
The project page:
.RB < http://savannah.nongnu.org/projects/ranger >
.P
The mailing list:
.RB < http://savannah.nongnu.org/mail/?group=ranger >
.\"-----------------------------------------
.SH BUGS
Since Chuck Norris, the Texas Ranger, watches over this project, there ought
to be no bugs.  If you think otherwise, please report them here:
.P
.RB < http://savannah.nongnu.org/bugs/?group=ranger >
n>/* string, int, etc. */ char * value; /* user entered string data */ char * orig_value;/* the original value */ int size; /* width on the screen */ unsigned maxlength; /* max width of data */ int group; /* a group associated with the link * this is used for select's */ int num_value; /* value of the numerical fields */ int hrange; /* high numerical range */ int lrange; /* low numerical range */ OptionType * select_list; /* array of option choices */ char * submit_action; /* form's action */ int submit_method; /* form's method */ char * submit_enctype; /* form's entype */ char * submit_title; /* form's title */ BOOL no_cache; /* Always resubmit? */ char * cp_submit_value; /* option value to submit */ char * orig_submit_value; /* original submit value */ int size_l; /* The length of the option list */ int disabled; /* If YES, can't change values */ int name_cs; int value_cs; char * accept_cs; } FormInfo; /* * As structure for info associated with a form. * There is some redundancy here, this shouldn't waste too much memory * since the total number of forms (as opposed to form fields) per doc * is expected to be rather small. * More things which are per form rather than per field could be moved * here. - kw */ typedef struct _PerFormInfo { int number; /* form number, see GridText.c */ /* except for the last two, the followign fields aren't actually used.. */ int disabled; /* If YES, can't change values */ struct _PerFormInfo * next; /* pointer to next form in doc */ int nfields; /* number of fields */ FormInfo * first_field; FormInfo * last_field; /* pointer to last field in form */ char * accept_cs; char * thisacceptcs; /* used during submit */ } PerFormInfo; #define HYPERTEXT_ANCHOR 1 #define INPUT_ANCHOR 2 /* forms mode input fields */ #define INTERNAL_LINK_ANCHOR 5 /* 1+4, can be used as bitflag... - kw */ #define F_TEXT_TYPE 1 #define F_PASSWORD_TYPE 2 #define F_CHECKBOX_TYPE 3 #define F_RADIO_TYPE 4 #define F_SUBMIT_TYPE 5 #define F_RESET_TYPE 6 #define F_OPTION_LIST_TYPE 7 #define F_HIDDEN_TYPE 8 #define F_TEXTAREA_TYPE 9 #define F_RANGE_TYPE 10 #define F_FILE_TYPE 11 #define F_TEXT_SUBMIT_TYPE 12 #define F_IMAGE_SUBMIT_TYPE 13 #define F_KEYGEN_TYPE 14 #define WWW_FORM_LINK_TYPE 1 #define WWW_LINK_TYPE 2 #define WWW_INTERN_LINK_TYPE 6 /* can be used as a bitflag... - kw */ #define LINK_LINE_FOUND 8 /* used in follow_link_number, others - kw */ #define LINK_DO_ARROWUP 16 /* returned by HTGetLinkOrFieldStart - kw */ /* #define different lynx modes */ #define NORMAL_LYNX_MODE 1 #define FORMS_LYNX_MODE 2 #define FIRST_ORDER 1 #define MIDDLE_ORDER 2 #define LAST_ORDER 3 /* in LYForms.c */ extern void show_formlink_statusline PARAMS((CONST FormInfo * form)); #endif /* HTFORMS_H */