diff options
Diffstat (limited to 'doc/ranger.pod')
-rw-r--r-- | doc/ranger.pod | 519 |
1 files changed, 461 insertions, 58 deletions
diff --git a/doc/ranger.pod b/doc/ranger.pod index db3210b2..4bd12889 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -14,12 +14,12 @@ B<ranger> [I<options>] [I<path/filename>] =head1 DESCRIPTION -Ranger is a file manager with an ncurses frontend written in Python. +Ranger is a file manager with an ncurses front-end written in Python. It is designed to give you a broader overview of the file system by displaying -previews and backviews, dividing the screen into several columns. -The keybindings are similar to those of other console programs like -B<vim>, B<mutt> or B<ncmpcpp> so the usage will be intuitive and efficient. +previews and backviews, dividing the screen into several columns. The +key bindings are similar to those of other console programs like B<vim>, +B<mutt> or B<ncmpcpp> so the usage will be intuitive and efficient. @@ -30,52 +30,56 @@ B<vim>, B<mutt> or B<ncmpcpp> so the usage will be intuitive and efficient. =item B<--verison> -print the version and exit +Print the version and exit. =item B<-h>, B<--help> -print a list of options and exit +Print a list of options and exit. =item B<-d>, B<--debug> -activate the debug mode: Whenever an erroroccurs, 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 try to keep running. +Activate the debug mode: Whenever an error occurs, ranger will exit and print a +full traceback. The default behavior is to merely print the name of the +exception in the statusbar/log and try to keep running. =item B<-c>, B<--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. +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. =item B<--choosefile>=I<targetfile> -Allows you to pick a file with ranger. This changes the behaviour so that when you open a file, ranger will exit and write the name of that file into I<targetfile>. +Allows you to pick a file with ranger. This changes the behavior so that when +you open a file, ranger will exit and write the name of that file into +I<targetfile>. =item B<--choosedir>=I<targetfile> -Allows you to pick a directory with ranger. When you exit ranger, it will write the last visited directory into I<targetfile>. +Allows you to pick a directory with ranger. When you exit ranger, it will +write the last visited directory into I<targetfile>. =item B<--copy-config>=I<file> Create copies of the default configuration files in your local configuration -directory. Existing ones will not be overwritten. Possible values: -I<all>, I<apps>, I<commands>, I<keys>, I<options>, I<scope>. +directory. Existing ones will not be overwritten. Possible values: I<all>, +I<apps>, I<commands>, I<keys>, I<options>, I<scope>. =item B<--fail-unless-c>d -Return the exit code 1 if ranger is used to run a file instead of used for -file browsing. (For example, "ranger --fail-unless-cd test.txt" returns 1.) +Return the exit code 1 if ranger is used to run a file instead of used for file +browsing. (For example, "ranger --fail-unless-cd test.txt" returns 1.) =item B<-m> I<n>, B<--mode>=I<n> When a filename is supplied, run it in mode I<n>. This has no effect unless -the execution of this filetype is explicitly handled in the configuration. +the execution of this file type is explicitly handled in the configuration. =item B<-f> I<flags>, B<--flags>=I<flags> -When a filename is supplied, run it with the given I<flags> to modify behaviour. -the execution of this filetype is explicitly handled in the configuration. +When a filename is supplied, run it with the given I<flags> to modify +behavior. The execution of this file type is explicitly handled in the +configuration. =back @@ -84,6 +88,14 @@ the execution of this filetype is explicitly handled in the configuration. =head1 KEY BINDINGS +Many key bindings take an additional numeric argument. Type I<5j> to move +down 5 lines, I<2l> to open a file in mode 2, I<10<SpaceE<gt>> to mark 10 files +or I<3?> to read the third chapter of the documentation. + +Key bindings can be changed. De |