From d1b2a79807bcc64ce8d8a38b2960a465d9bc8001 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 16 Apr 2013 13:18:29 -0700 Subject: [PATCH 1/5] docs: hide chart/vty, update add-ons description --- MANUAL.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/MANUAL.md b/MANUAL.md index 214e6763e..e40b21f0d 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -741,9 +741,14 @@ Examples: ### Add-ons -The following extra commands will be available if they have been -[installed](INSTALL.html) (run `hledger --help` to find out). Some of -these add-on packages may be out of date or may not work on all platforms. +Add-on packages are usually named `hledger-SOMETHING` and provide one +or more `hledger-*` executables. These can be run directly, or via +the `hledger` command. Eg `hledger --help` will list any installed add-ons, +and `hledger web` will run `hledger-web` if it is installed. + +Here are some current add-ons. Note hledger-web is released along with +hledger and supported on all the major platforms, while other add-ons +may or may not be. #### web @@ -802,6 +807,8 @@ fees, or cost), it calculates the hypothetical annual rate of fixed rate investment that would have provided the exact same cash flow. See the package page for more. + + ## Reporting options From 75cb026f7e37444449ef1b2a4f8b6ec3f7eb184f Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 16 Apr 2013 13:23:40 -0700 Subject: [PATCH 2/5] docs: more add-ons tweaks --- MANUAL.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/MANUAL.md b/MANUAL.md index 2ec2298f4..f5ac75858 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -743,8 +743,9 @@ Examples: Add-on packages are usually named `hledger-SOMETHING` and provide one or more `hledger-*` executables. These can be run directly, or via -the `hledger` command. Eg `hledger --help` will list any installed add-ons, -and `hledger web` will run `hledger-web` if it is installed. +the `hledger` command (eg `hledger web` will run `hledger-web`). +`hledger --help` will list any installed add-ons (or any hledger-* +executable in your PATH). Here are some current add-ons. Note hledger-web is released along with hledger and supported on all the major platforms, while other add-ons @@ -752,7 +753,7 @@ may or may not be. #### web -The web command (provided by the hledger-web package) runs a web +The web command (provided by the [hledger-web](http://hackage.haskell.org/package/hledger-web) package) runs a web server providing a web-based user interface ([demo](http://demo.hledger.org)). The web UI provides reporting, including a more useful account register view, and also basic data entry and editing. From 89cea30f207e5e563905164ae03aeb0efa1c5877 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 16 Apr 2013 13:32:30 -0700 Subject: [PATCH 3/5] docs: add-ons, still --- MANUAL.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/MANUAL.md b/MANUAL.md index f5ac75858..d21943b19 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -742,14 +742,13 @@ Examples: ### Add-ons Add-on packages are usually named `hledger-SOMETHING` and provide one -or more `hledger-*` executables. These can be run directly, or via -the `hledger` command (eg `hledger web` will run `hledger-web`). -`hledger --help` will list any installed add-ons (or any hledger-* -executable in your PATH). +or more `hledger-*` executables. hledger will detect these +(or any `hledger-*` executable in your PATH) and offer +them as extra commands; use `hledger --help` to see a list. -Here are some current add-ons. Note hledger-web is released along with -hledger and supported on all the major platforms, while other add-ons -may or may not be. +Here are some current add-ons. +hledger-web is released along with hledger and supported on all the +major platforms, while other add-ons may or may not be. #### web From 5cf6e02f8e02b216e6f12c6021ed29da10404cfa Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 16 Apr 2013 13:45:49 -0700 Subject: [PATCH 4/5] docs: update commands intro --- MANUAL.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/MANUAL.md b/MANUAL.md index d21943b19..3654a97d3 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -542,10 +542,12 @@ To generate time logs, ie to clock in and clock out, you could: ## Commands -hledger provides a number of subcommands; run `hledger` with no arguments to see a list. -Most subcommands are built in to the core hledger package; -more [add-on commands](#add-on-commands) will appear if you install additional `hledger-*` packages. -You can also install your own subcommands by putting programs or scripts named `hledger-NAME` in your PATH. +hledger provides a number of subcommands out of the box; run `hledger` with no arguments to see a list. +More [add-on commands](#add-ons) will appear if you install additional `hledger-*` packages, +or if you put programs or scripts named `hledger-NAME` in your PATH. + +To run a command, you just need to type its unique prefix, eg `hledger reg` is a shortcut for `hledger register`. +(Also, `hledger bs` is short for `hledger balancesheet`.) ### Data entry From 4edbb5a58969cc8b51671cde0400d405abed89b3 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 16 Apr 2013 14:00:57 -0700 Subject: [PATCH 5/5] docs: reporting opts -> common opts, update query intro --- MANUAL.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/MANUAL.md b/MANUAL.md index 3654a97d3..e2c2cfc6d 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -865,21 +865,20 @@ Examples: --> -## Reporting options +## Common options -Part of hledger's usefulness is being able to report on just a precise -subset of your data. The following common features and options work -with most subcommands, allowing you to specify search criteria and -adjust the output. +The following common features and options work with most subcommands. ### Queries -Most commands accept an optional query expression, written as arguments -after the command name, to filter the data (or in some cases, to modify -the output). The syntax is similar to a Google search expression: one or +Part of hledger's usefulness is being able to report on just a precise subset of your data. +Most commands accept an optional query expression, written as arguments after the command name, +to filter the data by date, account name or other criteria. + +The query syntax is similar to a Google search expression: one or more space-separated search terms, optional prefixes to match specific -fields, quotes to enclose whitespace etc. Each query term can be any of -the following: +fields, quotes to enclose whitespace, etc. +A query term can be any of the following: - `REGEX` - match account names by this regular expression - `acct:REGEX` - same as above