diff options
author | toonn <toonn@toonn.io> | 2019-05-17 23:52:20 +0200 |
---|---|---|
committer | toonn <toonn@toonn.io> | 2019-05-18 15:30:04 +0200 |
commit | 3a53433445febb668b19d272f7776b57fa2661fb (patch) | |
tree | 6bac156e2b1ea32a76115cf72339575f4c769da8 /doc/ranger.1 | |
parent | f68f1d9a3b58d7c52dfd689adad594c2c7bcf1eb (diff) | |
download | ranger-3a53433445febb668b19d272f7776b57fa2661fb.tar.gz |
Add missing documentation for syntax highlighting
`HIGHLIGHT_STYLE`, `HIGHLIGHT_OPTIONS` and `PYGMENTIZE_STYLE` affect ranger and should therefore be documented in the manual.
Diffstat (limited to 'doc/ranger.1')
-rw-r--r-- | doc/ranger.1 | 54 |
1 files changed, 43 insertions, 11 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1 index 43a13659..69109cf2 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,16 +54,20 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.if !\nF .nr F 0 -.if \nF>0 \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{\ -. nr % 0 -. nr F 2 +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} . \} .\} +.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.9.2" "2019-04-23" "ranger manual" +.TH RANGER 1 "ranger-1.9.2" "2019-05-17" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -169,7 +173,7 @@ plugins, sample configuration files and some programs for integrating ranger with other software. They are usually installed to \&\fI/usr/share/doc/ranger/examples\fR. .PP -The man page of \fIrifle\fR\|(1) describes the functions of the file opener +The man page of \fBrifle\fR\|(1) describes the functions of the file opener .PP The section \fI\s-1LINKS\s0\fR of this man page contains further resources. .SH "POSITIONAL ARGUMENTS" @@ -1630,6 +1634,34 @@ 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-1PYGMENTIZE_STYLE\s0" 8 +.IX Item "PYGMENTIZE_STYLE" +Specifies the theme to be used for syntax highlighting when \fIpygmentize\fR is +installed unless \fIhighlight\fR is also installed, possible values (find out by +running \f(CW\*(C`pygments.styles.get_all_styles()\*(C'\fR): abap, algol, algol_nu, arduino, +autumn, borland, bw, colorful, emacs, friendly, fruity, igor, lovelace, manni, +monokai, murphy, native, paraiso-dark, paraiso-light, pastie, perldoc, +rainbow_dash, rrt, tango, trac, vim, vs and xcode. +.IP "\s-1HIGHLIGHT_STYLE\s0" 8 +.IX Item "HIGHLIGHT_STYLE" +Specifies the theme to be used for syntax highlighting when \fIhighlight\fR is +installed, possible values (find out by running \f(CW\*(C`highlight \-\-list\-themes\*(C'\fR): +acid, aiseered, andes, anotherdark, autumn, baycomb, bclear, biogoo, bipolar, +blacknblue, bluegreen, breeze, bright, camo, candy, clarity, dante, darkblue, +darkbone, darkness, darkslategray, darkspectrum, denim, dusk, earendel, easter, +edit-anjuta, edit-bbedit, edit-eclipse, edit-emacs, edit-fasm, +edit-flashdevelop, edit-gedit, edit-godot, edit-jedit, edit-kwrite, +edit-matlab, edit\-msvs2008, edit-nedit, edit-purebasic, edit-vim, +edit-vim-dark, edit-xcode, ekvoli, fine_blue, freya, fruit, github, golden, +greenlcd, kellys, leo, lucretia, manxome, maroloccio, matrix, moe, molokai, +moria, navajo-night, navy, neon, night, nightshimmer, nuvola, olive, orion, +oxygenated, pablo, peaksea, print, rand01, rdark, relaxedgreen, rootwater, +seashell, solarized-dark, solarized-light, sourceforge, tabula, tcsoft, the, +vampire, whitengrey, xoria256, zellner, zenburn and zmrok. +.IP "\s-1HIGHLIGHT_OPTIONS\s0" 8 +.IX Item "HIGHLIGHT_OPTIONS" +\&\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. .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. @@ -1676,7 +1708,7 @@ copy, run: .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fIrifle\fR\|(1) +\&\fBrifle\fR\|(1) .SH "BUGS" .IX Header "BUGS" Report bugs here: <https://github.com/ranger/ranger/issues> |