diff options
| author | Abdo Roig-Maranges <abdo.roig@gmail.com> | 2013-02-17 18:31:29 +0100 |
|---|---|---|
| committer | hut <hut@lavabit.com> | 2013-02-17 19:00:32 +0100 |
| commit | 95bca173ce92294f31c052555b78938626f3c120 (patch) | |
| tree | e03ce17ab651aa60932a5ab12183b8fc1fc32b8d /doc | |
| parent | 4fc4f85607b27df380184395f65161363db748f8 (diff) | |
| download | ranger-95bca173ce92294f31c052555b78938626f3c120.tar.gz | |
document config options for vcs on the man page
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ranger.1 | 15 | ||||
| -rw-r--r-- | doc/ranger.pod | 9 |
2 files changed, 16 insertions, 8 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1 index 2a8caf47..acaca462 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -124,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.5.5" "02/10/2013" "ranger manual" +.TH RANGER 1 "ranger-1.5.5" "02/17/2013" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -687,10 +687,15 @@ Use the preview script defined in the setting \fIpreview_script\fR? .IP "vcs_aware [bool]" 4 .IX Item "vcs_aware [bool]" Gather and display data about version control systems. Supported vcs: git, hg. -.IP "vcs_backends [list]" 4 -.IX Item "vcs_backends [list]" -List of vcs backends to use. By default it is ['git', 'hg'], but can be set to -handle only 'git' repositories, for example. +.IP "vcs_backend_git, vcs_backend_hg, vcs_backend_bzr [string]" 4 +.IX Item "vcs_backend_git, vcs_backend_hg, vcs_backend_bzr [string]" +Sets the state for the version control backend. The possible values are: +.Sp +.Vb 3 +\& disabled don\*(Aqt display any information. +\& local display only local state. +\& enabled display both, local and remote state. May be slow for hg and bzr. +.Ve .IP "xterm_alt_key [bool]" 4 .IX Item "xterm_alt_key [bool]" Enable this if key combinations with the Alt Key don't work for you. diff --git a/doc/ranger.pod b/doc/ranger.pod index c388aaf7..246dd4ab 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -694,10 +694,13 @@ Use the preview script defined in the setting I<preview_script>? Gather and display data about version control systems. Supported vcs: git, hg. -=item vcs_backends [list] +=item vcs_backend_git, vcs_backend_hg, vcs_backend_bzr [string] -List of vcs backends to use. By default it is ['git', 'hg'], but can be set to -handle only 'git' repositories, for example. +Sets the state for the version control backend. The possible values are: + + disabled don't display any information. + local display only local state. + enabled display both, local and remote state. May be slow for hg and bzr. =item xterm_alt_key [bool] |