about summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorhut <hut@lavabit.com>2011-10-05 19:34:46 +0200
committerhut <hut@lavabit.com>2011-10-05 19:34:46 +0200
commit9fc77ba1632b09123816b973e0d48a958a0d4c57 (patch)
tree182d86fdcae96aab5c4f9b57697d52ee6eab09d9 /doc
parentb0b3af33ec233f4f1d30c4e89da6668f98960ad8 (diff)
downloadranger-9fc77ba1632b09123816b973e0d48a958a0d4c57.tar.gz
manpage: update
Diffstat (limited to 'doc')
-rw-r--r--doc/ranger.131
-rw-r--r--doc/ranger.pod35
2 files changed, 34 insertions, 32 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1
index a0ca93bd..de50f621 100644
--- a/doc/ranger.1
+++ b/doc/ranger.1
@@ -133,23 +133,18 @@
 ranger \- visual file manager
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
-\&\fBranger\fR [\fIoptions\fR] [\fIpath/filename\fR]
+\&\fBranger\fR [\fB\-\-help\fR] [\fB\-\-version\fR] [\fB\-\-debug\fR] [\fB\-\-clean\fR]
+[\fB\-\-list\-unused\-keys\fR] [\fB\-\-fail\-unless\-cd\fR] [\fB\-\-choosedir\fR=\fItargetfile\fR]
+[\fB\-\-choosefile\fR=\fItargetfile\fR] [\fB\-\-copy\-config\fR=\fIfile\fR] [\fB\-\-mode\fR=\fImode\fR]
+[\fB\-\-flags\fR=\fIflags\fR] [\fIpath/filename\fR]
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
-Ranger is a file manager with an ncurses front-end written in Python.
-.PP
-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
-key bindings are similar to those of other console programs like \fBvim\fR,
-\&\fBmutt\fR or \fBncmpcpp\fR so the usage will be intuitive and efficient.
+ranger is a file manager with \s-1VI\s0 key bindings.  It provides a minimalistic yet
+nice curses interface with a view on the directory hierarchy.  The secondary
+task of ranger is to psychically guess which program you want to use for
+opening particular files.
 .SH "OPTIONS"
 .IX Header "OPTIONS"
-.IP "\fB\-\-verison\fR" 14
-.IX Item "--verison"
-Print the version and exit.
-.IP "\fB\-h\fR, \fB\-\-help\fR" 14
-.IX Item "-h, --help"
-Print a list of options and exit.
 .IP "\fB\-d\fR, \fB\-\-debug\fR" 14
 .IX Item "-d, --debug"
 Activate the debug mode: Whenever an error occurs, ranger will exit and print a
@@ -179,7 +174,7 @@ directory.  Existing ones will not be overwritten.  Possible values: \fIall\fR,
 List common keys which are not bound to any action in the \*(L"browser\*(R" context.
 This list is not complete, you can bind any key that is supported by curses:
 use the key code returned by \f(CW\*(C`getch()\*(C'\fR.
-.IP "\fB\-\-fail\-unless\-c\fRd" 14
+.IP "\fB\-\-fail\-unless\-cd\fR" 14
 .IX Item "--fail-unless-cd"
 Return the exit code 1 if ranger is used to run a file instead of used for file
 browsing. (For example, \*(L"ranger \-\-fail\-unless\-cd test.txt\*(R" returns 1.)
@@ -192,6 +187,12 @@ the execution of this file type is explicitly handled in the configuration.
 When a filename is supplied, run it with the given \fIflags\fR to modify
 behavior.  The execution of this file type is explicitly handled in the
 configuration.
+.IP "\fB\-\-version\fR" 14
+.IX Item "--version"
+Print the version and exit.
+.IP "\fB\-h\fR, \fB\-\-help\fR" 14
+.IX Item "-h, --help"
+Print a list of options and exit.
 .SH "CONCEPTS"
 .IX Header "CONCEPTS"
 .SS "\s-1TAGS\s0"
@@ -267,7 +268,7 @@ Bookmarks are selectable when tabbing in the :cd command.
 Note: The bookmarks ' (Apostrophe) and ` (Backtick) are the same.
 .SS "\s-1FLAGS\s0"
 .IX Subsection "FLAGS"
-Flags give you a way to modify the behaviour of the spawned process.  They are
+Flags give you a way to modify the behavior of the spawned process.  They are
 used in the commands :open_with (key \*(L"r\*(R") and :shell (key \*(L"!\*(R").
 .PP
 .Vb 5
diff --git a/doc/ranger.pod b/doc/ranger.pod
index dd9c89bc..eaadcf5b 100644
--- a/doc/ranger.pod
+++ b/doc/ranger.pod
@@ -7,19 +7,20 @@ ranger - visual file manager
 
 =head1 SYNOPSIS
 
-B<ranger> [I<options>] [I<path/filename>]
+B<ranger> [B<--help>] [B<--version>] [B<--debug>] [B<--clean>]
+[B<--list-unused-keys>] [B<--fail-unless-cd>] [B<--choosedir>=I<targetfile>]
+[B<--choosefile>=I<targetfile>] [B<--copy-config>=I<file>] [B<--mode>=I<mode>]
+[B<--flags>=I<flags>] [I<path/filename>]
 
 
 
 
 =head1 DESCRIPTION
 
-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
-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.
+ranger is a file manager with VI key bindings.  It provides a minimalistic yet
+nice curses interface with a view on the directory hierarchy.  The secondary
+task of ranger is to psychically guess which program you want to use for
+opening particular files.
 
 
 
@@ -28,14 +29,6 @@ B<mutt> or B<ncmpcpp> so the usage will be intuitive and efficient.
 
 =over 14
 
-=item B<--verison>
-
-Print the version and exit.
-
-=item B<-h>, B<--help>
-
-Print a list of options and exit.
-
 =item B<-d>, B<--debug>
 
 Activate the debug mode: Whenever an error occurs, ranger will exit and print a
@@ -71,7 +64,7 @@ List common keys which are not bound to any action in the "browser" context.
 This list is not complete, you can bind any key that is supported by curses:
 use the key code returned by C<getch()>.
 
-=item B<--fail-unless-c>d
+=item B<--fail-unless-cd>
 
 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.)
@@ -87,6 +80,14 @@ 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.
 
+=item B<--version>
+
+Print the version and exit.
+
+=item B<-h>, B<--help>
+
+Print a list of options and exit.
+
 =back
 
 
@@ -168,7 +169,7 @@ Note: The bookmarks ' (Apostrophe) and ` (Backtick) are the same.
 
 =head2 FLAGS
 
-Flags give you a way to modify the behaviour of the spawned process.  They are
+Flags give you a way to modify the behavior of the spawned process.  They are
 used in the commands :open_with (key "r") and :shell (key "!").
 
  s   Silent mode.  Output will be discarded.