about summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authortoonn <toonn@toonn.io>2018-04-03 14:10:35 +0200
committertoonn <toonn@toonn.io>2018-04-03 14:10:35 +0200
commit3c430ba0f1b3fe2e17225788866f37bcd1f85c3b (patch)
treeab0a86380af96f2d4702e03c71be0233605a9010 /doc
parent98a176469faa51a678f5ac703e0e11c251425fdd (diff)
downloadranger-3c430ba0f1b3fe2e17225788866f37bcd1f85c3b.tar.gz
Document change in :cd behavior
Added a sentence about the file selecting behavior of `:cd` to the
docstring and the manpage.
Added missing `=back` to POSITIONAL ARGUMENTS section in the manpage.
Diffstat (limited to 'doc')
-rw-r--r--doc/ranger.112
-rw-r--r--doc/ranger.pod10
2 files changed, 12 insertions, 10 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1
index 7f307490..bd6116d1 100644
--- a/doc/ranger.1
+++ b/doc/ranger.1
@@ -129,7 +129,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RANGER 1"
-.TH RANGER 1 "ranger-1.9.1" "2018-03-31" "ranger manual"
+.TH RANGER 1 "ranger-1.9.1" "2018-04-03" "ranger manual"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -996,7 +996,7 @@ ranger.  For your convenience, this is a list of the \*(L"public\*(R" commands i
 .Vb 10
 \& alias [newcommand] [oldcommand]
 \& bulkrename
-\& cd [directory]
+\& cd [path]
 \& chain command1[; command2[; command3...]]
 \& chmod octal_number
 \& cmap key command
@@ -1072,10 +1072,10 @@ renaming according to the changes you did in the file.
 .Sp
 This shell script is opened in an editor for you to review.  After you close
 it, it will be executed.
-.IP "cd [\fIdirectory\fR]" 2
-.IX Item "cd [directory]"
-The cd command changes the directory.  The command \f(CW\*(C`:cd \-\*(C'\fR is equivalent to
-typing ``.
+.IP "cd [\fIpath\fR]" 2
+.IX Item "cd [path]"
+The cd command changes the directory.  If path is a file, selects that file.
+The command \f(CW\*(C`:cd \-\*(C'\fR is equivalent to typing ``.
 .IP "chain \fIcommand1\fR[; \fIcommand2\fR[; \fIcommand3\fR...]]" 2
 .IX Item "chain command1[; command2[; command3...]]"
 Combines multiple commands into one, separated by semicolons.
diff --git a/doc/ranger.pod b/doc/ranger.pod
index 470eaa7e..4b0e90b1 100644
--- a/doc/ranger.pod
+++ b/doc/ranger.pod
@@ -62,6 +62,8 @@ The section I<LINKS> of this man page contains further resources.
 Each path will be opened in a tab and if the path is a file it will be selected.
 Omitting this is equivalent to providing the current directory.
 
+=back
+
 
 
 
@@ -1033,7 +1035,7 @@ ranger.  For your convenience, this is a list of the "public" commands including
 
  alias [newcommand] [oldcommand]
  bulkrename
- cd [directory]
+ cd [path]
  chain command1[; command2[; command3...]]
  chmod octal_number
  cmap key command
@@ -1113,10 +1115,10 @@ renaming according to the changes you did in the file.
 This shell script is opened in an editor for you to review.  After you close
 it, it will be executed.
 
-=item cd [I<directory>]
+=item cd [I<path>]
 
-The cd command changes the directory.  The command C<:cd -> is equivalent to
-typing ``.
+The cd command changes the directory.  If path is a file, selects that file.
+The command C<:cd -> is equivalent to typing ``.
 
 =item chain I<command1>[; I<command2>[; I<command3>...]]