about summary refs log blame commit diff stats
path: root/README
blob: 6e386635c6095c18d60a1762bc5b45cf36da4156 (plain) (tree)
1
2
3
4
5
6
7
8
9
              
              
 

                                                                          


                                                                        
 

                                                                     
 


     
 
                                                         
                                                             

                                                       
                        
 





                                                                         
 

        
 
                                       

                                                       
                              
                                                                       
                                                         
                                



               
 


                                                                      
 
                                                                  
 




                                                                          
 

                                                                       
 
 

                             
 


                                                                       
 
                                
 

                                                                          
 

                                                     
 
 

               
 
                                                                  
 

                                                                          
 

                                                                         
Ranger v.1.0.4
==============

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.

The program is written in Python (2.6 or 3.1) and uses curses for the
text-based user interface.


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

* Git Clone URL:
git clone http://git.sv.gnu.org/r/ranger.git


Features
--------

* Multi-column display (Miller Columns)
* Preview of the selected file/directory
* Common file operations (create/chmod/copy/delete/...)
* 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


Getting Started
---------------

Ranger can be started without installing.  Just run the executable (in
a terminal.)  The switch "--clean" will prevent it from creating or
accessing configuration files.

Follow the instructions in the INSTALL file for installing ranger.

After starting ranger, you should see 4 columns. The third one is the main
column, the directory where you're currently at.  To the left you see the
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/
and modify them according to your wishes.


Troubleshooting, Getting Help
-----------------------------

If you encounter an error, try running ranger with --debug.  This will
sometimes display more detailed information about the error.  Also, try
deactivating optimization:

PYTHONOPTIMIZE="" ranger --debug

Report bugs on savannah:  (please include as much information as possible)
http://savannah.nongnu.org/bugs/?func=additem&group=ranger

Ask questions on the mailing list:
http://lists.nongnu.org/mailman/listinfo/ranger-users


Further Reading
---------------

Check the man page for information on common features and hotkeys.

The most detailed manual is accessible by pressing "?" from inside ranger.
It is also available at ranger/help/, contained in the *.py files.

The file ranger/defaults/keys.py contains all key combinations, so that's
another place you may want to check out.