diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HACKING | 28 | ||||
| -rw-r--r-- | doc/ranger.1 | 15 | ||||
| -rw-r--r-- | doc/ranger.pod | 13 |
3 files changed, 25 insertions, 31 deletions
diff --git a/doc/HACKING b/doc/HACKING index dd384758..f6d5d064 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -10,7 +10,7 @@ Coding Style 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. -* Test the code with unit tests where it makes sense +* Test the code with "doctest" where it makes sense Patches @@ -35,29 +35,25 @@ ranger/fsobject/fsobject.py About the UI: ranger/gui/widgets/browsercolumn.py ranger/gui/widgets/browserview.py -ranger/gui/defaultui.py +ranger/gui/ui.py Common Changes -------------- * Change which files are previewed in the auto preview: -In ranger/gui/widget/browsercolumn.py +In ranger/fsobject/file.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 +In ranger/container/settingobject.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. -* Changing commands, adding aliases: -ranger/defaults/commands.py -or ~/.config/ranger/commands.py - * Adding colorschemes: Copy ranger/colorschemes/default.py to ranger/colorschemes/myscheme.py and modify it according to your needs. Alternatively, mimic the jungle @@ -66,15 +62,6 @@ In ranger/defaults/options.py (or ~/.config/ranger/options.py), change colorscheme = 'default' to: colorscheme = '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/core/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. @@ -88,8 +75,5 @@ Modify ranger/data/mime.types Version Numbering ----------------- -X.Y.Z, where: - -* X: Major version, milestone -* Y: Minor version, even number => stable version -* Z: Revision, may be omitted if zero +Three numbers; The first changes on a rewrite, the second changes when major +configuration incompatibilities occur and the third changes with each release. diff --git a/doc/ranger.1 b/doc/ranger.1 index de50f621..19a0bb42 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -124,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.5.0" "10/05/2011" "ranger manual" +.TH RANGER 1 "ranger-1.5.0" "10/07/2011" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -139,10 +139,15 @@ ranger \- visual file manager [\fB\-\-flags\fR=\fIflags\fR] [\fIpath/filename\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" -ranger is a file manager with \s-1VI\s0 key bindings. It provides a minimalistic yet -nice curses interface with a view on the directory hierarchy. The secondary -task of ranger is to psychically guess which program you want to use for -opening particular files. +ranger is a console file manager with \s-1VI\s0 key bindings. It provides a +minimalistic yet nice curses interface with a view on the directory hierarchy. +The secondary task of ranger is to psychically guess which program you want to +use for opening particular files. +.PP +This manual mainly contains information on the usage of ranger. Refer to the +\&\fI\s-1README\s0\fR for install instructions and to \fIdoc/HACKING\fR for development +specific information. For configuration, check the sample files that ranger +created in your \fI~/.config/ranger\fR directory. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-d\fR, \fB\-\-debug\fR" 14 diff --git a/doc/ranger.pod b/doc/ranger.pod index eaadcf5b..ab876d7f 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -17,10 +17,15 @@ B<ranger> [B<--help>] [B<--version>] [B<--debug>] [B<--clean>] =head1 DESCRIPTION -ranger is a file manager with VI key bindings. It provides a minimalistic yet -nice curses interface with a view on the directory hierarchy. The secondary -task of ranger is to psychically guess which program you want to use for -opening particular files. +ranger is a console file manager with VI key bindings. It provides a +minimalistic yet nice curses interface with a view on the directory hierarchy. +The secondary task of ranger is to psychically guess which program you want to +use for opening particular files. + +This manual mainly contains information on the usage of ranger. Refer to the +F<README> for install instructions and to F<doc/HACKING> for development +specific information. For configuration, check the sample files that ranger +created in your F<~/.config/ranger> directory. |