summary refs log blame commit diff stats
path: root/LICENSE
blob: a5893df774e901efb834f9050ed4600a7ebe2d21 (plain) (tree) 
f59d542













1
2
3
4
5
6
7
8
9
10
11
12
13













                                                                        
Copyright (c) 2020, Andinus <andinus@inventati.org>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2024-11-22 00:51:02 +0000
/blame/README.md?id=6315c2f9f4f9f23770d7f1cd2d8d02cacb2a2729'>^ 
b1a5c210 ^




11baa253 ^

240394a4 ^

7b2e4b08 ^

813b52b7 ^

03ed2a43 ^


c7984f2f ^


03ed2a43 ^


2e74f350 ^

03ed2a43 ^

7bf5f967 ^

03ed2a43 ^

7dc8fef8 ^

4833bc23 ^


4ea0f69a ^


03ed2a43 ^

240394a4 ^

03dae5f0 ^


9a619526 ^

03dae5f0 ^

9e89f023 ^

36e4e71e ^

4ba064ff ^

20ab9343 ^

20ab9343 ^



813b52b7 ^

20ab9343 ^


4ea0f69a ^


813b52b7 ^

7dc8fef8 ^

36e4e71e ^


4a383291 ^

78a7d762 ^

e952d6cb ^

78a7d762 ^

813b52b7 ^

4ea0f69a ^


7838675f ^


bc54f757 ^

813b52b7 ^

03ed2a43 ^

7838675f ^

0e0f3467 ^

2c8cb95f ^

0e0f3467 ^



15774317 ^

7b2e4b08 ^

962876db ^


7838675f ^

977254aa ^

2c8cb95f ^

03ed2a43 ^

962876db ^

15774317 ^


1f3dcc27 ^

0e0f3467 ^

962876db ^


0e0f3467 ^

962876db ^


15774317 ^


813b52b7 ^

03ed2a43 ^


15774317 ^


5291bad4 ^

240394a4 ^



240394a4 ^

ce38f6c7 ^

3d136f87 ^















0bdc78f0 ^

3d136f87 ^

240394a4 ^


03ed2a43 ^



240394a4 ^


03ed2a43 ^



2c8cb95f ^

03ed2a43 ^

240394a4 ^


e5fb3d74 ^

4ba064ff ^

240394a4 ^

813b52b7 ^




7dc8fef8 ^

03ed2a43 ^

d9b5426e ^

78edc1ed ^

d9b5426e ^

e34106cc ^


4ba064ff ^

e34106cc ^

db9e5bca ^

931fc503 ^

d83f4104 ^

75b377da ^





49b7d5f1 ^

21d30692 ^

1

2

3

4

5

6

7
8
9

10

11

12

13

14

15

16

17

18
19

20
21
22
23

24

25

26

27

28
29

30
31

32
33

34

35

36

37

38

39
40

41
42

43

44

45
46

47

48

49

50

51

52

53
54
55

56

57
58

59
60

61

62

63
64

65

66

67

68

69

70
71

72
73

74

75

76

77

78

79

80
81
82

83

84

85
86

87

88

89

90

91

92
93

94

95

96
97

98

99
100

101
102

103

104
105

106
107

108

109
110
111

112

113

114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

129

130

131
132

133
134
135

136
137

138
139
140

141

142

143
144

145

146

147

148
149
150
151

152

153

154

155

156

157
158

159

160

161

162

163

164
165
166
167
168

169

170

            
            
 
                                                                
 
                                                                                                             


                                                                                                    
 
                                                                     
                                                                              
                                                                            
                                            
 
                                                                                                       
 

                                                          



                                                                                                                                      
 
                                                                             
                                                                               
                                     

                                                                  

                                                                

                                                                                   
                                                                           
                                                          
 
                                                                             
               

 

     
                                 
                                                   

                                                            
                                                      
                                                   
 
 
            
            


                                                              
                                                            

 

        
                                                  
                      

                                                       
                                 
                              
                                                                       
                                                         
                                   

 

            
                                                      
                                       
                             
 
                         
 


                                   
                                                                          
                                         

                                                                              
 
                                             
 
                                                            
                                                                                                    

                                                                           
                                                                    
                                                            

                                                                           
                                                 

                                                                               

                                                                  
                                                        

                                                                       

                                 
                                                                       


          
                                                                   
                                                                      














                                                                                              
                           
                                                                             

                           


                 

                           


                                                                  
 
                                                                                 

                        
 
               
               



                                                                               
 
                                                                               
                                                                         
                                                                 
                                               

 
             
               
                                                                                                                           
                                                                                                                         
                                                                                               




                                                                                 
                                                                                   
                                                          
ranger 1.9.3
============

<img src="https://ranger.github.io/ranger_logo.png" width="150">

[![Build Status](https://travis-ci.org/ranger/ranger.svg?branch=master)](https://travis-ci.org/ranger/ranger)
<a href="https://repology.org/metapackage/ranger/versions">
  <img src="https://repology.org/badge/latest-versions/ranger.svg" alt="latest packaged version(s)">
</a>

ranger is a console file manager with VI key bindings.  It provides a
minimalistic and nice curses interface with a view on the directory hierarchy.
It ships with `rifle`, a file launcher that is good at automatically finding
out which program to use for what file type.

![screenshot](https://raw.githubusercontent.com/ranger/ranger-assets/master/screenshots/screenshot.png)

For `mc` aficionados there's also the multi-pane viewmode.

<p>
<img src="https://raw.githubusercontent.com/ranger/ranger-assets/master/screenshots/twopane.png" alt="two panes" width="49%" />
<img src="https://raw.githubusercontent.com/ranger/ranger-assets/master/screenshots/multipane.png" alt="multiple panes" width="49%" />
</p>

This file describes ranger and how to get it to run.  For instructions on the
usage, please read the man page (`man ranger` in a terminal).  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`
(see [instructions](#getting-started)).

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 dependencies

For general usage:

* `file` for determining file types
* `chardet` (Python package) for improved encoding detection of text files
* `sudo` to use the "run as root" feature
* `python-bidi` (Python package) to display right-to-left file names correctly
  (Hebrew, Arabic)

For enhanced file previews (with `scope.sh`):

* `img2txt` (from `caca-utils`) for ASCII-art image previews
* `w3mimgdisplay`, `ueberzug`, `mpv`, `iTerm2`, `kitty`, `terminology` or `urxvt` for image previews
* `convert` (from `imagemagick`) to auto-rotate images and for SVG previews
* `ffmpegthumbnailer` for video thumbnails
* `highlight`, `bat` or `pygmentize` for syntax highlighting of code
* `atool`, `bsdtar`, `unrar` and/or `7z` to preview archives
* `bsdtar`, `tar`, `unrar`, `unzip` and/or `zipinfo` (and `sed`) to preview
  archives as their first image
* `lynx`, `w3m` or `elinks` to preview html pages
* `pdftotext` or `mutool` (and `fmt`) for textual `pdf` previews, `pdftoppm` to
  preview as image
* `djvutxt` for textual DjVu previews, `ddjvu` to preview as image
* `calibre` or `epub-thumbnailer` for image previews of ebooks
* `transmission-show` for viewing BitTorrent information
* `mediainfo` or `exiftool` for viewing information about media files
* `odt2txt` for OpenDocument text files (`odt`, `ods`, `odp` and `sxw`)
* `python` or `jq` for JSON files
* `fontimage` for font previews
* `openscad` for 3D model previews (`stl`, `off`, `dxf`, `scad`, `csg`)

Installing
----------
Use the package manager of your operating system to install ranger.
You can also install ranger through PyPI: ```pip install ranger-fm```.

<details>
  <summary>
    Check current version:
    <sub>
      <a href="https://repology.org/metapackage/ranger/versions">
        <img src="https://repology.org/badge/tiny-repos/ranger.svg" alt="Packaging status">
      </a>
    </sub>
  </summary>
  <a href="https://repology.org/metapackage/ranger/versions">
    <img src="https://repology.org/badge/vertical-allrepos/ranger.svg" alt="Packaging status">
  </a>
</details>

### Installing from a clone
Note that you don't *have* to install ranger; you can simply run `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 `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.


Going Further
---------------
* To get the most out of ranger, read the [Official User Guide](https://github.com/ranger/ranger/wiki/Official-user-guide).
* For frequently asked questions, see the [FAQ](https://github.com/ranger/ranger/wiki/FAQ%3A-Frequently-Asked-Questions).
* For more information on customization, see the [wiki](https://github.com/ranger/ranger/wiki).


Community
---------------
For help, support, or if you just want to hang out with us, you can find us here:
* **IRC**: channel **#ranger** on [Libera.Chat](https://libera.chat/guides/connect)
* **Reddit**: [r/ranger](https://www.reddit.com/r/ranger/)
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2024-11-22 00:50:58 +0000