summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authornfnty <git@nfnty.se>2017-02-05 21:19:41 +0100
committernfnty <git@nfnty.se>2017-02-05 21:22:05 +0100
commitf7199d8e235bb033353da3b1274233b21fd6207f (patch)
treec864b9c4f55e483bd6f1c5ec7114bffbfe1357e5 /doc
parent24dd1af4f0bd05ad781e0f79723df2b07cb70218 (diff)
downloadranger-f7199d8e235bb033353da3b1274233b21fd6207f.tar.gz
Add `$XDG_DATA_HOME` support
Fixes #303
Fixes #448
Diffstat (limited to 'doc')
-rw-r--r--doc/ranger.113
-rw-r--r--doc/ranger.pod15
2 files changed, 24 insertions, 4 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1
index 193351d6..16abc635 100644
--- a/doc/ranger.1
+++ b/doc/ranger.1
@@ -139,7 +139,8 @@ ranger \- visual file manager
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 \&\fBranger\fR [\fB\-\-version\fR] [\fB\-\-help\fR] [\fB\-\-debug\fR] [\fB\-\-clean\fR]
-[\fB\-\-confdir\fR=\fIdirectory\fR] [\fB\-\-copy\-config\fR=\fIwhich\fR]
+[\fB\-\-cachedir\fR=\fIdirectory\fR] [\fB\-\-confdir\fR=\fIdirectory\fR] [\fB\-\-datadir\fR=\fIdirectory\fR]
+[\fB\-\-copy\-config\fR=\fIwhich\fR]
 [\fB\-\-choosefile\fR=\fItarget\fR] [\fB\-\-choosefiles\fR=\fItarget\fR]
 [\fB\-\-choosedir\fR=\fItarget\fR] [\fB\-\-selectfile\fR=\fIfilepath\fR]
 [\fB\-\-list\-unused\-keys\fR] [\fB\-\-list\-tagged\-files\fR=\fItag\fR]
@@ -182,9 +183,15 @@ exception in the statusbar/log and try to keep running.
 Activate the clean mode:  ranger will not access or create any configuration
 files nor will it leave any traces on your system.  This is useful when your
 configuration is broken, when you want to avoid clutter, etc.
+.IP "\fB\-\-cachedir\fR=\fIdir\fR" 14
+.IX Item "--cachedir=dir"
+Change the cache directory of ranger from \f(CW$XDG_CACHE_HOME\fR or ~/.cache/ranger to \*(L"dir\*(R".
 .IP "\fB\-r\fR \fIdir\fR, \fB\-\-confdir\fR=\fIdir\fR" 14
 .IX Item "-r dir, --confdir=dir"
-Change the configuration directory of ranger from ~/.config/ranger to \*(L"dir\*(R".
+Change the configuration directory of ranger from \f(CW$XDG_CONFIG_HOME\fR or ~/.config/ranger to \*(L"dir\*(R".
+.IP "\fB\-\-datadir\fR=\fIdir\fR" 14
+.IX Item "--datadir=dir"
+Change the data directory of ranger from \f(CW$XDG_DATA_HOME\fR or ~/.local/share/ranger to \*(L"dir\*(R".
 .IP "\fB\-\-copy\-config\fR=\fIfile\fR" 14
 .IX Item "--copy-config=file"
 Create copies of the default configuration files in your local configuration
@@ -348,6 +355,8 @@ can use it for something like this command:
 .PP
 \&\f(CW%confdir\fR expands to the directory given by \fB\-\-confdir\fR.
 .PP
+\&\f(CW%datadir\fR expands to the directory given by \fB\-\-datadir\fR.
+.PP
 The macro \f(CW%space\fR expands to a space character. You can use it to add spaces to
 the end of a command when needed, while preventing editors to strip spaces off
 the end of the line automatically.
diff --git a/doc/ranger.pod b/doc/ranger.pod
index f11c5964..f77a6030 100644
--- a/doc/ranger.pod
+++ b/doc/ranger.pod
@@ -8,7 +8,8 @@ ranger - visual file manager
 =head1 SYNOPSIS
 
 B<ranger> [B<--version>] [B<--help>] [B<--debug>] [B<--clean>]
-[B<--confdir>=I<directory>] [B<--copy-config>=I<which>]
+[B<--cachedir>=I<directory>] [B<--confdir>=I<directory>] [B<--datadir>=I<directory>]
+[B<--copy-config>=I<which>]
 [B<--choosefile>=I<target>] [B<--choosefiles>=I<target>]
 [B<--choosedir>=I<target>] [B<--selectfile>=I<filepath>]
 [B<--list-unused-keys>] [B<--list-tagged-files>=I<tag>]
@@ -67,9 +68,17 @@ Activate the clean mode:  ranger will not access or create any configuration
 files nor will it leave any traces on your system.  This is useful when your
 configuration is broken, when you want to avoid clutter, etc.
 
+=item B<--cachedir>=I<dir>
+
+Change the cache directory of ranger from $XDG_CACHE_HOME or ~/.cache/ranger to "dir".
+
 =item B<-r> I<dir>, B<--confdir>=I<dir>
 
-Change the configuration directory of ranger from ~/.config/ranger to "dir".
+Change the configuration directory of ranger from $XDG_CONFIG_HOME or ~/.config/ranger to "dir".
+
+=item B<--datadir>=I<dir>
+
+Change the data directory of ranger from $XDG_DATA_HOME or ~/.local/share/ranger to "dir".
 
 =item B<--copy-config>=I<file>
 
@@ -246,6 +255,8 @@ can use it for something like this command:
 
 %confdir expands to the directory given by B<--confdir>.
 
+%datadir expands to the directory given by B<--datadir>.
+
 The macro %space expands to a space character. You can use it to add spaces to
 the end of a command when needed, while preventing editors to strip spaces off
 the end of the line automatically.