a4c5a71394ac

hg-prompt: Update documentation.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Fri, 08 Jan 2010 20:11:40 -0500
parents 825cda6146fa
children 82488ceb5054
branches/tags (none)
files hg-prompt/documentation/usage/index.html

Changes

--- 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 @@
       
       
   <h1 id="usage">Usage</h1>
-<p>The <code>hg prompt</code> command takes a single string as an argument and outputs it.  Here's a simple (and useless) example:</p>
+<p>The <code>hg prompt</code> command takes a single string as an argument and outputs it.
+Here's a simple (and useless) example:</p>
 <div class="codehilite"><pre><span class="gp">$</span> hg prompt <span class="s2">&quot;test&quot;</span>
 <span class="go">test</span>
 </pre></div>
@@ -62,7 +63,9 @@
 </pre></div>
 
 
-<p>This form will output the text and the expanded keyword <strong>only</strong> if the keyword successfully expands.  This can be useful for displaying extra text only if it's applicable:</p>
+<p>This form will output the text and the expanded keyword <strong>only</strong> if the
+keyword successfully expands. This can be useful for displaying extra text
+only if it's applicable:</p>
 <div class="codehilite"><pre><span class="gp">$</span> hg prompt <span class="s2">&quot;currently on {branch} and at {bookmark}&quot;</span>
 <span class="go">currently on branch default and at</span>
 
@@ -76,7 +79,20 @@
 </pre></div>
 
 
-<p>Take a look at the <a href="../keywords/">keywords</a> documentation to see all the keywords <code>hg-prompt</code> supports.</p>
+<p>You can give the <code>--angle-brackets</code> 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):</p>
+<div class="codehilite"><pre><span class="gp">$</span> hg prompt <span class="s2">&quot;{currently on {branch}}&quot;</span>
+<span class="go">currently on default</span>
+
+<span class="gp">$</span> hg prompt --angle-brackets <span class="s2">&quot;&lt;currently on &lt;branch&gt;&gt;&quot;</span>
+<span class="go">currently on default</span>
+</pre></div>
+
+
+<p>Take a look at the <a href="../keywords/">keywords</a> documentation to see all the keywords
+<code>hg-prompt</code> supports.</p>
 
     
       <p id="footer">