summaryrefslogtreecommitdiff
path: root/plugins/scd/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/scd/README.md')
-rw-r--r--plugins/scd/README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/plugins/scd/README.md b/plugins/scd/README.md
index 197cea50a..86ab67203 100644
--- a/plugins/scd/README.md
+++ b/plugins/scd/README.md
@@ -11,12 +11,9 @@ the index. A selection menu is displayed in case of several matches, with a
preference given to recently visited paths. `scd` can create permanent
directory aliases, which appear as named directories in zsh session.
-## INSTALLATION
+## INSTALLATION NOTES
-For oh-my-zsh, add `scd` to the `plugins` array in the ~/.zshrc file as in the
-[template file](../../templates/zshrc.zsh-template#L45).
-
-Besides zsh, `scd` can be used with *bash*, *dash* or *tcsh*
+Besides oh-my-zsh, `scd` can be used with *bash*, *dash* or *tcsh*
shells and is also available as [Vim](http://www.vim.org/) plugin and
[IPython](http://ipython.org/) extension. For installation details, see
https://github.com/pavoljuhas/smart-change-directory.
@@ -34,7 +31,7 @@ scd [options] [pattern1 pattern2 ...]
add specified directories to the directory index.</dd><dt>
--unindex</dt><dd>
- remove specified directories from the index.</dd><dt>
+ remove current or specified directories from the index.</dd><dt>
-r, --recursive</dt><dd>
apply options <em>--add</em> or <em>--unindex</em> recursively.</dd><dt>
@@ -47,6 +44,10 @@ scd [options] [pattern1 pattern2 ...]
remove ALIAS definition for the current or specified directory from
<em>~/.scdalias.zsh</em>.</dd><dt>
+-A, --all</dt><dd>
+ include all matching directories. Disregard matching by directory
+ alias and filtering of less likely paths.</dd><dt>
+
--list</dt><dd>
show matching directories and exit.</dd><dt>
@@ -70,7 +71,7 @@ scd doc
scd a b c
# Change to a directory path that ends with "ts"
-scd "ts(#e)"
+scd "ts$"
# Show selection menu and ranking of 20 most likely directories
scd -v