about summary refs log tree commit diff stats
path: root/README
Commit message (Expand)AuthorAgeFilesLines
* added hint for downloading dextraAnselm R. Garbe2007-10-011-0/+3
* small change to READMEAnselm R. Garbe2006-09-281-1/+1
* updated README 1.7arg@mmvi2006-09-261-1/+1
* small changes to dwm.1, rearranged order within main event loopAnselm R.Garbe2006-08-211-1/+1
* applied Sanders doc changes, added a PHONY line and changed the output of con...arg@10ksloc.org2006-08-031-1/+2
* implemented the idea presented by Sander for dwm targetarg@10ksloc.org2006-08-021-2/+1
* fixed a type in README, and patched config.mkarg@10ksloc.org2006-08-021-1/+1
* removed the CONFIG variable from config.mk, renamed config.h into config.defa...arg@10ksloc.org2006-08-021-5/+1
* simplified READMEarg@10ksloc.org2006-08-011-4/+1
* centralized/externalized configuration to config.harg@10ksloc.org2006-08-011-2/+6
* applied Sanders patchesarg@10ksloc.org2006-08-011-8/+9
* s/sleep 5/sleep 2/arg@10ksloc.org2006-07-211-1/+1
* changed the status info README hint (more simple now, no extra script necessary)arg@10ksloc.org2006-07-211-7/+1
* added a note how to achieve status info in the bararg@10ksloc.org2006-07-211-1/+17
* updated READMEAnselm R. Garbe2006-07-171-2/+2
* added dev.c instead of kb.cAnselm R. Garbe2006-07-131-1/+1
* small changes to READMEAnselm R. Garbe2006-07-131-3/+3
* added logo+descriptionAnselm R. Garbe2006-07-131-13/+12
* removed unnecessary crapAnselm R. Garbe2006-07-131-4/+2
* added mouse-based resizalsAnselm R. Garbe2006-07-111-9/+1
* updated READMEAnselm R. Garbe2006-07-111-5/+15
* fixed several stuff (gridwm gets better and better)Anselm R. Garbe2006-07-111-0/+1
* initial importAnselm R. Garbe2006-07-101-0/+40
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-07-24 17:39:36 +0000
man page. See `HACKING.md` for development specific information. For configuration, check the files in `ranger/config/` or copy the default config to `~/.config/ranger` with `ranger --copy-config`. The `examples/` directory contains several scripts and plugins that demonstrate how ranger can be extended or combined with other programs. These files can be found in the git repository or in `/usr/share/doc/ranger`. A note to packagers: Versions meant for packaging are listed in the changelog on the website. About ----- * Authors: see `AUTHORS` file * License: GNU General Public License Version 3 * Website: https://ranger.github.io/ * Download: https://ranger.github.io/ranger-stable.tar.gz * Bug reports: https://github.com/ranger/ranger/issues * git clone https://github.com/ranger/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 -------- * UTF-8 Support (if your python copy supports it) * Multi-column display * Preview of the selected file/directory * Common file operations (create/chmod/copy/delete/...) * Renaming multiple files at once * VIM-like console and hotkeys * Automatically determine file types and run them with correct programs * Change the directory of your shell after exiting ranger * Tabs, bookmarks, mouse support Dependencies ------------ * Python (`>=2.6` or `>=3.1`) with the `curses` module and (optionally) wide-unicode support. * A pager (`less` by default) Optional: * The `file` program for determining file types * The python module `chardet`, in case of encoding detection problems * `sudo` to use the "run as root"-feature * `w3m` for the `w3mimgdisplay` program to preview images Optional, for enhanced file previews (with `scope.sh`): * `img2txt` (from `caca-utils`) for ASCII-art image previews * `highlight` or `pygmentize` for syntax highlighting of code * `atool`, `bsdtar` and/or `unrar` for previews of archives * `lynx`, `w3m` or `elinks` for previews of html pages * `pdftotext` for pdf previews * `transmission-show` for viewing bit-torrent information * `mediainfo` or `exiftool` for viewing information about media files * `odt2txt` for OpenDocument text files (`odt`, `ods`, `odp` and `sxw`) 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 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 --------------- After starting ranger, you can use the Arrow Keys or `h` `j` `k` `l` to navigate, `Enter` 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 can automatically copy default configuration files to `~/.config/ranger` if you run it with the switch `--copy-config=( rc | scope | ... | all )`. See `ranger --help` for a description of that switch. Also check `ranger/config/` for the default configuration.