diff options
author | 2024-03-25 16:43:09 +0530 | |
---|---|---|
committer | 2024-03-25 16:43:09 +0530 | |
commit | a62114c91f2070c8c8453d117f3d81dc113e41ff (patch) | |
tree | f266e87af29a08c01f82bc32dd7d463d8ec4441a /zsh/oh-my-zsh/plugins/shrink-path/README.md | |
parent | af120ab348f2e1a5a39dec035ed9dcf84189a64e (diff) | |
download | dotfiles-a62114c91f2070c8c8453d117f3d81dc113e41ff.tar.gz dotfiles-a62114c91f2070c8c8453d117f3d81dc113e41ff.tar.bz2 dotfiles-a62114c91f2070c8c8453d117f3d81dc113e41ff.zip |
dotfile update
Diffstat (limited to 'zsh/oh-my-zsh/plugins/shrink-path/README.md')
-rw-r--r-- | zsh/oh-my-zsh/plugins/shrink-path/README.md | 116 |
1 files changed, 0 insertions, 116 deletions
diff --git a/zsh/oh-my-zsh/plugins/shrink-path/README.md b/zsh/oh-my-zsh/plugins/shrink-path/README.md deleted file mode 100644 index 71a242b..0000000 --- a/zsh/oh-my-zsh/plugins/shrink-path/README.md +++ /dev/null @@ -1,116 +0,0 @@ -# shrink-path - -A plugin to shrink directory paths for brevity and pretty-printing. - -To use it, add `shrink-path` to the plugins array in your zshrc file: - -```zsh -plugins=(... shrink-path) -``` - -## Examples - -For this directory tree: -``` -/home/ - me/ - f o o/ # The prefix f is ambiguous between "f o o" and "f i g". - bar/ - quux/ - biz/ # The prefix b is ambiguous between bar and biz. - f i g/ - baz/ -``` -here are the results of calling `shrink_path <option> /home/me/foo/bar/quux`: -``` -Option Result -<none> /h/m/f o/ba/q --l|--last /h/m/f o/ba/q --s|--short /h/m/f/b/q --t|--tilde ~/f o/ba/q --f|--fish ~/f/b/quux --g|--glob /h*/m*/f o*/ba*/q* --3 /hom/me/f o/bar/quu --e '$' -3 /hom$/me/f o$/bar/quu$ --q /h/m/f\ o/ba/q --g -q /h*/m*/f\ o*/ba*/q* --x /home/me/foo/bar/quux -``` - -## Usage - -For a fish-style working directory in your command prompt, add the following to -your theme or zshrc: - -```zsh -setopt prompt_subst -PS1='%n@%m $(shrink_path -f)>' -``` - -The following options are available: - -``` - -f, --fish fish simulation, equivalent to -l -s -t. - -g, --glob Add asterisk to allow globbing of shrunk path (equivalent to -e "*") - -l, --last Print the last directory's full name. - -s, --short Truncate directory names to the number of characters given by -. Without - -s, names are truncated without making them ambiguous. - -t, --tilde Substitute ~ for the home directory. - -T, --nameddirs Substitute named directories as well. - -# Truncate each directly to at least this many characters inclusive of the - ellipsis character(s) (defaulting to 1). - -e SYMBOL Postfix symbol(s) to indicate that a directory name had been truncated. - -q, --quote Quote special characters in the shrunk path - -x, --expand Print the full path. This takes precedence over the other options -``` - -The long options can also be set via zstyle, like -```zsh -zstyle :prompt:shrink_path fish yes -``` - -Note: Directory names containing two or more consecutive spaces are not yet -supported. - - -## Trick: toggle shrinking with a keyboard shortcut - -You can use the `expand` option to disable the path shrinking. You can combine that -with a key binding widget to toggle path shrinking on and off. - -```zsh -# Toggle off path shrinking -zstyle ':prompt:shrink_path' expand true -# Toggle on path shrinking -zstyle -d ':prompt:shrink_path' expand -``` - -Combined with a widget: - -```zsh -# Widget definition -shrink-path-toggle() { - zstyle -t ':prompt:shrink_path' expand \ - && zstyle -d ':prompt:shrink_path' expand \ - || zstyle ':prompt:shrink_path' expand true - zle reset-prompt -} -zle -N shrink-path-toggle -# Key binding to ALT+SHIFT+S -bindkey "^[S" shrink-path-toggle -``` - -## License - -Copyright (C) 2008 by Daniel Friesel <derf@xxxxxxxxxxxxxxxxxx> -Copyright (C) 2018-2020 by Pavel N. Krivitsky - -License: WTFPL <http://www.wtfpl.net> - -Ref: https://www.zsh.org/mla/workers/2009/msg00415.html - https://www.zsh.org/mla/workers/2009/msg00419.html - - -## Misc - -Keywords: prompt directory truncate shrink collapse fish |