slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: regenerate files

Browse Source
This commit is contained in:
Simon Michael 2017-03-29 21:08:02 -07:00
parent e8dcef5b5f
commit 586d86488e
9 changed files with 762 additions and 900 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
hledger-ui/doc/hledger-ui.1
View File

@ -191,23 +191,23 @@ most recent applicable market price, if any)
hledger help options: hledger help options:
.TP .TP
.B \f[C]\-h\f[] .B \f[C]\-h\f[]
show general usage (or after COMMAND, the command\[aq]s usage) show general usage (or after COMMAND, command usage)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-help\f[] .B \f[C]\-\-help\f[]
show the current program\[aq]s manual as plain text (or after an add\-on show this program\[aq]s manual as plain text (or after an add\-on
COMMAND, the add\-on\[aq]s manual) COMMAND, the add\-on\[aq]s manual)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-man\f[] .B \f[C]\-\-man\f[]
show the current program\[aq]s manual with man show this program\[aq]s manual with man
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-info\f[] .B \f[C]\-\-info\f[]
show the current program\[aq]s manual with info show this program\[aq]s manual with info
.RS .RS
.RE .RE
.TP .TP

32
hledger-ui/doc/hledger-ui.1.info
View File

@ -135,17 +135,17 @@ the data.
'-h' '-h'
show general usage (or after COMMAND, the command's usage) show general usage (or after COMMAND, command usage)
'--help' '--help'
show the current program's manual as plain text (or after an add-on show this program's manual as plain text (or after an add-on
COMMAND, the add-on's manual) COMMAND, the add-on's manual)
'--man' '--man'
show the current program's manual with man show this program's manual with man
'--info' '--info'
show the current program's manual with info show this program's manual with info
'--version' '--version'
show version show version
@ -357,17 +357,17 @@ Tag Table:
Node: Top73 Node: Top73
Node: OPTIONS825 Node: OPTIONS825
Ref: #options924 Ref: #options924
Node: KEYS3677 Node: KEYS3650
Ref: #keys3774 Ref: #keys3747
Node: SCREENS6362 Node: SCREENS6335
Ref: #screens6449 Ref: #screens6422
Node: Accounts screen6539 Node: Accounts screen6512
Ref: #accounts-screen6669 Ref: #accounts-screen6642
Node: Register screen8718 Node: Register screen8691
Ref: #register-screen8875 Ref: #register-screen8848
Node: Transaction screen10764 Node: Transaction screen10737
Ref: #transaction-screen10924 Ref: #transaction-screen10897
Node: Error screen11794 Node: Error screen11767
Ref: #error-screen11918 Ref: #error-screen11891
 
End Tag Table End Tag Table

10
hledger-ui/doc/hledger-ui.1.txt
View File

@ -129,14 +129,14 @@ OPTIONS
hledger help options: hledger help options:
-h show general usage (or after COMMAND, the command's usage) -h show general usage (or after COMMAND, command usage)
--help show the current program's manual as plain text (or after an --help show this program's manual as plain text (or after an add-on
add-on COMMAND, the add-on's manual) COMMAND, the add-on's manual)
--man show the current program's manual with man --man show this program's manual with man
--info show the current program's manual with info --info show this program's manual with info
--version --version
show version show version

8
hledger-web/doc/hledger-web.1
View File

@ -247,23 +247,23 @@ most recent applicable market price, if any)
hledger help options: hledger help options:
.TP .TP
.B \f[C]\-h\f[] .B \f[C]\-h\f[]
show general usage (or after COMMAND, the command\[aq]s usage) show general usage (or after COMMAND, command usage)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-help\f[] .B \f[C]\-\-help\f[]
show the current program\[aq]s manual as plain text (or after an add\-on show this program\[aq]s manual as plain text (or after an add\-on
COMMAND, the add\-on\[aq]s manual) COMMAND, the add\-on\[aq]s manual)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-man\f[] .B \f[C]\-\-man\f[]
show the current program\[aq]s manual with man show this program\[aq]s manual with man
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-info\f[] .B \f[C]\-\-info\f[]
show the current program\[aq]s manual with info show this program\[aq]s manual with info
.RS .RS
.RE .RE
.TP .TP

8
hledger-web/doc/hledger-web.1.info
View File

@ -180,17 +180,17 @@ options as shown above.
'-h' '-h'
show general usage (or after COMMAND, the command's usage) show general usage (or after COMMAND, command usage)
'--help' '--help'
show the current program's manual as plain text (or after an add-on show this program's manual as plain text (or after an add-on
COMMAND, the add-on's manual) COMMAND, the add-on's manual)
'--man' '--man'
show the current program's manual with man show this program's manual with man
'--info' '--info'
show the current program's manual with info show this program's manual with info
'--version' '--version'
show version show version

10
hledger-web/doc/hledger-web.1.txt
View File

@ -174,14 +174,14 @@ OPTIONS
hledger help options: hledger help options:
-h show general usage (or after COMMAND, the command's usage) -h show general usage (or after COMMAND, command usage)
--help show the current program's manual as plain text (or after an --help show this program's manual as plain text (or after an add-on
add-on COMMAND, the add-on's manual) COMMAND, the add-on's manual)
--man show the current program's manual with man --man show this program's manual with man
--info show the current program's manual with info --info show this program's manual with info
--version --version
show version show version

232
hledger/doc/hledger.1
View File

@ -9,11 +9,15 @@
hledger \- a command\-line accounting tool hledger \- a command\-line accounting tool
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger\ [\-f\ FILE]\ COMMAND\ [OPTIONS]\ [CMDARGS]\f[] \f[C]hledger\ [\-f\ FILE]\ COMMAND\ [OPTIONS]\ [ARGS]\f[]
.PD 0 .PD 0
.P .P
.PD .PD
\f[C]hledger\ [\-f\ FILE]\ ADDONCMD\ \-\-\ [OPTIONS]\ [CMDARGS]\f[] \f[C]hledger\ [\-f\ FILE]\ ADDONCMD\ \-\-\ [OPTIONS]\ [ARGS]\f[]
.PD 0
.P
.PD
\f[C]hledger\f[]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
hledger is a cross\-platform program for tracking money, time, or any hledger is a cross\-platform program for tracking money, time, or any
@ -68,7 +72,7 @@ To get started, you can either save some entries like the above in
prompts. prompts.
Then try some commands like \f[C]hledger\ print\f[] or Then try some commands like \f[C]hledger\ print\f[] or
\f[C]hledger\ balance\f[]. \f[C]hledger\ balance\f[].
See COMMANDS and EXAMPLES below. Run \f[C]hledger\f[] with no arguments for a list of commands.
.SH EXAMPLES .SH EXAMPLES
.PP .PP
Two simple transactions in hledger journal format: Two simple transactions in hledger journal format:
@ -148,80 +152,32 @@ $\ hledger\ activity\ \-W\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ tran
\f[] \f[]
.fi .fi
.SH OPTIONS .SH OPTIONS
.SS General options
.PP .PP
To see general usage help, including general options which are supported To see general usage help, including general options which are supported
by most hledger commands, run \f[C]hledger\ \-h\f[]. by most hledger commands, run \f[C]hledger\ \-h\f[].
(Note \-h and \-\-help are different, like git.) These options can (Note \-h and \-\-help are different, like git.)
appear anywhere on the command line, and are listed below.
.PP .PP
To see usage for a specific command, run: General help options:
\f[C]hledger\ COMMAND\ \-h\f[].
Command\-specific options must be written after the command name, eg:
\f[C]hledger\ print\ \-x\f[].
.PP
Additionally, if the command is an add\-on, you may need to put its
options after a double\-hyphen, eg:
\f[C]hledger\ ui\ \-\-\ \-\-watch\f[].
Or, you can run the add\-on executable directly, eg:
\f[C]hledger\-ui\ \-\-watch\f[].
.PP
Most commands also accept arguments, which are often a query filtering
the data in some way.
.SS Special characters
.PP
Option and argument values which contain problematic characters should
be escaped with double quotes, backslashes, or (best) single quotes.
Problematic characters means spaces, and also characters which are
significant to your command shell, such as less\-than/greater\-than.
Eg:
\f[C]hledger\ register\ \-p\ \[aq]last\ year\[aq]\ "accounts\ receivable\ (receivable|payable)"\ amt:\\>100\f[].
.PP
Characters which are significant both to the shell and in regular
expressions sometimes need to be double\-escaped.
These include parentheses, the pipe symbol and the dollar sign.
Eg, to match the dollar symbol, bash users should do:
\f[C]hledger\ balance\ cur:\[aq]\\$\[aq]\f[] or
\f[C]hledger\ balance\ cur:\\\\$\f[].
.PP
There\[aq]s more..
options and arguments get de\-escaped when hledger is passing them to an
addon executable.
In this case you might need \f[I]triple\f[]\-escaping.
Eg: \f[C]hledger\ ui\ cur:\[aq]\\\\$\[aq]\f[] or
\f[C]hledger\ ui\ cur:\\\\\\\\$\f[].
.PP
If in doubt, keep things simple:
.IP \[bu] 2
run add\-on executables directly
.IP \[bu] 2
write options after the command
.IP \[bu] 2
enclose problematic args in single quotes
.IP \[bu] 2
if needed, also add a backslash to escape regexp metacharacters
.PP
If you\[aq]re really stumped, add \f[C]\-\-debug=2\f[] to troubleshoot.
.SS General options
.SS General help options
.TP .TP
.B \f[C]\-h\f[] .B \f[C]\-h\f[]
show general usage (or after COMMAND, the command\[aq]s usage) show general usage (or after COMMAND, command usage)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-help\f[] .B \f[C]\-\-help\f[]
show the current program\[aq]s manual as plain text (or after an add\-on show this program\[aq]s manual as plain text (or after an add\-on
COMMAND, the add\-on\[aq]s manual) COMMAND, the add\-on\[aq]s manual)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-man\f[] .B \f[C]\-\-man\f[]
show the current program\[aq]s manual with man show this program\[aq]s manual with man
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-info\f[] .B \f[C]\-\-info\f[]
show the current program\[aq]s manual with info show this program\[aq]s manual with info
.RS .RS
.RE .RE
.TP .TP
@ -234,7 +190,8 @@ show version
show debug output (levels 1\-9, default: 1) show debug output (levels 1\-9, default: 1)
.RS .RS
.RE .RE
.SS General input options .PP
General input options:
.TP .TP
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[] .B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
use a different input file. use a different input file.
@ -267,7 +224,8 @@ use some other field/tag for account names
ignore any failing balance assertions ignore any failing balance assertions
.RS .RS
.RE .RE
.SS General reporting options .PP
General reporting options:
.TP .TP
.B \f[C]\-b\ \-\-begin=DATE\f[] .B \f[C]\-b\ \-\-begin=DATE\f[]
include postings/txns on or after this date include postings/txns on or after this date
@ -362,6 +320,57 @@ takes precedence.
Eg \f[C]\-p\ feb\ \-p\ mar\f[] is equivalent to \f[C]\-p\ mar\f[]. Eg \f[C]\-p\ feb\ \-p\ mar\f[] is equivalent to \f[C]\-p\ mar\f[].
.PP .PP
Some of these can also be written as queries. Some of these can also be written as queries.
.SS Command options
.PP
To see options for a particular command, including command\-specific
options, run: \f[C]hledger\ COMMAND\ \-h\f[].
.PP
Command\-specific options must be written after the command name, eg:
\f[C]hledger\ print\ \-x\f[].
.PP
Additionally, if the command is an addon, you may need to put its
options after a double\-hyphen, eg:
\f[C]hledger\ ui\ \-\-\ \-\-watch\f[].
Or, you can run the addon executable directly:
\f[C]hledger\-ui\ \-\-watch\f[].
.SS Command arguments
.PP
Most hledger commands accept arguments after the command name, which are
often a query, filtering the data in some way.
.SS Special characters
.PP
Option and argument values which contain problematic characters should
be escaped with double quotes, backslashes, or (best) single quotes.
Problematic characters means spaces, and also characters which are
significant to your command shell, such as less\-than/greater\-than.
Eg:
\f[C]hledger\ register\ \-p\ \[aq]last\ year\[aq]\ "accounts\ receivable\ (receivable|payable)"\ amt:\\>100\f[].
.PP
Characters which are significant both to the shell and in regular
expressions sometimes need to be double\-escaped.
These include parentheses, the pipe symbol and the dollar sign.
Eg, to match the dollar symbol, bash users should do:
\f[C]hledger\ balance\ cur:\[aq]\\$\[aq]\f[] or
\f[C]hledger\ balance\ cur:\\\\$\f[].
.PP
There\[aq]s more..
options and arguments get de\-escaped when hledger is passing them to an
addon executable.
In this case you might need \f[I]triple\f[]\-escaping.
Eg: \f[C]hledger\ ui\ cur:\[aq]\\\\$\[aq]\f[] or
\f[C]hledger\ ui\ cur:\\\\\\\\$\f[].
.PP
If in doubt, keep things simple:
.IP \[bu] 2
run add\-on executables directly
.IP \[bu] 2
write options after the command
.IP \[bu] 2
enclose problematic args in single quotes
.IP \[bu] 2
if needed, also add a backslash to escape regexp metacharacters
.PP
If you\[aq]re really stumped, add \f[C]\-\-debug=2\f[] to troubleshoot.
.SS Input files .SS Input files
.PP .PP
hledger reads transactions from a data file (and the add command writes hledger reads transactions from a data file (and the add command writes
@ -768,11 +777,10 @@ As with account names, when tag values have
displayed in tree\-mode reports, summarisable with a depth limit, and so displayed in tree\-mode reports, summarisable with a depth limit, and so
on. on.
.PP .PP
\f[C]\-\-pivot\f[] affects all reports, and is one of those options you \f[C]\-\-pivot\f[] is a general option affecting all reports; you can
can write before the command name if you wish. think of hledger transforming the journal before any other processing,
You can think of hledger transforming the journal before any other replacing every posting\[aq]s account name with the value of the
processing, replacing every posting\[aq]s account name with the value of specified tag on that posting, inheriting it from the transaction or
the specified tag on that posting, inheriting it from the transaction or
using a blank value if it\[aq]s not present. using a blank value if it\[aq]s not present.
.PP .PP
An example: An example:
@ -868,16 +876,14 @@ In the \f[C]alias\f[] directive and \f[C]\-\-alias\f[] option, regular
expressions must be enclosed in forward slashes (\f[C]/REGEX/\f[]). expressions must be enclosed in forward slashes (\f[C]/REGEX/\f[]).
Elsewhere in hledger, these are not required. Elsewhere in hledger, these are not required.
.IP \[bu] 2 .IP \[bu] 2
To match a regular expression metacharacter like \f[C]$\f[] as a literal In queries, to match a regular expression metacharacter like \f[C]$\f[]
character, prepend a backslash. as a literal character, prepend a backslash.
Eg to search for amounts with the dollar sign in hledger\-web, write Eg to search for amounts with the dollar sign in hledger\-web, write
\f[C]cur:\\$\f[]. \f[C]cur:\\$\f[].
.IP \[bu] 2 .IP \[bu] 2
On the command line, some metacharacters like \f[C]$\f[] have a special On the command line, some metacharacters like \f[C]$\f[] have a special
meaning to the shell and so must be escaped a second time, with single meaning to the shell and so must be escaped at least once more.
or double quotes or another backslash. See Special characters.
Eg, to match amounts with the dollar sign from the command line, write
\f[C]cur:\[aq]\\$\[aq]\f[] or \f[C]cur:\\\\$\f[].
.SH QUERIES .SH QUERIES
.PP .PP
One of hledger\[aq]s strengths is being able to quickly report on One of hledger\[aq]s strengths is being able to quickly report on
@ -2452,8 +2458,41 @@ transactions when importing.
.PP .PP
hledger\-rewrite.hs Adds one or more custom postings to matched hledger\-rewrite.hs Adds one or more custom postings to matched
transactions. transactions.
.SH ENVIRONMENT
.PP
\f[B]COLUMNS\f[] The screen width used by the register command.
Default: the full terminal width.
.PP
\f[B]LEDGER_FILE\f[] The journal file path when not specified with
\f[C]\-f\f[].
Default: \f[C]~/.hledger.journal\f[] (on windows, perhaps
\f[C]C:/Users/USER/.hledger.journal\f[]).
.SH FILES
.PP
Reads data from one or more files in hledger journal, timeclock,
timedot, or CSV format specified with \f[C]\-f\f[], or
\f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[]).
.SH BUGS
.PP
The need to precede addon command options with \f[C]\-\-\f[] when
invoked from hledger is awkward.
.PP
When input data contains non\-ascii characters, a suitable system locale
must be configured (or there will be an unhelpful error).
Eg on POSIX, set LANG to something other than C.
.PP
In a Microsoft Windows CMD window, non\-ascii characters and colours are
not supported.
.PP
In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger
add.
.PP
Not all of Ledger\[aq]s journal file syntax is supported.
See file format differences.
.PP
On large data files, hledger is slower and uses more memory than Ledger.
.SH TROUBLESHOOTING .SH TROUBLESHOOTING
.SS Run\-time problems
.PP .PP
Here are some issues you might encounter when you run hledger (and Here are some issues you might encounter when you run hledger (and
remember you can also seek help from the IRC channel, mail list or bug remember you can also seek help from the IRC channel, mail list or bug
@ -2539,55 +2578,6 @@ $\ LANG=fr_FR.utf8\ hledger\ \-f\ my.journal\ print
Note some platforms allow variant locale spellings, but not all (ubuntu Note some platforms allow variant locale spellings, but not all (ubuntu
accepts \f[C]fr_FR.UTF8\f[], mac osx requires exactly accepts \f[C]fr_FR.UTF8\f[], mac osx requires exactly
\f[C]fr_FR.UTF\-8\f[]). \f[C]fr_FR.UTF\-8\f[]).
.SS Known limitations
.PP
\f[B]Command line interface\f[]
.PP
Add\-on command options, unless they are also understood by the main
hledger executable, must be written after \f[C]\-\-\f[], like this:
\f[C]hledger\ web\ \-\-\ \-\-server\f[]
.PP
\f[B]Differences from Ledger\f[]
.PP
Not all of Ledger\[aq]s journal file syntax is supported.
See file format differences.
.PP
hledger is slower than Ledger, and uses more memory, on large data
files.
.PP
\f[B]Windows limitations\f[]
.PP
In a windows CMD window, non\-ascii characters and colours are not
supported.
.PP
In a windows Cygwin/MSYS/Mintty window, the tab key is not supported in
hledger add.
.SH ENVIRONMENT
.PP
\f[B]COLUMNS\f[] The screen width used by the register command.
Default: the full terminal width.
.PP
\f[B]LEDGER_FILE\f[] The journal file path when not specified with
\f[C]\-f\f[].
Default: \f[C]~/.hledger.journal\f[] (on windows, perhaps
\f[C]C:/Users/USER/.hledger.journal\f[]).
.SH FILES
.PP
Reads data from one or more files in hledger journal, timeclock,
timedot, or CSV format specified with \f[C]\-f\f[], or
\f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[]).
.SH BUGS
.PP
The need to precede options with \f[C]\-\-\f[] when invoked from hledger
is awkward.
.PP
hledger can\[aq]t render non\-ascii characters when run from a Windows
command prompt (up to Windows 7 at least).
.PP
When input data contains non\-ascii characters, a suitable system locale
must be configured (or there will be an unhelpful error).
Eg on POSIX, set LANG to something other than C.
.SH "REPORTING BUGS" .SH "REPORTING BUGS"

546
hledger/doc/hledger.1.info
View File

@ -38,8 +38,8 @@ hledger never changes existing transactions.
To get started, you can either save some entries like the above in To get started, you can either save some entries like the above in
'~/.hledger.journal', or run 'hledger add' and follow the prompts. Then '~/.hledger.journal', or run 'hledger add' and follow the prompts. Then
try some commands like 'hledger print' or 'hledger balance'. See try some commands like 'hledger print' or 'hledger balance'. Run
COMMANDS and EXAMPLES below. 'hledger' with no arguments for a list of commands.
* Menu: * Menu:
* EXAMPLES:: * EXAMPLES::
@ -47,7 +47,6 @@ COMMANDS and EXAMPLES below.
* QUERIES:: * QUERIES::
* COMMANDS:: * COMMANDS::
* ADD-ON COMMANDS:: * ADD-ON COMMANDS::
* TROUBLESHOOTING::
 
File: hledger.1.info, Node: EXAMPLES, Next: OPTIONS, Prev: Top, Up: Top File: hledger.1.info, Node: EXAMPLES, Next: OPTIONS, Prev: Top, Up: Top
@ -114,25 +113,12 @@ File: hledger.1.info, Node: OPTIONS, Next: QUERIES, Prev: EXAMPLES, Up: Top
2 OPTIONS 2 OPTIONS
********* *********
To see general usage help, including general options which are supported
by most hledger commands, run 'hledger -h'. (Note -h and -help are
different, like git.) These options can appear anywhere on the command
line, and are listed below.
To see usage for a specific command, run: 'hledger COMMAND -h'.
Command-specific options must be written after the command name, eg:
'hledger print -x'.
Additionally, if the command is an add-on, you may need to put its
options after a double-hyphen, eg: 'hledger ui -- --watch'. Or, you can
run the add-on executable directly, eg: 'hledger-ui --watch'.
Most commands also accept arguments, which are often a query
filtering the data in some way.
* Menu: * Menu:
* Special characters::
* General options:: * General options::
* Command options::
* Command arguments::
* Special characters::
* Input files:: * Input files::
* Smart dates:: * Smart dates::
* Report start & end date:: * Report start & end date::
@ -143,69 +129,30 @@ filtering the data in some way.
* Regular expressions:: * Regular expressions::
 
File: hledger.1.info, Node: Special characters, Next: General options, Up: OPTIONS File: hledger.1.info, Node: General options, Next: Command options, Up: OPTIONS
2.1 Special characters 2.1 General options
======================
Option and argument values which contain problematic characters should
be escaped with double quotes, backslashes, or (best) single quotes.
Problematic characters means spaces, and also characters which are
significant to your command shell, such as less-than/greater-than. Eg:
'hledger register -p 'last year' "accounts receivable
(receivable|payable)" amt:\>100'.
Characters which are significant both to the shell and in regular
expressions sometimes need to be double-escaped. These include
parentheses, the pipe symbol and the dollar sign. Eg, to match the
dollar symbol, bash users should do: 'hledger balance cur:'\$'' or
'hledger balance cur:\\$'.
There's more.. options and arguments get de-escaped when hledger is
passing them to an addon executable. In this case you might need
_triple_-escaping. Eg: 'hledger ui cur:'\\$'' or 'hledger ui
cur:\\\\$'.
If in doubt, keep things simple:
* run add-on executables directly
* write options after the command
* enclose problematic args in single quotes
* if needed, also add a backslash to escape regexp metacharacters
If you're really stumped, add '--debug=2' to troubleshoot.

File: hledger.1.info, Node: General options, Next: Input files, Prev: Special characters, Up: OPTIONS
2.2 General options
=================== ===================
* Menu: To see general usage help, including general options which are supported
by most hledger commands, run 'hledger -h'. (Note -h and -help are
different, like git.)
* General help options:: General help options:
* General input options::
* General reporting options::

File: hledger.1.info, Node: General help options, Next: General input options, Up: General options
2.2.1 General help options
--------------------------
'-h' '-h'
show general usage (or after COMMAND, the command's usage) show general usage (or after COMMAND, command usage)
'--help' '--help'
show the current program's manual as plain text (or after an add-on show this program's manual as plain text (or after an add-on
COMMAND, the add-on's manual) COMMAND, the add-on's manual)
'--man' '--man'
show the current program's manual with man show this program's manual with man
'--info' '--info'
show the current program's manual with info show this program's manual with info
'--version' '--version'
show version show version
@ -213,11 +160,7 @@ File: hledger.1.info, Node: General help options, Next: General input options,
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
 General input options:
File: hledger.1.info, Node: General input options, Next: General reporting options, Prev: General help options, Up: General options
2.2.2 General input options
---------------------------
'-f FILE --file=FILE' '-f FILE --file=FILE'
@ -239,11 +182,7 @@ File: hledger.1.info, Node: General input options, Next: General reporting opt
ignore any failing balance assertions ignore any failing balance assertions
 General reporting options:
File: hledger.1.info, Node: General reporting options, Prev: General input options, Up: General options
2.2.3 General reporting options
-------------------------------
'-b --begin=DATE' '-b --begin=DATE'
@ -306,9 +245,67 @@ one takes precedence. Eg '-p feb -p mar' is equivalent to '-p mar'.
Some of these can also be written as queries. Some of these can also be written as queries.
 
File: hledger.1.info, Node: Input files, Next: Smart dates, Prev: General options, Up: OPTIONS File: hledger.1.info, Node: Command options, Next: Command arguments, Prev: General options, Up: OPTIONS
2.3 Input files 2.2 Command options
===================
To see options for a particular command, including command-specific
options, run: 'hledger COMMAND -h'.
Command-specific options must be written after the command name, eg:
'hledger print -x'.
Additionally, if the command is an addon, you may need to put its
options after a double-hyphen, eg: 'hledger ui -- --watch'. Or, you can
run the addon executable directly: 'hledger-ui --watch'.

File: hledger.1.info, Node: Command arguments, Next: Special characters, Prev: Command options, Up: OPTIONS
2.3 Command arguments
=====================
Most hledger commands accept arguments after the command name, which are
often a query, filtering the data in some way.

File: hledger.1.info, Node: Special characters, Next: Input files, Prev: Command arguments, Up: OPTIONS
2.4 Special characters
======================
Option and argument values which contain problematic characters should
be escaped with double quotes, backslashes, or (best) single quotes.
Problematic characters means spaces, and also characters which are
significant to your command shell, such as less-than/greater-than. Eg:
'hledger register -p 'last year' "accounts receivable
(receivable|payable)" amt:\>100'.
Characters which are significant both to the shell and in regular
expressions sometimes need to be double-escaped. These include
parentheses, the pipe symbol and the dollar sign. Eg, to match the
dollar symbol, bash users should do: 'hledger balance cur:'\$'' or
'hledger balance cur:\\$'.
There's more.. options and arguments get de-escaped when hledger is
passing them to an addon executable. In this case you might need
_triple_-escaping. Eg: 'hledger ui cur:'\\$'' or 'hledger ui
cur:\\\\$'.
If in doubt, keep things simple:
* run add-on executables directly
* write options after the command
* enclose problematic args in single quotes
* if needed, also add a backslash to escape regexp metacharacters
If you're really stumped, add '--debug=2' to troubleshoot.

File: hledger.1.info, Node: Input files, Next: Smart dates, Prev: Special characters, Up: OPTIONS
2.5 Input files
=============== ===============
hledger reads transactions from a data file (and the add command writes hledger reads transactions from a data file (and the add command writes
@ -363,7 +360,7 @@ the files, eg: 'cat a.journal b.journal | hledger -f- CMD'.
 
File: hledger.1.info, Node: Smart dates, Next: Report start & end date, Prev: Input files, Up: OPTIONS File: hledger.1.info, Node: Smart dates, Next: Report start & end date, Prev: Input files, Up: OPTIONS
2.4 Smart dates 2.6 Smart dates
=============== ===============
hledger's user interfaces accept a flexible "smart date" syntax (unlike hledger's user interfaces accept a flexible "smart date" syntax (unlike
@ -386,7 +383,7 @@ omitted (defaulting to 1).
 
File: hledger.1.info, Node: Report start & end date, Next: Report intervals, Prev: Smart dates, Up: OPTIONS File: hledger.1.info, Node: Report start & end date, Next: Report intervals, Prev: Smart dates, Up: OPTIONS
2.5 Report start & end date 2.7 Report start & end date
=========================== ===========================
Most hledger reports show the full span of time represented by the Most hledger reports show the full span of time represented by the
@ -415,7 +412,7 @@ need to write the date _after_ the last day you want to include.
 
File: hledger.1.info, Node: Report intervals, Next: Period expressions, Prev: Report start & end date, Up: OPTIONS File: hledger.1.info, Node: Report intervals, Next: Period expressions, Prev: Report start & end date, Up: OPTIONS
2.6 Report intervals 2.8 Report intervals
==================== ====================
A report interval can be specified so that commands like register, A report interval can be specified so that commands like register,
@ -428,7 +425,7 @@ intervals can not be specified with a query, currently.
 
File: hledger.1.info, Node: Period expressions, Next: Depth limiting, Prev: Report intervals, Up: OPTIONS File: hledger.1.info, Node: Period expressions, Next: Depth limiting, Prev: Report intervals, Up: OPTIONS
2.7 Period expressions 2.9 Period expressions
====================== ======================
The '-p/--period' option accepts period expressions, a shorthand way of The '-p/--period' option accepts period expressions, a shorthand way of
@ -503,8 +500,8 @@ start date and exclusive end date):
 
File: hledger.1.info, Node: Depth limiting, Next: Pivoting, Prev: Period expressions, Up: OPTIONS File: hledger.1.info, Node: Depth limiting, Next: Pivoting, Prev: Period expressions, Up: OPTIONS
2.8 Depth limiting 2.10 Depth limiting
================== ===================
With the '--depth N' option, commands like account, balance and register With the '--depth N' option, commands like account, balance and register
will show only the uppermost accounts in the account tree, down to level will show only the uppermost accounts in the account tree, down to level
@ -513,8 +510,8 @@ N. Use this when you want a summary with less detail.
 
File: hledger.1.info, Node: Pivoting, Next: Regular expressions, Prev: Depth limiting, Up: OPTIONS File: hledger.1.info, Node: Pivoting, Next: Regular expressions, Prev: Depth limiting, Up: OPTIONS
2.9 Pivoting 2.11 Pivoting
============ =============
Normally hledger sums amounts, and organizes them in a hierarchy, based Normally hledger sums amounts, and organizes them in a hierarchy, based
on account name. The '--pivot TAGNAME' option causes it to sum and on account name. The '--pivot TAGNAME' option causes it to sum and
@ -526,10 +523,9 @@ account names, when tag values have 'multiple:colon-separated:parts'
hledger will build hierarchy, displayed in tree-mode reports, hledger will build hierarchy, displayed in tree-mode reports,
summarisable with a depth limit, and so on. summarisable with a depth limit, and so on.
'--pivot' affects all reports, and is one of those options you can '--pivot' is a general option affecting all reports; you can think of
write before the command name if you wish. You can think of hledger hledger transforming the journal before any other processing, replacing
transforming the journal before any other processing, replacing every every posting's account name with the value of the specified tag on that
posting's account name with the value of the specified tag on that
posting, inheriting it from the transaction or using a blank value if posting, inheriting it from the transaction or using a blank value if
it's not present. it's not present.
@ -574,7 +570,7 @@ $ hledger balance --pivot member acct:.
 
File: hledger.1.info, Node: Regular expressions, Prev: Pivoting, Up: OPTIONS File: hledger.1.info, Node: Regular expressions, Prev: Pivoting, Up: OPTIONS
2.10 Regular expressions 2.12 Regular expressions
======================== ========================
hledger uses regular expressions in a number of places: hledger uses regular expressions in a number of places:
@ -603,15 +599,13 @@ general they:
must be enclosed in forward slashes ('/REGEX/'). Elsewhere in must be enclosed in forward slashes ('/REGEX/'). Elsewhere in
hledger, these are not required. hledger, these are not required.
* To match a regular expression metacharacter like '$' as a literal * In queries, to match a regular expression metacharacter like '$' as
character, prepend a backslash. Eg to search for amounts with the a literal character, prepend a backslash. Eg to search for amounts
dollar sign in hledger-web, write 'cur:\$'. with the dollar sign in hledger-web, write 'cur:\$'.
* On the command line, some metacharacters like '$' have a special * On the command line, some metacharacters like '$' have a special
meaning to the shell and so must be escaped a second time, with meaning to the shell and so must be escaped at least once more.
single or double quotes or another backslash. Eg, to match amounts See Special characters.
with the dollar sign from the command line, write 'cur:'\$'' or
'cur:\\$'.
 
File: hledger.1.info, Node: QUERIES, Next: COMMANDS, Prev: OPTIONS, Up: Top File: hledger.1.info, Node: QUERIES, Next: COMMANDS, Prev: OPTIONS, Up: Top
@ -1854,7 +1848,7 @@ matching names. It's mainly used in development, but it's also nice to
be able to check your hledger executable for smoke at any time. be able to check your hledger executable for smoke at any time.
 
File: hledger.1.info, Node: ADD-ON COMMANDS, Next: TROUBLESHOOTING, Prev: COMMANDS, Up: Top File: hledger.1.info, Node: ADD-ON COMMANDS, Prev: COMMANDS, Up: Top
5 ADD-ON COMMANDS 5 ADD-ON COMMANDS
***************** *****************
@ -2099,238 +2093,128 @@ File: hledger.1.info, Node: rewrite, Prev: register-match, Up: Experimental a
hledger-rewrite.hs Adds one or more custom postings to matched hledger-rewrite.hs Adds one or more custom postings to matched
transactions. transactions.

File: hledger.1.info, Node: TROUBLESHOOTING, Prev: ADD-ON COMMANDS, Up: Top
6 TROUBLESHOOTING
*****************
* Menu:
* Run-time problems::
* Known limitations::

File: hledger.1.info, Node: Run-time problems, Next: Known limitations, Up: TROUBLESHOOTING
6.1 Run-time problems
=====================
Here are some issues you might encounter when you run hledger (and
remember you can also seek help from the IRC channel, mail list or bug
tracker):
*Successfully installed, but "No command 'hledger' found"*
stack and cabal install binaries into a special directory, which should
be added to your PATH environment variable. Eg on unix-like systems,
that is ~/.local/bin and ~/.cabal/bin respectively.
*I set a custom LEDGER_FILE, but hledger is still using the default
file*
'LEDGER_FILE' should be a real environment variable, not just a shell
variable. The command 'env | grep LEDGER_FILE' should show it. You may
need to use 'export'. Here's an explanation.
*"Illegal byte sequence" or "Invalid or incomplete multibyte or wide
character" errors*
In order to handle non-ascii letters and symbols (like £), hledger
needs an appropriate locale. This is usually configured system-wide;
you can also configure it temporarily. The locale may need to be one
that supports UTF-8, if you built hledger with GHC < 7.2 (or possibly
always, I'm not sure yet).
Here's an example of setting the locale temporarily, on ubuntu
gnu/linux:
$ file my.journal
my.journal: UTF-8 Unicode text # <- the file is UTF8-encoded
$ locale -a
C
en_US.utf8 # <- a UTF8-aware locale is available
POSIX
$ LANG=en_US.utf8 hledger -f my.journal print # <- use it for this command
Here's one way to set it permanently, there are probably better ways:
$ echo "export LANG=en_US.UTF-8" >>~/.bash_profile
$ bash --login
If we preferred to use eg 'fr_FR.utf8', we might have to install that
first:
$ apt-get install language-pack-fr
$ locale -a
C
en_US.utf8
fr_BE.utf8
fr_CA.utf8
fr_CH.utf8
fr_FR.utf8
fr_LU.utf8
POSIX
$ LANG=fr_FR.utf8 hledger -f my.journal print
Note some platforms allow variant locale spellings, but not all
(ubuntu accepts 'fr_FR.UTF8', mac osx requires exactly 'fr_FR.UTF-8').

File: hledger.1.info, Node: Known limitations, Prev: Run-time problems, Up: TROUBLESHOOTING
6.2 Known limitations
=====================
*Command line interface*
Add-on command options, unless they are also understood by the main
hledger executable, must be written after '--', like this: 'hledger web
-- --server'
*Differences from Ledger*
Not all of Ledger's journal file syntax is supported. See file
format differences.
hledger is slower than Ledger, and uses more memory, on large data
files.
*Windows limitations*
In a windows CMD window, non-ascii characters and colours are not
supported.
In a windows Cygwin/MSYS/Mintty window, the tab key is not supported
in hledger add.
 
Tag Table: Tag Table:
Node: Top70 Node: Top70
Node: EXAMPLES1883 Node: EXAMPLES1886
Ref: #examples1985 Ref: #examples1988
Node: OPTIONS3631 Node: OPTIONS3634
Ref: #options3735 Ref: #options3738
Node: Special characters4649 Node: General options3993
Ref: #special-characters4785 Ref: #general-options4120
Node: General options5953 Node: Command options6643
Ref: #general-options6103 Ref: #command-options6796
Node: General help options6194 Node: Command arguments7194
Ref: #general-help-options6354 Ref: #command-arguments7354
Node: General input options6753 Node: Special characters7475
Ref: #general-input-options6949 Ref: #special-characters7633
Node: General reporting options7420 Node: Input files8801
Ref: #general-reporting-options7595 Ref: #input-files8939
Node: Input files9027 Node: Smart dates10902
Ref: #input-files9162 Ref: #smart-dates11045
Node: Smart dates11125 Node: Report start & end date12024
Ref: #smart-dates11268 Ref: #report-start-end-date12196
Node: Report start & end date12247 Node: Report intervals13262
Ref: #report-start-end-date12419 Ref: #report-intervals13427
Node: Report intervals13485 Node: Period expressions13828
Ref: #report-intervals13650 Ref: #period-expressions13988
Node: Period expressions14051 Node: Depth limiting16328
Ref: #period-expressions14211 Ref: #depth-limiting16474
Node: Depth limiting16551 Node: Pivoting16675
Ref: #depth-limiting16695 Ref: #pivoting16810
Node: Pivoting16896 Node: Regular expressions18581
Ref: #pivoting17029 Ref: #regular-expressions18715
Node: Regular expressions18858 Node: QUERIES20076
Ref: #regular-expressions18992 Ref: #queries20180
Node: QUERIES20470 Node: COMMANDS23826
Ref: #queries20574 Ref: #commands23940
Node: COMMANDS24220 Node: accounts24613
Ref: #commands24334 Ref: #accounts24713
Node: accounts25007 Node: activity25695
Ref: #accounts25107 Ref: #activity25807
Node: activity26089 Node: add26166
Ref: #activity26201 Ref: #add26267
Node: add26560 Node: balance28925
Ref: #add26661 Ref: #balance29038
Node: balance29319 Node: Flat mode31980
Ref: #balance29432 Ref: #flat-mode32107
Node: Flat mode32374 Node: Depth limited balance reports32527
Ref: #flat-mode32501 Ref: #depth-limited-balance-reports32730
Node: Depth limited balance reports32921 Node: Multicolumn balance reports33150
Ref: #depth-limited-balance-reports33124 Ref: #multicolumn-balance-reports33352
Node: Multicolumn balance reports33544 Node: Market value38000
Ref: #multicolumn-balance-reports33746 Ref: #market-value38164
Node: Market value38394 Node: Custom balance output39464
Ref: #market-value38558 Ref: #custom-balance-output39637
Node: Custom balance output39858 Node: Output destination41730
Ref: #custom-balance-output40031 Ref: #output-destination41895
Node: Output destination42124 Node: CSV output42165
Ref: #output-destination42289 Ref: #csv-output42284
Node: CSV output42559 Node: balancesheet42681
Ref: #csv-output42678 Ref: #balancesheet42809
Node: balancesheet43075 Node: cashflow44728
Ref: #balancesheet43203 Ref: #cashflow44845
Node: cashflow45122 Node: help46743
Ref: #cashflow45239 Ref: #help46855
Node: help47137 Node: incomestatement47693
Ref: #help47249 Ref: #incomestatement47823
Node: incomestatement48087 Node: info49738
Ref: #incomestatement48217 Ref: #info49845
Node: info50132 Node: man50209
Ref: #info50239 Ref: #man50306
Node: man50603 Node: print50711
Ref: #man50700 Ref: #print50816
Node: print51105 Node: register54572
Ref: #print51210 Ref: #register54685
Node: register54966 Node: Custom register output59181
Ref: #register55079 Ref: #custom-register-output59312
Node: Custom register output59575 Node: stats60609
Ref: #custom-register-output59706 Ref: #stats60715
Node: stats61003 Node: test61596
Ref: #stats61109 Ref: #test61683
Node: test61990 Node: ADD-ON COMMANDS62051
Ref: #test62077 Ref: #add-on-commands62163
Node: ADD-ON COMMANDS62445 Node: Official add-ons63450
Ref: #add-on-commands62581 Ref: #official-add-ons63592
Node: Official add-ons63868 Node: api63679
Ref: #official-add-ons64010 Ref: #api63770
Node: api64097 Node: ui63822
Ref: #api64188 Ref: #ui63923
Node: ui64240 Node: web63981
Ref: #ui64341 Ref: #web64072
Node: web64399 Node: Third party add-ons64118
Ref: #web64490 Ref: #third-party-add-ons64295
Node: Third party add-ons64536 Node: diff64430
Ref: #third-party-add-ons64713 Ref: #diff64529
Node: diff64848 Node: iadd64628
Ref: #diff64947 Ref: #iadd64744
Node: iadd65046 Node: interest64827
Ref: #iadd65162 Ref: #interest64950
Node: interest65245 Node: irr65045
Ref: #interest65368 Ref: #irr65145
Node: irr65463 Node: Experimental add-ons65223
Ref: #irr65563 Ref: #experimental-add-ons65377
Node: Experimental add-ons65641 Node: autosync65770
Ref: #experimental-add-ons65795 Ref: #autosync65884
Node: autosync66188 Node: budget66123
Ref: #autosync66302 Ref: #budget66247
Node: budget66541 Node: chart66313
Ref: #budget66665 Ref: #chart66432
Node: chart66731 Node: check66503
Ref: #chart66850 Ref: #check66627
Node: check66921 Node: check-dates66694
Ref: #check67045 Ref: #check-dates66836
Node: check-dates67112 Node: check-dupes66909
Ref: #check-dates67254 Ref: #check-dupes67052
Node: check-dupes67327 Node: equity67129
Ref: #check-dupes67470 Ref: #equity67257
Node: equity67547 Node: prices67376
Ref: #equity67675 Ref: #prices67505
Node: prices67794 Node: print-unique67560
Ref: #prices67923 Ref: #print-unique67709
Node: print-unique67978 Node: register-match67802
Ref: #print-unique68127 Ref: #register-match67958
Node: register-match68220 Node: rewrite68056
Ref: #register-match68376 Ref: #rewrite68177
Node: rewrite68474
Ref: #rewrite68595
Node: TROUBLESHOOTING68673
Ref: #troubleshooting68792
Node: Run-time problems68846
Ref: #run-time-problems68989
Node: Known limitations70936
Ref: #known-limitations71079
 
End Tag Table End Tag Table

808
hledger/doc/hledger.1.txt
View File

File diff suppressed because it is too large Load Diff