From 004badd136850ec48533eb3591b841d4ee38e156 Mon Sep 17 00:00:00 2001 From: nfnty Date: Thu, 16 Feb 2017 05:33:50 +0100 Subject: doc: man: Clarify config sourcing --- doc/ranger.1 | 23 ++++++++++------------- doc/ranger.pod | 21 +++++++++------------ doc/rifle.1 | 2 +- 3 files changed, 20 insertions(+), 26 deletions(-) diff --git a/doc/ranger.1 b/doc/ranger.1 index 153e7b5e..36e82319 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.9.0b4" "2017-02-10" "ranger manual" +.TH RANGER 1 "ranger-1.9.0b4" "2017-02-16" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -1329,18 +1329,15 @@ out the tag argument, all tagged files are unmarked. ranger reads several configuration files which are located in \&\fI\f(CI$HOME\fI/.config/ranger\fR or \fI\f(CI$XDG_CONFIG_HOME\fI/ranger\fR if \f(CW$XDG_CONFIG_HOME\fR is defined. You can use the \-\-copy\-config option to obtain the default -configuration files. Each of the files contains further documentation. -.PP -You don't need to copy the whole file though, most configuration files are -overlaid on top of the defaults (\fIcommands.py\fR, \fIrc.conf\fR) or can be -sub-classed (\fIcolorschemes\fR). -.PP -That being said, the user configuration files \fIrc.conf\fR and \fIcommands.py\fR are -loaded only after ranger loads the default configuration files. This may lead -to some confusing situations, for example when a key is being bound despite the -corresponding line being removed from the user's copy of the configuration -file. This behavior may be disabled with an environment variable (see also: -\&\fB\s-1ENVIRONMENT\s0\fR). +configuration files. The files contain further documentation. +.PP +\&\fIrc.conf\fR, \fIcommands.py\fR and \fIcolorschemes\fR do not need to be copied fully +as they will only be adding to the default configuration files except if explicitly +overridden. This may lead to some confusing situations, for example when a key is +being bound despite the corresponding line being removed from the user's copy of +the configuration file. This behavior may be disabled with an environment +variable (see also: \fB\s-1ENVIRONMENT\s0\fR). Note: All other configuration files only +read from one source; i.e. default \s-1OR\s0 user, not both. .PP When starting ranger with the \fB\-\-clean\fR option, it will not access or create any of these files. diff --git a/doc/ranger.pod b/doc/ranger.pod index 8b02ee63..bb30fab3 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -1406,18 +1406,15 @@ out the tag argument, all tagged files are unmarked. ranger reads several configuration files which are located in F<$HOME/.config/ranger> or F<$XDG_CONFIG_HOME/ranger> if $XDG_CONFIG_HOME is defined. You can use the --copy-config option to obtain the default -configuration files. Each of the files contains further documentation. - -You don't need to copy the whole file though, most configuration files are -overlaid on top of the defaults (F, F) or can be -sub-classed (F). - -That being said, the user configuration files F and F are -loaded only after ranger loads the default configuration files. This may lead -to some confusing situations, for example when a key is being bound despite the -corresponding line being removed from the user's copy of the configuration -file. This behavior may be disabled with an environment variable (see also: -B). +configuration files. The files contain further documentation. + +F, F and F do not need to be copied fully +as they will only be adding to the default configuration files except if explicitly +overridden. This may lead to some confusing situations, for example when a key is +being bound despite the corresponding line being removed from the user's copy of +the configuration file. This behavior may be disabled with an environment +variable (see also: B). Note: All other configuration files only +read from one source; i.e. default OR user, not both. When starting ranger with the B<--clean> option, it will not access or create any of these files. diff --git a/doc/rifle.1 b/doc/rifle.1 index c243a8da..3f9fa926 100644 --- a/doc/rifle.1 +++ b/doc/rifle.1 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "RIFLE 1" -.TH RIFLE 1 "rifle-1.9.0b4" "2017-02-10" "rifle manual" +.TH RIFLE 1 "rifle-1.9.0b4" "2017-02-16" "rifle manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l -- cgit 1.4.1-2-gfad0