summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 16 insertions, 0 deletions
diff --git a/README b/README
index 96163a01..f82c8d5b 100644
--- a/README
+++ b/README
@@ -68,6 +68,22 @@ open files from the shell:
     ranger blabla.pdf
 
 
+== Customizing Ranger
+
+The file ranger/defaults/options.py contains most of the options.
+apps.py defines how files are run, keys.py defines keybindings.
+
+The files in ranger/defaults/ can be copied into ~/.ranger/ for per-user
+modifications.  Colorschemes can be placed in ~/.ranger/colorschemes.
+
+The options.py defines the import path of "apps", "keys" and the
+colorscheme.  To use the files you placed in ~/.ranger/, you may need
+to make this changes in the options.py:
+
+"from ranger.defaults import apps, keys" => "from . import apps, keys"
+"from ranger import colorschemes" => "from . import colorschemes"
+
+
 == Guidelines for developers:
 
 Tabs for indentation, spaces for tables and such
h=hlt&id=4a39d12d4568f76ebf45b34cec722d8e0bcf1207'>4a39d12d ^
4c4d325c ^
4a39d12d ^



f5465e12 ^

4a39d12d ^

e6056999 ^

70f4e9b6 ^
c0e9154d ^
f5465e12 ^
ccae4585 ^





f5465e12 ^


9a7e1a0f ^



f40b079c ^


9a7e1a0f ^





f40b079c ^
9a7e1a0f ^










201458e3 ^
97eb971b ^

8a92572d ^
9a7e1a0f ^









97eb971b ^
fdfe34de ^
9a7e1a0f ^
fdfe34de ^
9a7e1a0f ^

201458e3 ^


9a7e1a0f ^


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
           

                        

      
                               
           
                                                   


                                                

                                                                    


                                                                          
                                                                       



                                                                              

                                                                    

                                                                                                                          

                                                                                                                   
                                                                                           
                                                                                         
 





                                                                                           


                                 



                      


              





                                                                         
 










                                               
 

                       
                      









                                          
      
           
                                           
   

                                               


                


                      
#!/bin/bash
# Regenerate html files.

set -e

# convert a single file to html
process() {
  vim -c "set number" -c TOhtml -c write -c qall $1

  sed -i 's,<title>\~/mu/,<title>Mu - ,' $1.html
  sed -i 's,\.html</title>,</title>,' $1.html
  sed -i 's/^\* { \(.*\) }/* { font-size: 12pt; \1 }/g' $1.html
  sed -i 's/^body { \(.*\) }/body { font-size: 12pt; \1 }/g' $1.html
  # turn most code grey
  sed -i 's/#eeeeee/#aaaaaa/g' $1.html
  # ..so that we can use white for cross-links (underlining only on hover)
  sed -i '/^body {/ a  a:hover { text-decoration: underline; }' $1.html
  sed -i '/^body {/ a  a { color:#eeeeee; text-decoration: none; }' $1.html
  # line numbers are darker still
  sed -i 's/^\.LineNr .*/.LineNr { color: #444444; }/' $1.html  # line numbers
  # tweak contrast for remaining colors
  sed -i 's/^\.Constant .*/.Constant { color: #00a0a0; }/' $1.html
  sed -i 's/^\.muControl .*/.muControl { color: #c0a020; }/' $1.html
  # real links in comments continue to be the usual blue
  sed -i 's/^\.Comment .*/.Comment { color: #9090ff; }\n.Comment a { color:#0000ee; text-decoration:underline; }/' $1.html
  sed -i 's/^\.Delimiter .*/.Delimiter { color: #800080; }/' $1.html  # not meant to be read; can be lower-contrast
  sed -i 's/^\.PreProc .*/.PreProc { color: #800080; }/' $1.html  # not meant to be read; can be lower-contrast
  sed -i 's/^\.Identifier .*/.Identifier { color: #c0a020; }/' $1.html  # same as muControl
  sed -i 's/^\.Special .*/.Special { color: #c00000; }/' $1.html  # same as traceAbsent..

  # switch unicode characters around in the rendered html
  #   the ones we have in the source files render double-wide in html
  #   the ones we want in the html cause iTerm2 to slow down in alt-tabbing for some reason
  # the following commands give us the best of both worlds
  sed -i -e 's/┈/╌/g' -e 's/┊/╎/g' $1.html

  mv -i $1.html html/`dirname $1`
}

( cd linkify; build; )

  rm html/*.cc.html
  for f in *.cc
  do
    process $f
  done
  ctags -x *.cc  |grep -v "^operator \| member \| variable "  > /tmp/tags
  linkify/linkify /tmp/tags html/*.cc.html
  for f in html/*.cc.html
  do
    mv $f.out $f
  done

  rm html/[0-9]*.mu.html
  for f in [0-9]*.mu
  do
    process $f
  done
  ctags -x [0-9]*.mu  > /tmp/tags
  linkify/linkify /tmp/tags html/[0-9]*.mu.html
  for f in html/[0-9]*.mu.html
  do
    mv $f.out $f
  done

  for f in [a-zA-Z]*.mu
  do
    rm -f html/$f.html
    process $f
    ctags -x [0-9]*.mu $f  > /tmp/tags
    linkify/linkify /tmp/tags html/$f.html
    mv html/$f.html.out html/$f.html
  done

  rm html/edit/*.html
  for f in edit/*.mu
  do
    process $f
  done
  ( cd edit
    ctags -x ../[0-9]*.mu *.mu  > /tmp/tags
  )
  linkify/linkify /tmp/tags html/edit/*.mu.html
  for f in html/edit/*.mu.html
  do
    mv $f.out $f
  done

rm /tmp/tags
( cd linkify; clean; )