# HG changeset patch # User Steve Losh # Date 1262999500 18000 # Node ID a4c5a71394acd20a6c269dc9be3527791573afc9 # Parent 825cda6146fa19a01515d08a5bf15f19158bb316 hg-prompt: Update documentation. diff -r 825cda6146fa -r a4c5a71394ac hg-prompt/documentation/usage/index.html --- a/hg-prompt/documentation/usage/index.html Tue Dec 15 21:14:48 2009 -0500 +++ b/hg-prompt/documentation/usage/index.html Fri Jan 08 20:11:40 2010 -0500 @@ -45,7 +45,8 @@

Usage

-

The hg prompt command takes a single string as an argument and outputs it. Here's a simple (and useless) example:

+

The hg prompt command takes a single string as an argument and outputs it. +Here's a simple (and useless) example:

$ hg prompt "test"
 test
 
@@ -62,7 +63,9 @@ -

This form will output the text and the expanded keyword only if the keyword successfully expands. This can be useful for displaying extra text only if it's applicable:

+

This form will output the text and the expanded keyword only if the +keyword successfully expands. This can be useful for displaying extra text +only if it's applicable:

$ hg prompt "currently on {branch} and at {bookmark}"
 currently on branch default and at
 
@@ -76,7 +79,20 @@
 
-

Take a look at the keywords documentation to see all the keywords hg-prompt supports.

+

You can give the --angle-brackets option to use angle brackets for keywords +instead of curly brackets. This can come in handy when combining a simple +prompt string with more complicated shell functionality (like color +variables):

+
$ hg prompt "{currently on {branch}}"
+currently on default
+
+$ hg prompt --angle-brackets "<currently on <branch>>"
+currently on default
+
+ + +

Take a look at the keywords documentation to see all the keywords +hg-prompt supports.