diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 59 |
1 files changed, 50 insertions, 9 deletions
diff --git a/README b/README index 6e386635..5534a26a 100644 --- a/README +++ b/README @@ -1,11 +1,14 @@ -Ranger v.1.0.4 +Ranger v.1.3.0 ============== -Ranger is a console file manager with fast and straightforward navigation. -By efficiently using the screen space, it gives you a broad overview of -your file system. Ranger's hotkeys are similar to those of other common -unix programs such as VIM, Emacs and Midnight Commander, though it's -controllable with Arrow Keys just fine. +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. @@ -16,9 +19,7 @@ About * Author: Roman Zimbelmann <romanz@lavabit.com> * Website: http://savannah.nongnu.org/projects/ranger -* Dependencies: Unix-like OS, Python 2.6 or 3.1 * License: GNU General Public License Version 3 -* Version: 1.0.4 * Download URL of the newest stable version: http://git.savannah.gnu.org/cgit/ranger.git/snapshot/ranger-stable.tar.gz @@ -27,6 +28,15 @@ http://git.savannah.gnu.org/cgit/ranger.git/snapshot/ranger-stable.tar.gz git clone http://git.sv.gnu.org/r/ranger.git +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 +* Console based, with smooth integration into the unix shell + + Features -------- @@ -39,6 +49,17 @@ Features * Tabs, Bookmarks, Mouse support +Dependencies +------------ + +* A *nix-like operating system +* Python 2.6 or Python 3.1 with the curses module + +Optional: +* The "file" program +* A pager ("less" by default) + + Getting Started --------------- @@ -54,10 +75,30 @@ parent directories and to the right there's a preview of the object you're pointing at. Now use the Arrow Keys to navigate, Enter to open a file or type Q to quit. -To customize ranger, copy the files from ranger/defaults/ to ~/.ranger/ +To customize ranger, copy the files from ranger/defaults/ to ~/.config/ranger/ and modify them according to your wishes. +Usage Tips +---------- + +The author of ranger uses this function (in ~/.bashrc) to start ranger: +function ranger-cd { + before="$(pwd)" + python2.6 /the/path/to/ranger/ranger.py --fail-unless-cd "$@" || return 0 + after="$(grep \^\' ~/.config/ranger/bookmarks | cut -b3-)" + if [[ "$before" != "$after" ]]; then + cd "$after" + fi +} +bind '"\C-o":"ranger-cd\C-m"' + +This changes the directory after you close ranger and adds the shortcut +<CTRL-O> for starting ranger. + +To change back to the previous directory, you can type: cd - + + Troubleshooting, Getting Help ----------------------------- |