diff options
| -rw-r--r-- | doc/ranger.1 | 15 | ||||
| -rw-r--r-- | doc/ranger.pod | 14 |
2 files changed, 26 insertions, 3 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1 index 59bf529c..41463478 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.6.1" "02/06/2015" "ranger manual" +.TH RANGER 1 "ranger-1.6.1" "02/18/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 @@ -188,11 +188,18 @@ Change the configuration directory of ranger from ~/.config/ranger to \*(L"dir\* .IX Item "--copy-config=file" Create copies of the default configuration files in your local configuration directory. Existing ones will not be overwritten. Possible values: \fIall\fR, -\&\fIcommands\fR, \fIrc\fR, \fIrifle\fR, \fIscope\fR. +\&\fIcommands\fR, \fIcommands_full\fR, \fIrc\fR, \fIrifle\fR, \fIscope\fR. .Sp Note: You may want to disable loading of the global configuration files by exporting \fIRANGER_LOAD_DEFAULT_RC=FALSE\fR in your environment. See also: \&\fB\s-1FILES\s0\fR, \fB\s-1ENVIRONMENT\s0\fR +.Sp +\&\-\-copy\-config=\fBcommands\fR will copy only a small sample configuration file with +a thoroughly commented example. It is recommended to keep this file tidy to +avoid getting defunct commands on ranger upgrades. The full default +commands.py can be copied with \-\-copy\-config=\fBcommands_full\fR, but that file +will be ignored by ranger and serves only as a reference for making your own +commands. .IP "\fB\-\-choosefile\fR=\fItargetfile\fR" 14 .IX Item "--choosefile=targetfile" Allows you to pick a file with ranger. This changes the behavior so that when @@ -1193,6 +1200,10 @@ and settings are defined here. .IX Item "commands.py" A python module that defines commands which can be used in ranger's console by typing \*(L":\*(R" or in the rc.conf file. +.IP "commands_full.py" 10 +.IX Item "commands_full.py" +This file is copied by \-\-copy\-config=commands_full and serves as a reference +for custom commands. It is entirely ignored by ranger. .IP "rifle.conf" 10 .IX Item "rifle.conf" This is the configuration file for the built-in file launcher called \*(L"rifle\*(R". diff --git a/doc/ranger.pod b/doc/ranger.pod index 177cd0f5..6888ee70 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -70,12 +70,19 @@ Change the configuration directory of ranger from ~/.config/ranger to "dir". Create copies of the default configuration files in your local configuration directory. Existing ones will not be overwritten. Possible values: I<all>, -I<commands>, I<rc>, I<rifle>, I<scope>. +I<commands>, I<commands_full>, I<rc>, I<rifle>, I<scope>. Note: You may want to disable loading of the global configuration files by exporting I<RANGER_LOAD_DEFAULT_RC=FALSE> in your environment. See also: B<FILES>, B<ENVIRONMENT> +--copy-config=B<commands> will copy only a small sample configuration file with +a thoroughly commented example. It is recommended to keep this file tidy to +avoid getting defunct commands on ranger upgrades. The full default +commands.py can be copied with --copy-config=B<commands_full>, but that file +will be ignored by ranger and serves only as a reference for making your own +commands. + =item B<--choosefile>=I<targetfile> Allows you to pick a file with ranger. This changes the behavior so that when @@ -1266,6 +1273,11 @@ and settings are defined here. A python module that defines commands which can be used in ranger's console by typing ":" or in the rc.conf file. +=item commands_full.py + +This file is copied by --copy-config=commands_full and serves as a reference +for custom commands. It is entirely ignored by ranger. + =item rifle.conf This is the configuration file for the built-in file launcher called "rifle". |