summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorWojciech Siewierski <wojciech.siewierski@onet.pl>2015-02-04 21:04:47 +0100
committerWojciech Siewierski <wojciech.siewierski@onet.pl>2015-02-04 21:04:47 +0100
commit75c579355f16cc96026c6be79cb75613a22eb397 (patch)
tree73f43f43dccf383b66a1ba787514c9b87b6759cc /doc
parentba6efb9da0f58ca03bc28e7f66fdeb88b3de8a1c (diff)
downloadranger-75c579355f16cc96026c6be79cb75613a22eb397.tar.gz
doc/ranger.1: added some information about the config file loading process
Diffstat (limited to 'doc')
-rw-r--r--doc/ranger.112
-rw-r--r--doc/ranger.pod10
2 files changed, 21 insertions, 1 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1
index 4fef635d..a97ca1a5 100644
--- a/doc/ranger.1
+++ b/doc/ranger.1
@@ -133,7 +133,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RANGER 1"
-.TH RANGER 1 "ranger-1.6.1" "01/29/2015" "ranger manual"
+.TH RANGER 1 "ranger-1.6.1" "02/04/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
@@ -189,6 +189,10 @@ Change the configuration directory of ranger from ~/.config/ranger to \*(L"dir\*
 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.
+.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
 .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
@@ -1170,6 +1174,12 @@ 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 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).
+.PP
 When starting ranger with the \fB\-\-clean\fR option, it will not access or create
 any of these files.
 .SS "\s-1CONFIGURATION\s0"
diff --git a/doc/ranger.pod b/doc/ranger.pod
index e2311f3e..375b85a5 100644
--- a/doc/ranger.pod
+++ b/doc/ranger.pod
@@ -72,6 +72,10 @@ 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>.
 
+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>
+
 =item B<--choosefile>=I<targetfile>
 
 Allows you to pick a file with ranger.  This changes the behavior so that when
@@ -1238,6 +1242,12 @@ You don't need to copy the whole file though, most configuration files are
 overlaid on top of the defaults (F<commands.py>, F<rc.conf>) or can be
 sub-classed (F<colorschemes>).
 
+That being said, the user configuration files 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<ENVIRONMENT>).
+
 When starting ranger with the B<--clean> option, it will not access or create
 any of these files.
 
lt'>
db469acb ^
59391f2a ^
db469acb ^
59391f2a ^
ab26c894 ^
fa805850 ^







59391f2a ^
fa805850 ^





ef845524 ^



fa805850 ^




48d96636 ^
fa805850 ^





13235878 ^
3f30e4c6 ^
13235878 ^

3f30e4c6 ^
















































































fa805850 ^






















































611e9f2e ^
8d32a9aa ^




fa805850 ^

924ed08a ^
606c1ab4 ^
114641e2 ^
be19cb87 ^

114641e2 ^
985f7f79 ^

fee1bbd8 ^
d89af9bd ^


92ca7842 ^
d89af9bd ^
fee1bbd8 ^
d89af9bd ^
92ca7842 ^
d89af9bd ^
3cf03158 ^

d89af9bd ^
3cf03158 ^
d89af9bd ^
3cf03158 ^
fa805850 ^
fee1bbd8 ^
15676346 ^
d89af9bd ^



15676346 ^


27b1e19e ^
15676346 ^



















d89af9bd ^
606c1ab4 ^
8b85a07f ^



b3998440 ^
fa805850 ^
b3998440 ^
fa805850 ^
8b85a07f ^
5e0ae917 ^







af983921 ^








0ef7f1d2 ^
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364