aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 46f5e3d..af0da43 100644
--- a/README.md
+++ b/README.md
@@ -157,6 +157,20 @@ the history.
LRU mode keeps duplicate directories out of the history and while
promoting recently used directories toward the top.
+## Alternative Session Directory
+
+By default, `cdlog` keeps the session recovery files in your home
+directory. They have numbered names like `.cdlog.1.dirs`.
+The variable `cdlog_sess_dir` may be assigned a directory path
+to specify an alternative directory. This path should omit the
+trailing slash. If the variable is empty, it denotes the
+root directory. If the directory doesn't exist, `cdlog` will try
+to create it. The main use for this configuration is to support
+the situation when a home directory is shared among multiple
+host machines with different environments. You can interpolate the
+value of `$HOSTNAME` into `cdlog_sess_dir` to have sessions specific
+to a host.
+
## Completion
`cdlog` provides its own Tab completion for the `cd` command, overriding