docs/wiki/documentation/usage/index.mdown @ 187b25ff6e1a
Update the docs to work with the new version of Markdoc.
author |
Steve Losh <steve@stevelosh.com> |
date |
Tue, 15 Dec 2009 20:42:27 -0500 |
parents |
f9616d40630b |
children |
4568cfa05d21 |
Usage
=====
The `hg prompt` command takes a single string as an argument and outputs it. Here's a simple (and useless) example:
:::console
$ hg prompt "test"
test
Keywords in curly braces can be used to output repository information:
:::console
$ hg prompt "currently on {branch}"
currently on default
Keywords also have an extended form:
:::text
{optional text{branch}more optional text}
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:
:::console
$ hg prompt "currently on {branch} and at {bookmark}"
currently on branch default and at
$ hg prompt "currently on {branch} {and at {bookmark}}"
currently on branch default
$ hg bookmark my-book
$ hg prompt "currently on {branch} {and at {bookmark}}"
currently on branch default and at my-book
Take a look at the [keywords][] documentation to see all the keywords `hg-prompt` supports.
[keywords]: /documentation/keywords/