README

   1 ranger v.1.5.5
   2 ==============
   3 ranger is a console file manager with VI key bindings.  It provides a
   4 minimalistic and nice curses interface with a view on the directory hierarchy.
   5 The secondary task of ranger is to figure out which program you want to use to
   6 open your files with.
   7
   8 This file describes ranger and how to get it to run.  For instructions on the
   9 usage, please read the man page.  See doc/HACKING for development specific
  10 information.  For configuration, check the files in ranger/defaults/.  They
  11 are usually installed to /usr/lib/python*/site-packages/ranger/defaults/
  12 and can be obtained with ranger's --copy-config option.
  13
  14 A note to packagers:  Versions meant for packaging are listed in the changelog
  15 on the website.
  16
  17
  18 About
  19 -----
  20 * Authors:     Check the copyright notices in each source file
  21 * License:     GNU General Public License Version 3
  22
  23 * Website:     http://ranger.nongnu.org/
  24 * Download:    http://ranger.nongnu.org/ranger-stable.tar.gz
  25 * Bug reports: https://savannah.nongnu.org/bugs/?group=ranger&func=additem
  26 * git clone    http://git.sv.gnu.org/r/ranger.git
  27
  28
  29 Design Goals
  30 ------------
  31 * An easily maintainable file manager in a high level language
  32 * A quick way to switch directories and browse the file system
  33 * Keep it small but useful, do one thing and do it well
  34 * Console based, with smooth integration into the unix shell
  35
  36
  37 Features
  38 --------
  39 * UTF-8 Support  (if your python copy supports it)
  40 * Multi-column display
  41 * Preview of the selected file/directory
  42 * Common file operations (create/chmod/copy/delete/...)
  43 * Renaming multiple files at once
  44 * VIM-like console and hotkeys
  45 * Automatically determine file types and run them with correct programs
  46 * Change the directory of your shell after exiting ranger
  47 * Tabs, Bookmarks, Mouse support
  48
  49
  50 Dependencies
  51 ------------
  52 * Python (tested with version 2.6, 2.7, 3.1, 3.2) with support for ncurses
  53   and (optionally) wide-unicode.
  54 * A pager ("less" by default)
  55
  56 Optional:
  57 * The "file" program for determining file types
  58 * The python module "chardet", in case of encoding detection problems
  59 * "sudo" to use the "run as root"-feature
  60
  61 Optional, for enhanced file previews (with "scope.sh"):
  62 * img2txt (from caca-utils) for previewing images
  63 * highlight for syntax highlighting of code
  64 * atool for previews of archives
  65 * lynx, w3m or elinks for previews of html pages
  66 * pdftotext for pdf previews
  67 * transmission-show for viewing bit-torrent information
  68 * mediainfo for viewing information about media files
  69
  70
  71 Installing
  72 ----------
  73 Use the package manager of your operating system to install ranger.
  74 Note that ranger can be started without installing by simply running ranger.py.
  75
  76 To install ranger manually:
  77     sudo make install
  78
  79 This translates roughly to:
  80     sudo python setup.py install --optimize=1 --record=install_log.txt
  81
  82 This also saves a list of all installed files to install_log.txt, which you can
  83 use to uninstall ranger.
  84
  85
  86 Getting Started
  87 ---------------
  88 After starting ranger, you can use the Arrow Keys (or hjkl) to navigate, Enter
  89 to open a file or type Q to quit.  The third column shows a preview of the
  90 current file.  The second is the main column and the first shows the parent
  91 directory.
  92
  93 Ranger can automatically copy default configuration files to ~/.config/ranger
  94 if you run it with the switch --copy-config. (see ranger --help for a
  95 description of that switch.)  Also check ranger/defaults/ for the default
  96 configuration.