simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-11-09 00:15:48 +03:00
Code Issues Projects Releases Wiki Activity

docs: manual updates

Browse Source
This commit is contained in:
Simon Michael 2010-12-06 01:51:27 +00:00
parent 5c15344f93
commit 8b16a9ce06
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
MANUAL.markdown
View File

@ -46,7 +46,7 @@ the hledger command-line tool:
$ cabal update $ cabal update
$ cabal install hledger $ cabal install hledger
You can also install these optional [add-on packages](#add-on-commands) You can also build (or download) these optional [add-ons](#add-on-commands)
providing extra features: providing extra features:
$ cabal install hledger-web $ cabal install hledger-web
@ -61,7 +61,7 @@ Or, you can build the latest [development version](DEVELOPMENT.html):
$ make install $ make install
If you have any trouble, please see [Troubleshooting](#troubleshooting) If you have any trouble, please see [Troubleshooting](#troubleshooting)
and/or seek [Support](DEVELOPMENT.html#support). and seek [Support](DEVELOPMENT.html#support).
## Usage ## Usage
@ -479,12 +479,12 @@ Examples:
#### Add-on commands #### Add-on commands
The following extra commands will be available if they have been The following extra commands will be available if they have been
[installed](#installing). Note, currently you must invoke them like, eg, [installed](#installing). Add-ons may differ from hledger core in their
`$ hledger-web ...` - not `$ hledger web ...`. The hledger-NAME level of support and maturity and may not be available on all platforms;
executables support the usual hledger options, and possible specific if available, they are provided on the download page. Note currently you
options of their own. Add-ons may have varying levels of support and must invoke add-on commands like, eg: `$ hledger-web ...`, not `$ hledger
maturity and may not be available on all platforms - if available, they web ...`. The hledger-NAME executables support the usual hledger options,
are provided on the download page. and any specific options of their own.
##### chart ##### chart
@ -519,10 +519,10 @@ Examples:
*Not available on microsoft windows, except possibly via cygwin.* *Not available on microsoft windows, except possibly via cygwin.*
The vty command starts a simple curses-style (full-screen, text) user interface, The vty command starts a simple curses-style (full-screen, text) user
which allows interactive navigation of the print/register/balance interface, which allows interactive navigation of the
reports. This lets you browse around your numbers and get quick insights print/register/balance reports. This lets you browse around and explore
with less typing. your numbers quickly with less typing.
Examples: Examples:
@ -532,7 +532,6 @@ Examples:
##### web ##### web
*Requires GHC 6.12 or greater.* *Requires GHC 6.12 or greater.*
*This command can edit or overwrite your journal file.* *This command can edit or overwrite your journal file.*
The web command starts a web server providing a web-based user interface, The web command starts a web server providing a web-based user interface,