Merge branch 'doc-copymap'

1 files changed, 33 insertions, 36 deletions

diff --git a/doc/ranger.1 b/doc/ranger.1
index eba636b3..36a0f784 100644
--- a/doc/ranger.1
+++ b/doc/ranger.1
@@ -133,12 +133,11 @@
 .\" ========================================================================
 .\"
 .IX Title "RANGER 1"
-.TH RANGER 1 "ranger-1.9.2" "2019-09-17" "ranger manual"
+.TH RANGER 1 "ranger-1.9.2" "2019-09-23" "ranger manual"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
 .nh
-.SH "NAME"
 ranger \- visual file manager
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
@@ -1251,33 +1250,27 @@ example, \fB+ar\fR allows reading for everyone, \-ow forbids others to write and
 777= allows everything.
 .Sp
 See also: man 1 chmod
-.IP "cmap \fIkey\fR \fIcommand\fR" 2
-.IX Item "cmap key command"
-Binds keys for the console. Works like the \f(CW\*(C`map\*(C'\fR command.
 .IP "console [\-p\fIN\fR] \fIcommand\fR" 2
 .IX Item "console [-pN] command"
 Opens the console with the command already typed in.  The cursor is placed at
 \&\fIN\fR.
+.IP "copymap  \fIkey\fR \fInewkey\fR [\fInewkey2\fR ...]" 2
+.IX Item "copymap key newkey [newkey2 ...]"
+.PD 0
 .IP "copycmap \fIkey\fR \fInewkey\fR [\fInewkey2\fR ...]" 2
 .IX Item "copycmap key newkey [newkey2 ...]"
-See \f(CW\*(C`copymap\*(C'\fR
-.IP "copymap \fIkey\fR \fInewkey\fR [\fInewkey2\fR ...]" 2
-.IX Item "copymap key newkey [newkey2 ...]"
-Copies the keybinding \fIkey\fR to \fInewkey\fR in the \*(L"browser\*(R" context.  This is a
-deep copy, so if you change the new binding (or parts of it) later, the old one
-is not modified.
-.Sp
-To copy key bindings of the console, taskview, or pager use \*(L"copycmap\*(R",
-\&\*(L"copytmap\*(R" or \*(L"copypmap\*(R".
 .IP "copypmap \fIkey\fR \fInewkey\fR [\fInewkey2\fR ...]" 2
 .IX Item "copypmap key newkey [newkey2 ...]"
-See \f(CW\*(C`copymap\*(C'\fR
 .IP "copytmap \fIkey\fR \fInewkey\fR [\fInewkey2\fR ...]" 2
 .IX Item "copytmap key newkey [newkey2 ...]"
-See \f(CW\*(C`copymap\*(C'\fR
-.IP "cunmap [\fIkeys...\fR]" 2
-.IX Item "cunmap [keys...]"
-Removes key mappings of the console. Works like the \f(CW\*(C`unmap\*(C'\fR command.
+.PD
+Copies the keybinding \fIkey\fR to \fInewkey\fR in the \*(L"browser\*(R" context.  This is a
+deep copy, so if you change the new binding (or parts of it) later, the old one
+is not modified. For example, \fIcopymap j down\fR will make the key sequence
+\&\*(L"down\*(R" move the cursor down one item.
+.Sp
+To copy key bindings of the console, pager or taskview use \*(L"copycmap\*(R",
+\&\*(L"copypmap\*(R" or \*(L"copytmap\*(R" respectively.
 .IP "default_linemode [\fIpath=regexp\fR | \fItag=tags\fR] \fIlinemodename\fR" 2
 .IX Item "default_linemode [path=regexp | tag=tags] linemodename"
 Sets the default linemode.  See \fIlinemode\fR command.
@@ -1383,16 +1376,24 @@ See the \fIranger.core.linemode\fR module for some examples.
 .IX Item "load_copy_buffer"
 Load the copy buffer from \fI~/.config/ranger/copy_buffer\fR.  This can be used to
 pass the list of copied files to another ranger instance.
-.IP "map \fIkey\fR \fIcommand\fR" 2
+.IP "map  \fIkey\fR \fIcommand\fR" 2
 .IX Item "map key command"
+.PD 0
+.IP "cmap \fIkey\fR \fIcommand\fR" 2
+.IX Item "cmap key command"
+.IP "pmap \fIkey\fR \fIcommand\fR" 2
+.IX Item "pmap key command"
+.IP "tmap \fIkey\fR \fIcommand\fR" 2
+.IX Item "tmap key command"
+.PD
 Assign the key combination to the given command.  Whenever you type the
 key/keys, the command will be executed.  Additionally, if you use a quantifier
 when typing the key, like 5j, it will be passed to the command as the attribute
 \&\*(L"self.quantifier\*(R".
 .Sp
 The keys you bind with this command are accessible in the file browser only,
-not in the console, task view or pager.  To bind keys there, use the commands
-\&\*(L"cmap\*(R", \*(L"tmap\*(R" or \*(L"pmap\*(R".
+not in the console, pager or taskview.  To bind keys there, use the commands
+\&\*(L"cmap\*(R", \*(L"pmap\*(R" or \*(L"tmap\*(R".
 .IP "mark \fIpattern\fR" 2
 .IX Item "mark pattern"
 Mark all files matching the regular expression pattern.
@@ -1426,16 +1427,10 @@ of applications is generated by the external file opener \*(L"rifle\*(R" and can
 displayed when pressing \*(L"r\*(R" in ranger.
 .Sp
 Note that if you specify an application, the mode is ignored.
-.IP "pmap \fIkey\fR \fIcommand\fR" 2
-.IX Item "pmap key command"
-Binds keys for the pager. Works like the \f(CW\*(C`map\*(C'\fR command.
 .IP "prompt_metadata [\fIkeys ...\fR]" 2
 .IX Item "prompt_metadata [keys ...]"
 Prompt the user to input metadata with the \f(CW\*(C`meta\*(C'\fR command for multiple keys in
 a row.
-.IP "punmap [\fIkeys ...\fR]" 2
-.IX Item "punmap [keys ...]"
-Removes key mappings of the pager. Works like the \f(CW\*(C`unmap\*(C'\fR command.
 .IP "quit" 2
 .IX Item "quit"
 Closes the current tab, if there's only one tab. Otherwise quits if there are no tasks in progress.
@@ -1562,9 +1557,6 @@ Scroll the file preview by \fIvalue\fR lines.
 .IP "terminal" 2
 .IX Item "terminal"
 Spawns the \fIx\-terminal-emulator\fR starting in the current directory.
-.IP "tmap \fIkey\fR \fIcommand\fR" 2
-.IX Item "tmap key command"
-Binds keys for the taskview. Works like the \f(CW\*(C`map\*(C'\fR command.
 .IP "touch \fIfilename\fR" 2
 .IX Item "touch filename"
 Creates an empty file with the name \fIfilename\fR, unless it already exists.
@@ -1577,13 +1569,18 @@ is automatically reopened, allowing for fast travel.
 To close the console, press \s-1ESC\s0 or execute a file.
 .Sp
 This command is based on the \fIscout\fR command and supports all of its options.
-.IP "tunmap [\fIkeys ...\fR]" 2
-.IX Item "tunmap [keys ...]"
-Removes key mappings of the taskview. Works like the \f(CW\*(C`unmap\*(C'\fR command.
-.IP "unmap [\fIkeys\fR ...]" 2
+.IP "unmap  [\fIkeys\fR ...]" 2
 .IX Item "unmap [keys ...]"
+.PD 0
+.IP "cunmap [\fIkeys\fR ...]" 2
+.IX Item "cunmap [keys ...]"
+.IP "punmap [\fIkeys\fR ...]" 2
+.IX Item "punmap [keys ...]"
+.IP "tunmap [\fIkeys\fR ...]" 2
+.IX Item "tunmap [keys ...]"
+.PD
 Removes the given key mappings in the \*(L"browser\*(R" context.  To unmap key bindings
-in the console, taskview, or pager use \*(L"cunmap\*(R", \*(L"tunmap\*(R" or \*(L"punmap\*(R".
+in the console, pager, or taskview use \*(L"cunmap\*(R", \*(L"punmap\*(R" or \*(L"tunmap\*(R".
 .IP "unmark \fIpattern\fR" 2
 .IX Item "unmark pattern"
 Unmark all files matching a regular expression pattern.