Blame view

repos/robbyrussell/oh-my-zsh/plugins/shrink-path/README.md 1.58 KB
d9bebbb3c   mj   Squashed 'repos/r...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
  # A plugin to shrink directory paths for brevity and pretty-printing
  
  
  ## Examples
  
  For this directory tree:
  ```
      /home/
        me/
          foo/
            bar/
              quux/
            biz/     # The prefix b is ambiguous between bar and biz.
  ```
  here are the results of calling `shrink_path <option> /home/me/foo/bar/quux`:
  ```
      Option        Result
      <none>        /h/m/f/ba/q
      -l|--last     /h/m/f/ba/quux
      -s|--short    /h/m/f/b/q
      -t|--tilde    ~/f/ba/q
      -f|--fish     ~/f/b/quux
  ```
  
  
  ## Usage
  
  For a fish-style working directory in your command prompt, add the following to
  your theme or zshrc:
  
  ```
      setopt prompt_subst
      PS1='%n@%m $(shrink_path -f)>'
  ```
  
  The following options are available:
  
  ```
      -f, --fish       fish simulation, equivalent to -l -s -t.
      -l, --last       Print the last directory's full name.
      -s, --short      Truncate directory names to the first character. Without
                       -s, names are truncated without making them ambiguous.
      -t, --tilde      Substitute ~ for the home directory.
      -T, --nameddirs  Substitute named directories as well.
  ```
  
  The long options can also be set via zstyle, like
  ```
      zstyle :prompt:shrink_path fish yes
  ```
  
  Note: Directory names containing two or more consecutive spaces are not yet
  supported.
  
  
  ## License
  
  Copyright (C) 2008 by Daniel Friesel <derf@xxxxxxxxxxxxxxxxxx>
  
  License: WTFPL <http://sam.zoy.org/wtfpl>
  
  Ref: http://www.zsh.org/mla/workers/2009/msg00415.html
       http://www.zsh.org/mla/workers/2009/msg00419.html
  
  
  ## Misc
  
  Keywords: prompt directory truncate shrink collapse fish