about summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorhut <hut@lavabit.com>2010-03-12 21:07:16 +0100
committerhut <hut@lavabit.com>2010-03-12 21:50:54 +0100
commita8f9cf2c8bcd2432b1b82a68422102a6924864d6 (patch)
treeb99f733a66f76ba3176bd6f6c99eb01fdb2baeb2 /doc
parent5ae6670c39493b72e126148ca21cd5cb8e681c7e (diff)
downloadranger-a8f9cf2c8bcd2432b1b82a68422102a6924864d6.tar.gz
standardized formatting of headings in doc/
Diffstat (limited to 'doc')
-rw-r--r--doc/cd-after-exit.txt22
-rw-r--r--doc/colorschemes.txt22
2 files changed, 31 insertions, 13 deletions
diff --git a/doc/cd-after-exit.txt b/doc/cd-after-exit.txt
index 5e54fee0..ee300518 100644
--- a/doc/cd-after-exit.txt
+++ b/doc/cd-after-exit.txt
@@ -1,6 +1,8 @@
 The "cd-after-exit" Feature
+===========================
 
-== Abstract
+Abstract
+--------
 
 This document explains the troublesome implementation of the "cd-after-exit"
 feature.
@@ -8,7 +10,8 @@ feature.
 This is written for developers who wonder how it's working.
 
 
-== Specification
+Specification
+-------------
 
 When the feature is enabled, ranger will attempt to change the directory of
 the parent shell (from which ranger is run) to the last visited directory
@@ -20,7 +23,8 @@ addition of support for csh, ksh, and other shells to those who actually use
 those shells.
 
 
-== What's the problem?
+What's the problem?
+-------------------
 
 Shells have several limitations, the implementation could not be done easily
 because:
@@ -33,7 +37,8 @@ of the parent shell at all.
 which is directly integrated in to the shell and can not be run this way.
 
 
-== Redirection of streams
+Redirection of streams
+----------------------
 
 The only way I found is using cd `program` from inside the shell to change
 the directory to whatever `program` prints to the stdout:
@@ -62,7 +67,8 @@ switch which:
     bash$ cd `ranger --cd-after-exit 3>&1 1>&2 2>&3 3>&-`
 
 
-== Argument passing
+Argument passing
+----------------
 
 This works well enough, but there are two remaining problems:
 
@@ -92,7 +98,8 @@ run.sh:
     cd "`$RANGER --cd-after-exit \"$@\" 3>&1 1>&2 2>&3 3>&-`"
 
 
-== Put it in a nutshell
+Put it in a nutshell
+--------------------
 
 I didn't want to have 2 files for the main program and wanted just one
 file at /usr/bin/ranger.  So I used this trick to merge both files into one:
@@ -120,7 +127,8 @@ A convenient way of using this feature is adding this line to your bashrc:
     alias rn='source ranger ranger'
 
 
-== Open issues
+Open issues
+-----------
 
 Unfortunately there is some redundancy: you have to type the path to ranger
 twice.  I know of no way to fix this, because it is not possible to get the
diff --git a/doc/colorschemes.txt b/doc/colorschemes.txt
index 9df33c3e..a189d4fd 100644
--- a/doc/colorschemes.txt
+++ b/doc/colorschemes.txt
@@ -1,9 +1,15 @@
-= Abstract =
+Colorschemes
+============
+
+Abstract
+--------
+
 
 This text explains colorschemes and how they work.
 
 
-= Context Tags =
+Context Tags
+------------
 
 Context Tags provide information about the context.  If the tag
 "in_titlebar" is set, you probably want to know about the color
@@ -16,7 +22,8 @@ A Context object, defined in the same file, contains attributes with
 the names of all tags, whose values are either True or False.
 
 
-= Implementation in the GUI Classes =
+Implementation in the GUI Classes
+---------------------------------
 
 The class CursesShortcuts in the file /ranger/gui/curses_shortcuts.py
 defines the methods color(*tags), color_at(y, x, wid, *tags) and
@@ -30,7 +37,8 @@ ranger.gui.context.Context object, sets its attributes "in_titlebar" and
 colorscheme's use(context) method.
 
 
-= The Color Scheme =
+The Color Scheme
+----------------
 
 A colorscheme should be a subclass of ranger.gui.ColorScheme and
 define the method use(context).  By looking at the context, this use-method
@@ -53,7 +61,8 @@ that tag.
 Run tc_colorscheme to check if your colorschemes are valid.
 
 
-= Specify a Colorscheme =
+Specify a Colorscheme
+---------------------
 
 Colorschemes are searched for in these directories:
 ~/.ranger/colorschemes/
@@ -73,7 +82,8 @@ specify which colorscheme to use in your options.py:
 colorscheme = colorschemes.default.MyOtherScheme
 
 
-= Adapt a colorscheme =
+Adapt a colorscheme
+-------------------
 
 You may want to adapt a colorscheme to your needs without having
 a complete copy of it, but rather the changes only.  Say, you
0:39 -0700 4695' href='/akkartik/mu/commit/subx/017jump_disp8.cc?h=hlt&id=0f851e48aa3e89648dfd39f706c36ba3c6964da8'>0f851e48 ^
0e0a9042 ^
0ca791cd ^
4a943d4e ^
















0080c23b ^
fc455c96 ^

222c31db ^
0080c23b ^
c442a5ad ^
0080c23b ^




4a943d4e ^
















0080c23b ^


0f851e48 ^
0e0a9042 ^
0ca791cd ^
4a943d4e ^


















0080c23b ^
fc455c96 ^

222c31db ^
0080c23b ^
c442a5ad ^
0080c23b ^




4a943d4e ^


















0080c23b ^


0f851e48 ^
0e0a9042 ^
0ca791cd ^
4a943d4e ^

















0080c23b ^
fc455c96 ^

222c31db ^
0080c23b ^
c442a5ad ^
0080c23b ^




4a943d4e ^

















0080c23b ^


0f851e48 ^
0e0a9042 ^
0ca791cd ^
4a943d4e ^


















0080c23b ^
fc455c96 ^

222c31db ^
0080c23b ^
c442a5ad ^
0080c23b ^




4a943d4e ^


















0080c23b ^


0f851e48 ^
0e0a9042 ^
0ca791cd ^
4a943d4e ^






































0080c23b ^
fc455c96 ^

222c31db ^
0080c23b ^
c442a5ad ^
0080c23b ^




4a943d4e ^


















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
365
366
367
368
369
370
371