summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorhut <hut@lepus.uberspace.de>2015-04-10 00:12:46 +0200
committerhut <hut@lepus.uberspace.de>2015-04-10 00:12:46 +0200
commit3160c4a7ebedf85c068baa4bae6747cafc123d4b (patch)
tree699d118413b5fb41a599bc5dda4db589076f1476
parentfabab01bda21868be0d47e053c65b48a9102b820 (diff)
downloadranger-3160c4a7ebedf85c068baa4bae6747cafc123d4b.tar.gz
ranger.1: added documentation for %rangerdir and %space macros
-rw-r--r--doc/ranger.110
-rw-r--r--doc/ranger.pod8
-rw-r--r--doc/rifle.12
3 files changed, 18 insertions, 2 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1
index 8a1e00c1..295314f4 100644
--- a/doc/ranger.1
+++ b/doc/ranger.1
@@ -133,7 +133,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RANGER 1"
-.TH RANGER 1 "ranger-1.6.1" "30/03/15" "ranger manual"
+.TH RANGER 1 "ranger-1.6.1" "04/10/2015" "ranger manual"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -321,6 +321,14 @@ Macros for file paths are generally shell-escaped so they can be used in the
 Additionally, if you create a key binding that uses <any>, a special statement
 which accepts any key, then the macro \f(CW%any\fR (or \f(CW%any0\fR, \f(CW%any1\fR, \f(CW%any2\fR, ...) can be
 used in the command to get the key that was pressed.
+.PP
+The macro \f(CW%rangerdir\fR expands to the directory of ranger's python library, you
+can use it for something like this command:
+  alias show_commands shell less \f(CW%rangerdir\fR/config/commands.py
+.PP
+The macro \f(CW%space\fR expands to a space character. You can use it to add spaces to
+the end of a command when needed, while preventing editors to strip spaces off
+the end of the line automatically.
 .SS "\s-1BOOKMARKS\s0"
 .IX Subsection "BOOKMARKS"
 Type \fBm<key>\fR to bookmark the current directory. You can re-enter this
diff --git a/doc/ranger.pod b/doc/ranger.pod
index a6204403..ad75f35a 100644
--- a/doc/ranger.pod
+++ b/doc/ranger.pod
@@ -218,6 +218,14 @@ Additionally, if you create a key binding that uses <any>, a special statement
 which accepts any key, then the macro %any (or %any0, %any1, %any2, ...) can be
 used in the command to get the key that was pressed.
 
+The macro %rangerdir expands to the directory of ranger's python library, you
+can use it for something like this command:
+  alias show_commands shell less %rangerdir/config/commands.py
+
+The macro %space expands to a space character. You can use it to add spaces to
+the end of a command when needed, while preventing editors to strip spaces off
+the end of the line automatically.
+
 =head2 BOOKMARKS
 
 Type B<m<keyE<gt>> to bookmark the current directory. You can re-enter this
diff --git a/doc/rifle.1 b/doc/rifle.1
index 999d56d6..21c53276 100644
--- a/doc/rifle.1
+++ b/doc/rifle.1
@@ -133,7 +133,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RIFLE 1"
-.TH RIFLE 1 "rifle-1.6.1" "08/26/2014" "rifle manual"
+.TH RIFLE 1 "rifle-1.6.1" "04/10/2015" "rifle manual"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l