diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 92 |
1 files changed, 44 insertions, 48 deletions
diff --git a/README b/README index e48edeb8..57fce508 100644 --- a/README +++ b/README @@ -1,58 +1,27 @@ -Ranger v.1.5.0 +ranger v.1.5.0 ============== +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 free console file manager that gives you greater flexibility -and a good overview of your files without having to leave your *nix console. -It visualizes the directory tree in two dimensions: the directory hierarchy -on one, lists of files on the other, with a preview to the right so you know -where you'll be going. - -The default keys are similar to those of Vim, Emacs and Midnight Commander, -though Ranger is easily controllable with just the arrow keys or the mouse. - -The program is written in Python (2.6 or 3.1) and uses curses for the -text-based user interface. - - -Getting Started ---------------- - -Ranger can be started without installing: Just run ranger.py. If you want to -install it anyway, the INSTALL file contains instructions. - -After starting ranger, you can use the Arrow Keys (or hjkl) to navigate, Enter -to open a file or type Q to quit. The column on the right shows a preview of -the current file. The second from the right is the main column and the others -show parent directories. - -The manual page of ranger contains a documentation of rangers functions, -keybindings, commands and options. You can access it by typing "?" in ranger, -running "man ranger" or view it online. - -An easy way to customize ranger is running "ranger --copy-config=all" -and editing the new files in ~/.config/ranger/. +This file describes ranger and how to get it to run. For instructions on the +usage, please read the man page. About ----- +* Authors: Check the copyright notices in each source file +* License: GNU General Public License Version 3 -* Authors: Check the copyright notices in each source file -* Website: http://ranger.nongnu.org/ -* License: GNU General Public License Version 3 - -* Download URL of the newest stable version: -http://ranger.nongnu.org/ranger-stable.tar.gz - -* Git Clone URL: -git clone http://git.sv.gnu.org/r/ranger.git - -* Bug report: -https://savannah.nongnu.org/bugs/?group=ranger&func=additem +* Website: http://ranger.nongnu.org/ +* Download: http://ranger.nongnu.org/ranger-stable.tar.gz +* GIT Clone: http://git.sv.gnu.org/r/ranger.git +* Bug reports: https://savannah.nongnu.org/bugs/?group=ranger&func=additem Design Goals ------------ - * An easily maintainable file manager in a high level language * A quick way to switch directories and browse the file system * Keep it small but useful, do one thing and do it well @@ -61,7 +30,7 @@ Design Goals Features -------- - +* UTF-8 Support (if your python copy supports it) * Multi-column display (Miller Columns) * Preview of the selected file/directory * Common file operations (create/chmod/copy/delete/...) @@ -74,9 +43,7 @@ Features Dependencies ------------ - -* Python 2.6, 2.7 or Python 3.1 with the curses module -(Later versions might work too, but 2.5 definitely won't.) +* Python (tested with version 2.6, 2.7, 3.1, 3.2) with the curses module Optional: * The "file" program @@ -88,3 +55,32 @@ For scope.sh: (enhanced file previews) * highlight for syntax highlighting of code * atool for previews of archives * lynx or elinks for previews of html pages + + +Installing +---------- + +Use the package manager of your operating system to install ranger. + +To install ranger manually: + sudo make install + +This translates roughly to: + sudo ./setup.py install --optimize=1 --record=install_log.txt + +This also saves a list of all installed files to install_log.txt, which you can +use to uninstall ranger. + + +Getting Started +--------------- +ranger can be started without installing: Just run ranger.py. If you want to +install it anyway, the INSTALL file contains instructions. + +After starting ranger, you can use the Arrow Keys (or hjkl) to navigate, Enter +to open a file or type Q to quit. The column on the right shows a preview of +the current file. The second from the right is the main column and the others +show parent directories. + +An easy way to customize ranger is running "ranger --copy-config=all" +and editing the new files in ~/.config/ranger/. |