Commits

Greg Ward committed d70e0df

Update docs for 1.1 release

  • Participants
  • Parent commits fe96783
  • Tags 1.1

Comments (0)

Files changed (2)

 vcprompt
 ========
 
-vcprompt is a little C program that prints a short string, designed to
-be included in your prompt, with barebones information about the
+vcprompt is a little C program that prints a short string, to be
+included in your shell prompt, with barebones information about the
 current working directory for various version control systems. It is
 designed to be small and lightweight rather than comprehensive.
 
 
   make install PREFIX=$HOME
 
+To make life easier for packagers, the Makefile also supports DESTDIR:
+
+  make install DESTDIR=/tmp/packageroot PREFIX=/usr
+
+
+Configuration
+=============
+
+(For more details, see the man page.)
+
 To use it with bash, just call it in PS1:
 
   PS1='\u@\h $(vcprompt)\$ '
   setopt prompt_subst
   PROMPT='[%n@%m] [%~] $(vcprompt)'
 
-vcprompt prints nothing if the current directory is not managed by a
-recognized VC system.
-
 
 Format Strings
 ==============
 
 All other characters are expanded as-is.
 
-The default format string is
-
-  [%n:%b]
-
-which is notable because it works with every supported VC system. In
-fact, some features are meaningless with some systems: there is no
-single current revision with CVS, for example. (And there is no good
-way to quickly find out if there are any uncommitted changes or
-unknown files, for that matter.)
+(For more details, see the man page.)
 
 
 Contributing
   Armin Ronacher
   Jordi Fita
   Gregg Lind
+  Jakob Kramer
 
 Thanks to all!
 
 dir. Slow.
 .TP
 .B %m
-a single "+" if there are any uncommitted changes (modified, added, or
+A single "+" if there are any uncommitted changes (modified, added, or
 removed files) in the working dir. Slow.
 .TP
 .B %%
 is supported by running "git diff --no-ext-diff --quiet --exit-code",
 so it can be expensive in a large working dir.
 
-The timeout (-t) option is useful to prevent
-.B vcprompt
-from taking too long in large working dirs.
-
 .SH MERCURIAL (HG) SUPPORT
 
 .B vcprompt
 displays the branch as "trunk".
 .B vcprompt
 looks only in the current dir, not in any subdirectories, so it will
-not notice mixed-branch working dirs.
+not detect mixed-branch working dirs.
 
 Format specifier
 .B %r
 .nf
 .in +2m
 if [ "$PS1" ]; then
-  PS1='\u@\h $(vcprompt -f "[%b]")\$ '
+  PS1='\\u@\\h $(vcprompt -f "[%b]")\$ '
 fi
 .in -2m
 .fi