diff options
Diffstat (limited to 'doc/ranger.1')
| -rw-r--r-- | doc/ranger.1 | 91 |
1 files changed, 85 insertions, 6 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1 index 54d35c8c..5324ccc3 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.9.2" "2019-12-27" "ranger manual" +.TH RANGER 1 "ranger-1.9.2" "2019-12-30" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -278,9 +278,66 @@ By default, only text files are previewed, but you can enable external preview scripts by setting the option \f(CW\*(C`use_preview_script\*(C'\fR and \f(CW\*(C`preview_files\*(C'\fR to true. .PP This default script is \fI\f(CI%rangerdir\fI/data/scope.sh\fR. It contains more -documentation and calls to the programs \fIlynx\fR and \fIelinks\fR for html, -\&\fIhighlight\fR for text/code, \fIimg2txt\fR for images, \fIatool\fR for archives, -\&\fIpdftotext\fR or \fImutool\fR for PDFs and \fImediainfo\fR for video and audio files. +documentation and calls to many external programs to generate previews. They +are automatically used when available but completely optional. +.IP "For general usage:" 2 +.IX Item "For general usage:" +.RS 2 +.PD 0 +.IP "\-" 2 +.PD +\&\f(CW\*(C`file\*(C'\fR for determining file types +.IP "\-" 2 +\&\f(CW\*(C`chardet\*(C'\fR (Python package) for improved encoding detection of text files +.IP "\-" 2 +\&\f(CW\*(C`sudo\*(C'\fR to use the \*(L"run as root\*(R" feature +.IP "\-" 2 +\&\f(CW\*(C`python\-bidi\*(C'\fR (Python package) to display right-to-left file names correctly +(Hebrew, Arabic) +.RE +.RS 2 +.RE +.IP "For enhanced file previews (with scope.sh):" 2 +.IX Item "For enhanced file previews (with scope.sh):" +.RS 2 +.PD 0 +.IP "\-" 2 +.PD +\&\f(CW\*(C`img2txt\*(C'\fR (from \f(CW\*(C`caca\-utils\*(C'\fR) for ASCII-art image previews +.IP "\-" 2 +\&\f(CW\*(C`w3mimgdisplay\*(C'\fR, \f(CW\*(C`ueberzug\*(C'\fR, \f(CW\*(C`mpv\*(C'\fR, \f(CW\*(C`iTerm2\*(C'\fR, \f(CW\*(C`kitty\*(C'\fR, \f(CW\*(C`terminology\*(C'\fR or +\&\f(CW\*(C`urxvt\*(C'\fR for image previews +.IP "\-" 2 +\&\f(CW\*(C`convert\*(C'\fR (from \f(CW\*(C`imagemagick\*(C'\fR) to auto-rotate images and for \s-1SVG\s0 previews +.IP "\-" 2 +\&\f(CW\*(C`ffmpegthumbnailer\*(C'\fR for video thumbnails +.IP "\-" 2 +\&\f(CW\*(C`highlight\*(C'\fR, \f(CW\*(C`bat\*(C'\fR or \f(CW\*(C`pygmentize\*(C'\fR for syntax highlighting of code +.IP "\-" 2 +\&\f(CW\*(C`atool\*(C'\fR, \f(CW\*(C`bsdtar\*(C'\fR, \f(CW\*(C`unrar\*(C'\fR and/or \f(CW\*(C`7z\*(C'\fR to preview archives +.IP "\-" 2 +\&\f(CW\*(C`bsdtar\*(C'\fR, \f(CW\*(C`tar\*(C'\fR, \f(CW\*(C`unrar\*(C'\fR, \f(CW\*(C`unzip\*(C'\fR and/or \f(CW\*(C`zipinfo\*(C'\fR (and \f(CW\*(C`sed\*(C'\fR) to preview archives as their first image +.IP "\-" 2 +\&\f(CW\*(C`lynx\*(C'\fR, \f(CW\*(C`w3m\*(C'\fR or \f(CW\*(C`elinks\*(C'\fR to preview html pages +.IP "\-" 2 +\&\f(CW\*(C`pdftotext\*(C'\fR or \f(CW\*(C`mutool\*(C'\fR (and \f(CW\*(C`fmt\*(C'\fR) for textual pdf previews, \f(CW\*(C`pdftoppm\*(C'\fR to preview as image +.IP "\-" 2 +\&\f(CW\*(C`djvutxt\*(C'\fR for textual DjVu previews, \f(CW\*(C`ddjvu\*(C'\fR to preview as image +.IP "\-" 2 +\&\f(CW\*(C`calibre\*(C'\fR or \f(CW\*(C`epub\-thumbnailer\*(C'\fR for image previews of ebooks +.IP "\-" 2 +\&\f(CW\*(C`transmission\-show\*(C'\fR for viewing BitTorrent information +.IP "\-" 2 +\&\f(CW\*(C`mediainfo\*(C'\fR or \f(CW\*(C`exiftool\*(C'\fR for viewing information about media files +.IP "\-" 2 +\&\f(CW\*(C`odt2txt\*(C'\fR for OpenDocument text files (odt, ods, odp and sxw) +.IP "\-" 2 +\&\f(CW\*(C`python\*(C'\fR or \f(CW\*(C`jq\*(C'\fR for \s-1JSON\s0 files +.IP "\-" 2 +\&\f(CW\*(C`fontimage\*(C'\fR for font previews +.RE +.RS 2 +.RE .PP Install these programs (just the ones you need) and scope.sh will automatically use them. @@ -620,6 +677,10 @@ also \*(L"da\*(R", \*(L"dr\*(R" and \*(L"dt\*(R" shortcuts equivalent to \*(L"ya .IX Item "pp" Paste the files which were previously copied or cut, like pressing Ctrl+V in modern \s-1GUI\s0 programs. +.Sp +Conflicts will be renamed by appending an '_' (and a counter if necessary), +resulting in \f(CW\*(C`file.ext_\*(C'\fR, \f(CW\*(C`file.ext_0\*(C'\fR, etc. If you prefer \f(CW\*(C`file_.ext\*(C'\fR you +can use the \f(CW\*(C`paste_ext\*(C'\fR command. .IP "po" 14 .IX Item "po" Paste the copied/cut files, overwriting existing files. @@ -1112,10 +1173,10 @@ a \s-1BIDI\s0 algorithm to reverse the relevant parts of the text. Requires the python-bidi pip package. .IP "update_title [bool]" 4 .IX Item "update_title [bool]" -Set a window title? +Set a window title? Updates both the \fI\s-1WM_NAME\s0\fR and \fI\s-1WM_ICON_NAME\s0\fR properties. .IP "update_tmux_title [bool]" 4 .IX Item "update_tmux_title [bool]" -Set the title to \*(L"ranger\*(R" in the tmux program? +Set the tmux \fIwindow-name\fR to \*(L"ranger\*(R"? .IP "use_preview_script [bool] <zv>" 4 .IX Item "use_preview_script [bool] <zv>" Use the preview script defined in the setting \fIpreview_script\fR? @@ -1149,6 +1210,10 @@ Increase it in case of experiencing display corruption. Offset in pixels for the inner border of the terminal. Some terminals require the offset to be specified explicitly, among others st and UXterm, some don't like urxvt. +.IP "wrap_plaintext_previews [bool]" 4 +.IX Item "wrap_plaintext_previews [bool]" +Whether or not to wrap long lines in the pager, this includes previews of plain +text files. .IP "wrap_scroll [bool]" 4 .IX Item "wrap_scroll [bool]" Enable scroll wrapping \- moving down while on the last item will wrap around to @@ -1802,6 +1867,11 @@ the \*(L"S\*(R" key. Defaults to \*(L"/bin/sh\*(R". .IX Item "TERMCMD" Defines the terminal emulator command that ranger is going to use with the :terminal command and the \*(L"t\*(R" run flag. Defaults to \*(L"xterm\*(R". +.IP "\s-1BAT_STYLE\s0" 8 +.IX Item "BAT_STYLE" +Specifies the theme to be used for syntax highlighting when \fIbat\fR is +installed, unless \fIhighlight\fR is also installed. Find out possible values by +running \f(CW\*(C`bat \-\-list\-themes\*(C'\fR. .IP "\s-1PYGMENTIZE_STYLE\s0" 8 .IX Item "PYGMENTIZE_STYLE" Specifies the theme to be used for syntax highlighting when \fIpygmentize\fR is @@ -1821,6 +1891,15 @@ Specifies the number of spaces to use to replace tabs in \fIhighlight\fRed files \&\fIhighlight\fR will pick up command line options specified in this variable. A \&\f(CW\*(C`\-\-style=\*(C'\fR option specified here will override \f(CW\*(C`HIGHLIGHT_STYLE\*(C'\fR. Similarly, \&\f(CW\*(C`\-\-replace\-tabs=\*(C'\fR will override \f(CW\*(C`HIGHLIGHT_TABWIDTH\*(C'\fR. +.IP "\s-1OPENSCAD_COLORSCHEME\s0" 8 +.IX Item "OPENSCAD_COLORSCHEME" +Specifies the colorscheme used by \fIopenscad\fR while previewing 3D models. Read +\&\fIopenscad\fR man page for colorschemes. Ranger will default to Tomorrow Night. +.IP "\s-1OPENSCAD_IMGSIZE\s0" 8 +.IX Item "OPENSCAD_IMGSIZE" +Specifies the internal resolution \fIopenscad\fR will use for rendering 3D models. +The image will be downscaled to fit the preview pane. This resolution will +default to \*(L"1000,1000\*(R" if no value is set. .IP "\s-1XDG_CONFIG_HOME\s0" 8 .IX Item "XDG_CONFIG_HOME" Specifies the directory for configuration files. Defaults to \fI\f(CI$HOME\fI/.config\fR. |