1. Summarise the issue (what were doing, what went wrong?)
I find "darcs help manpage" and "darcs help markdown" to be useful, but
they are not documented.
2. What behaviour were you expecting instead?
I expect "darcs help --help" to list these options, and likely "darcs
help" to. The docs should exclude example syntaxes to use to read the
file:
# read the docs as a manpage
darcs help manpage | man -l -
# read the docs as HTML with a console based browser.
darcs help markdown | markdown | w3m -T text/html
It would also be nice to provide an example of how it might be used on a
desktop, where a GUI web-browser is launched to display the HTML docs.
Finally, this could be a separate "issue" but "darcs help" should also
mention the wiki which is a great additional source of documentation.
Currently it pessimistically links to the bug tracker, but not the wiki.
3. What darcs version are you using? (Try: darcs --exact-version)
2.9.7 (+ 86 patches)
|