diff options
author | Pavol Juhas <pavol.juhas@gmail.com> | 2020-08-27 00:44:25 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-08-27 09:44:25 +0200 |
commit | 8d08f1634a7b9782e3722ce770e8630f569afe3f (patch) | |
tree | e3af0b590afac65cd81e6bc416c70989e9fa0843 /plugins/scd/README.md | |
parent | cfb86cd08d3b24fd4b59d0d35b3af1f589c891fa (diff) | |
download | zsh-8d08f1634a7b9782e3722ce770e8630f569afe3f.tar.gz zsh-8d08f1634a7b9782e3722ce770e8630f569afe3f.tar.bz2 zsh-8d08f1634a7b9782e3722ce770e8630f569afe3f.zip |
scd: update to 1.4.0 (#9066)
Diffstat (limited to 'plugins/scd/README.md')
-rw-r--r-- | plugins/scd/README.md | 54 |
1 files changed, 45 insertions, 9 deletions
diff --git a/plugins/scd/README.md b/plugins/scd/README.md index 8c156da1f..d8535f9f2 100644 --- a/plugins/scd/README.md +++ b/plugins/scd/README.md @@ -14,8 +14,9 @@ directory aliases, which appear as named directories in zsh session. ## INSTALLATION NOTES Besides oh-my-zsh, `scd` can be used with *bash*, *dash* or *tcsh* -shells and is also available as [Vim](https://www.vim.org/) plugin and -[IPython](https://ipython.org/) extension. For installation details, see +shells and is also available as Vim plugin +[scd.vim](https://github.com/pavoljuhas/scd.vim) and +[IPython](https://ipython.org) extension. For installation details, see https://github.com/pavoljuhas/smart-change-directory. ## SYNOPSIS @@ -24,11 +25,31 @@ https://github.com/pavoljuhas/smart-change-directory. scd [options] [pattern1 pattern2 ...] ``` +## PATTERNS + +Patterns may use all zsh [glob operators]( +http://zsh.sourceforge.net/Doc/Release/Expansion.html#Glob-Operators) +available with *extendedglob* option. Specified patterns must match +the absolute path and at least one of them must match in the tail. +Several special patterns are also recognized as follows: + +<dl><dt> +^PAT</dt><dd> + PAT must match at the beginning of the path, for example, "^/home"</dd><dt> +PAT$</dt><dd> + require PAT to match the end of the path, "man$"</dd><dt> +./</dt><dd> + match only subdirectories of the current directory</dd><dt> +:PAT</dt><dd> + require PAT to match over the tail component, ":doc", ":re/doc"</dd> +</dl> + + ## OPTIONS <dl><dt> -a, --add</dt><dd> - add specified directories to the directory index.</dd><dt> + add current or specified directories to the directory index.</dd><dt> --unindex</dt><dd> remove current or specified directories from the index.</dd><dt> @@ -42,11 +63,16 @@ scd [options] [pattern1 pattern2 ...] --unalias</dt><dd> remove ALIAS definition for the current or specified directory from - <em>~/.scdalias.zsh</em>.</dd><dt> + <em>~/.scdalias.zsh</em>. Use "OLD" to purge aliases to non-existent + directories.</dd><dt> -A, --all</dt><dd> - include all matching directories. Disregard matching by directory - alias and filtering of less likely paths.</dd><dt> + display all directories even those excluded by patterns in + <em>~/.scdignore</em>. Disregard the unique matching for a + directory alias and filtering of less likely paths.</dd><dt> + +-p, --push</dt><dd> + use "pushd" to change to the target directory.</dd><dt> --list</dt><dd> show matching directories and exit.</dd><dt> @@ -58,6 +84,7 @@ scd [options] [pattern1 pattern2 ...] display this options summary and exit.</dd> </dl> + ## Examples ```sh @@ -83,17 +110,26 @@ scd --alias=xray scd xray ``` -# FILES +## FILES <dl><dt> ~/.scdhistory</dt><dd> time-stamped index of visited directories.</dd><dt> ~/.scdalias.zsh</dt><dd> - scd-generated definitions of directory aliases.</dd> + scd-generated definitions of directory aliases.</dd><dt> + +~/.scdignore</dt><dd> + <a href="http://zsh.sourceforge.net/Doc/Release/Expansion.html#Glob-Operators"> + glob patterns</a> for paths to be ignored in the scd search, for example, + <code>/mnt/backup/*</code>. The patterns are specified one per line + and are matched assuming the <em>extendedglob</em> zsh option. Lines + starting with "#" are skipped as comments. The .scdignore patterns + are not applied in the <em>--all</em> mode.</dd> </dl> -# ENVIRONMENT + +## ENVIRONMENT <dl><dt> SCD_HISTFILE</dt><dd> |