diff options
| -rw-r--r-- | README | 43 |
1 files changed, 22 insertions, 21 deletions
diff --git a/README b/README index 3cf0bfde..52142aa8 100644 --- a/README +++ b/README @@ -1,9 +1,9 @@ ranger v.1.5.0 ============== 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. +minimalistic and nice curses interface with a view on the directory hierarchy. +The secondary task of ranger is to figure out which program you want to use to +open your files with. This file describes ranger and how to get it to run. For instructions on the usage, please read the man page. See doc/HACKING for development specific @@ -11,8 +11,7 @@ information. For configuration, check the sample files that ranger creates in your ~/.config/ranger directory. A note to packagers: Versions meant for packaging are listed in the changelog -on the website and are taken from the stable branch. The master branch is a -"work in progress" branch. +on the website. About @@ -22,8 +21,8 @@ About * 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 +* git clone http://git.sv.gnu.org/r/ranger.git Design Goals @@ -37,7 +36,7 @@ Design Goals Features -------- * UTF-8 Support (if your python copy supports it) -* Multi-column display (Miller Columns) +* Multi-column display * Preview of the selected file/directory * Common file operations (create/chmod/copy/delete/...) * Renaming multiple files at once @@ -50,43 +49,45 @@ Features Dependencies ------------ * Python (tested with version 2.6, 2.7, 3.1, 3.2) with the curses module + and, optionally, support for wide-unicode. Optional: * The "file" program * A pager ("less" by default) * The python module "chardet", in case of encoding detection problems -For scope.sh: (enhanced file previews) +Optional, for enhanced file previews (with "scope.sh"): * img2txt (from caca-utils) for previewing images * highlight for syntax highlighting of code * atool for previews of archives -* lynx or elinks for previews of html pages +* lynx, w3m or elinks for previews of html pages +* pdftotext for pdf previews +* transmission-show for viewing bit-torrent information +* mediainfo for viewing information about media files Installing ---------- - Use the package manager of your operating system to install ranger. +Note that ranger can be started without installing by simply running ranger.py. To install ranger manually: sudo make install This translates roughly to: - sudo ./setup.py install --optimize=1 --record=install_log.txt + sudo python 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/. +to open a file or type Q to quit. The third column shows a preview of the +current file. The second is the main column and the first shows the parent +directory. + +Ranger will automatically copy simple configuration files to ~/.config/ranger. +If you mess them up, just delete them and ranger will copy them again. Run +ranger with --dont-copy-config to disable this. Also check ranger/defaults/ +for the default configuration. |