summary refs log blame commit diff stats
path: root/HACKING
blob: 84fb753998196bf33f4bacca081f983ca0107667 (plain) (tree) 
f8f6f7f9 ^




















































































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




















































































                                                                          
Guidelines on Code Modification
===============================

Coding Style
------------

* Use syntax compatible to both python 2.6 and 3.1.
* Use docstrings with pydoc in mind
* Follow the style guide for python code:
    http://www.python.org/dev/peps/pep-0008/
* Although this guide suggests otherwise, tabs are used for indentation
    of code and docstrings.  In other documents (readme, etc), use spaces.


Patches
-------

Send patches, created with "git format-patch", to the email adress

    hut@lavabit.com

If you plan to do major changes, or many changes over time, I encourage
you to create a fork on GitHub or Gitorious.


Common Changes
--------------

* Change which files are previewed in the auto preview:
In ranger/gui/widget/browsercolumn.py
the constant PREVIEW_BLACKLIST

* Adding options:
In ranger/defaults/options.py
add the default value, like: my_option = True
In ranger/shared/settings.py
add the name of your option to the constant ALLOWED_SETTINGS

The setting is now accessible at self.settings.my_option,
assuming <self> is a "SettingsAware" object.

* Change commands:
ranger/commands.py

* Create aliases for commands:
In ranger/commands.py
at the bottom, write something like: alias(exit=quit)

* Adding colorschemes:
Copy ranger/colorschemes/default.py to ranger/colorschemes/myscheme.py
and modify it according to your needs.
In ranger/defaults/options.py, change
    colorscheme = colorschemes.default
to: colorscheme = colorschemes.myscheme

* Change which files are considered to be "hidden":
In ranger/defaults/options.py
change the hidden_filter regular expression.

* Change the key map:
Modify ranger/defaults/keys.py.  This should be self-explanatory.
Check out ranger/actions.py for the most common actions, of course
you can also use your own functions.

* Change the file type => application associations:
In ranger/defaults/apps.py
modify the method app_default.
The variable "f" is a filesystem-object with attributes like mimetype,
extension, etc.  For a full list, check ranger/fsobject/fsobject.py

* Change the file extension => mime type associations:
Modify ranger/data/mime.types
and run ranger/data/generate.py to compile it.


Version Numbering
-----------------

X.Y.Z, where:

* X: Milestones
* Y: Stable versions
* Z: Experimental versions
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2024-12-17 19:49:43 +0000
010-01-23 06:09:05 +0100 committer hut <hut@lavabit.com> 2010-01-23 06:09:05 +0100 console: better tab completion for OpenConsole' href='/akspecs/ranger/commit/TODO?h=v1.8.1&id=316ff5a92b1bc0fee1a1ddf946880f1697a35190'>316ff5a9 ^ 
fc486c60 ^

b4934e42 ^

2c1d2db0 ^

291ca616 ^

50845f37 ^

039c03ef ^

af6658b3 ^

efe2d7a3 ^

f0df3fa5 ^

a986e2bd ^


3fe38754 ^


6a8d5d23 ^

aad61455 ^

7a268c8b ^


efdc7b16 ^

636f69d3 ^

d3c262a9 ^

e02d47ed ^


4be8b401 ^




d955e3f0 ^

75013dc7 ^

67bb838c ^

a808a661 ^

bba8d293 ^

2a64495f ^

5e449699 ^

8895b130 ^


7b04e507 ^

87db0130 ^

dd4a4145 ^

8f2f1767 ^

db1721dd ^

aea5cf92 ^

b624bd94 ^

69d1220f ^

6099d9a3 ^

9207e83c ^

f7db061b ^

6099d9a3 ^

5a8b6059 ^

6f43de0a ^





fca1fc4f ^

f70ee6b2 ^

0db4c9b2 ^

b2d63ef5 ^

6908d0cc ^

d994d0d6 ^

01c89bb5 ^

c776804d ^

dab4db44 ^

cc4210ff ^

34c131ef ^

66c5bb93 ^

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


       

                                      
                               
                                         
                                                    



       
                                                    
                                           
                                     
                                                                

                                                                  
                            
                                                               
                                                        
                                                        
                                       
                                 
                                                             
                                       
                                                  
                                                                        
                                             
                                                                      
                                                           
                                                           
                                        
                                                
                                                              
                                                                     
                                            
                                                  
                                                                          
                                         
                                                     

                                                                        

                                                              
                                                      
                                                      

                                                
                                                   
                                                
                                                           

                                                    



    
                                                           
                                                              
                                               
                                                                   
                                                                 
                                                              
                                                                              

                                                   
                                                                
                                                           
                                        
                                                          
                                                             
                                            
                                                     
                                                                                  
                                           
                                                              
                                                                        
                                            
                                                                           




                                                               
                                  
                                                                     
                                                                
                                                 
                                                           
                                              
                                                         
                                                                
                                         
                                                   
                                                       
 
Console

   (X) #0   09/12/06  console commands
   (X) #1   09/12/06  quick find
   (X) #2   09/12/06  open with
   (X) #4   09/12/06  history for console
   (X) #13  09/12/27  display docstring of a command


General

   (X) #5   09/12/06  move code from fm into objects
   (X) #6   09/12/06  move main to __init__
   (X) #7   09/12/06  cooler titlebar
   (X) #8   09/12/17  Add operations to modify files/directories
   (X) #9   09/12/24  add a widget for managing running operations
   (X) #10  09/12/24  sorting
   (X) #11  09/12/27  filter
   (X) #12  09/12/27  jump through the list in a specific order
   (X) #14  09/12/29  make filelists inherit from pagers
   (X) #15  09/12/29  better way of running processes!!~
   (X) #16  10/01/01  list of bookmarks
   (X) #21  10/01/01  write help!
   (X) #22  10/01/03  add getopt options to change flags/mode
   (X) #29  10/01/06  add chmod command
   (X) #30  10/01/06  add a way to create symlinks
   (X) #32  10/01/08  place the (hidden) cursor to a meaningful position
   (X) #34  10/01/09  display free disk space
   (X) #35  10/01/09  display disk usage of files in current directory
   ( ) #36  10/01/11  help coloring is terribly inefficient
   (X) #37  10/01/13  better tab completion for OpenConsole
   ( ) #38  10/01/16  searching in pager
   (X) #39  10/01/17  flushinput not always good
   (X) #42  10/01/17  memorize directory for `` when using :cd
   (X) #43  10/01/18  internally treat the bookmarks ` and ' the same
   ( ) #44  10/01/18  more error messages :P
   (X) #47  10/01/19  less restricive auto preview
   (X) #48  10/01/19  abbreviate commands with first unambiguous substring
   ( ) #50  10/01/19  add more unit tests
   ( ) #51  10/01/21  remove directory.marked_items ?
   (X) #55  10/01/24  allow change of filename when pasting
          you're given the choice between overwriting or appending a "_"
   ( ) #56  10/01/30  warn before deleting mount points
   ( ) #57  10/01/30  warn before deleting unseen marked files
   (X) #58  10/02/04  change the title of the terminal
   (X) #61  10/02/09  show sum of size of marked files
   (X) #63  10/02/15  limit filesize in previews
   ( ) #64  10/02/25  scroll in previews
   (X) #66  10/02/28  explain how colorschemes work
   (X) #70  10/03/14  mouse handler for titlebar
   (X) #71  10/03/21  previews: black/whitelist + read file
   ( ) #79  10/04/08  tab number zero
   ( ) #80  10/04/08  when closing tabs, avoid gaps?


Bugs

   (X) #17  10/01/01  why do bookmarks disappear sometimes?
   (X) #18  10/01/01  fix notify widget (by adding a LogView?)
   (X) #19  10/01/01  resizing after pressing g
   (X) #23  10/01/04  stop dir loading with ^C -> wont load anymore
   (X) #25  10/01/06  directories sometimes dont reload correctly
   (X) #26  10/01/06  :delete on symlinks of directories fails
   (X) #31  10/01/06  ^C breaks cd-after-exit by stopping sourced shell script
   (X) #40  10/01/17  freeze with unavailable sshfs
          Not rangers fault (?)
   (X) #41  10/01/17  capital file extensions are not recognized
   (X) #46  10/01/19  old username displayed after using su
   (X) #49  10/01/19  fix unit tests :'(
   (X) #52  10/01/23  special characters in tab completion
   (X) #54  10/01/23  max_dirsize_for_autopreview not working
   ( ) #60  10/02/05  utf support improvable
   (X) #62  10/02/15  curs_set can raise an exception
   (X) #65  10/02/16  "source ranger ranger some/file.txt" shouldn't cd after exit
   (X) #67  10/03/08  terminal title in tty
   (X) #69  10/03/11  tab-completion breaks with Apps subclass
   (X) #73  10/03/21  when clicking on the first column, it goes 1x down
   (X) #74  10/03/21  console doesn't scroll
   ( ) #78  10/03/31  broken preview when deleting all files in a directory


Ideas

   ( ) #20  10/01/01  use inotify to monitor filesystem changes
   ( ) #24  10/01/06  progress bar
   (X) #27  10/01/06  hide bookmarks in list which contain hidden dir
   (X) #28  10/01/06  use regexp instead of string for searching
   ( ) #33  10/01/08  accelerate mousewheel speed
   (X) #45  10/01/18  hooks for events like setting changes
   ( ) #53  10/01/23  merge fm and environment
   ( ) #68  10/03/10  threads, to seperate ui and loading
   ( ) #72  10/03/21  ranger daemon which does the slow io tasks
   ( ) #75  10/03/28  navigate in history
   (X) #76  10/03/28  save history between sessions
   (X) #77  10/03/28  colorscheme overlay in options.py
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2024-12-17 19:49:39 +0000