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

;update manuals

Browse Source
This commit is contained in:
Simon Michael 2020-11-29 21:21:50 -08:00
parent 4db9ec1e79
commit 16a212af57
6 changed files with 1080 additions and 933 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
hledger-lib/hledger_journal.5
View File

@ -1264,6 +1264,13 @@ followed by 0 or more decimal digits.
Note hledger normally uses banker\[aq]s rounding, so 0.5 displayed with Note hledger normally uses banker\[aq]s rounding, so 0.5 displayed with
zero decimal digits is \[dq]0\[dq]. zero decimal digits is \[dq]0\[dq].
(More at Commodity display style.) (More at Commodity display style.)
.SS Commodity error checking
.PP
In strict mode, enabled with the \f[C]-s\f[R]/\f[C]--strict\f[R] flag,
hledger will report an error if a commodity symbol is used that has not
been declared by a \f[C]commodity\f[R] directive.
This works similarly to account error checking, see the notes there for
more details.
.SS Default commodity .SS Default commodity
.PP .PP
The \f[C]D\f[R] directive sets a default commodity, to be used for The \f[C]D\f[R] directive sets a default commodity, to be used for
@ -1364,20 +1371,19 @@ hledger-style account name, eg this account directive declares the
account assets:bank:checking account assets:bank:checking
\f[R] \f[R]
.fi .fi
.SS Account existence .SS Account error checking
.PP .PP
By default, accounts come into existence when a transaction references By default, accounts come into existence when a transaction references
them. them by name.
This is convenient, but when you mis-spell an account name in a This is convenient, but it means hledger can\[aq]t warn you when you
transaction, hledger won\[aq]t be able to detect it. mis-spell an account name in the journal.
Usually this isn\[aq]t a big problem, as you\[aq]ll notice the error in Usually you\[aq]ll find the error later, as an extra account in balance
balance reports, or when reconciling account balances. reports, or an incorrect balance when reconciling.
.PP .PP
When you want more error checking, you can enable strict mode with the In strict mode, enabled with the \f[C]-s\f[R]/\f[C]--strict\f[R] flag,
\f[C]-s\f[R]/\f[C]--strict\f[R] flag. hledger will report an error if any transaction uses an account name
Then hledger will will report an error if any transaction references an that has not been declared by an account directive.
account that has not been declared by an account directive. Some notes:
Some things to note:
.IP \[bu] 2 .IP \[bu] 2
The declaration is case-sensitive; transactions must use the correct The declaration is case-sensitive; transactions must use the correct
account name capitalisation. account name capitalisation.

142
hledger-lib/hledger_journal.info
View File

@ -1139,6 +1139,21 @@ a comma, followed by 0 or more decimal digits.
Note hledger normally uses banker's rounding, so 0.5 displayed with Note hledger normally uses banker's rounding, so 0.5 displayed with
zero decimal digits is "0". (More at Commodity display style.) zero decimal digits is "0". (More at Commodity display style.)
* Menu:
* Commodity error checking::

File: hledger_journal.info, Node: Commodity error checking, Up: Declaring commodities
1.13.5.1 Commodity error checking
.................................
In strict mode, enabled with the '-s'/'--strict' flag, hledger will
report an error if a commodity symbol is used that has not been declared
by a 'commodity' directive. This works similarly to account error
checking, see the notes there for more details.
 
File: hledger_journal.info, Node: Default commodity, Next: Declaring market prices, Prev: Declaring commodities, Up: Directives File: hledger_journal.info, Node: Default commodity, Next: Declaring market prices, Prev: Declaring commodities, Up: Directives
@ -1228,28 +1243,27 @@ account assets:bank:checking
* Menu: * Menu:
* Account existence:: * Account error checking::
* Account comments:: * Account comments::
* Account subdirectives:: * Account subdirectives::
* Account types:: * Account types::
* Account display order:: * Account display order::
 
File: hledger_journal.info, Node: Account existence, Next: Account comments, Up: Declaring accounts File: hledger_journal.info, Node: Account error checking, Next: Account comments, Up: Declaring accounts
1.13.8.1 Account existence 1.13.8.1 Account error checking
.......................... ...............................
By default, accounts come into existence when a transaction references By default, accounts come into existence when a transaction references
them. This is convenient, but when you mis-spell an account name in a them by name. This is convenient, but it means hledger can't warn you
transaction, hledger won't be able to detect it. Usually this isn't a when you mis-spell an account name in the journal. Usually you'll find
big problem, as you'll notice the error in balance reports, or when the error later, as an extra account in balance reports, or an incorrect
reconciling account balances. balance when reconciling.
When you want more error checking, you can enable strict mode with In strict mode, enabled with the '-s'/'--strict' flag, hledger will
the '-s'/'--strict' flag. Then hledger will will report an error if any report an error if any transaction uses an account name that has not
transaction references an account that has not been declared by an been declared by an account directive. Some notes:
account directive. Some things to note:
* The declaration is case-sensitive; transactions must use the * The declaration is case-sensitive; transactions must use the
correct account name capitalisation. correct account name capitalisation.
@ -1264,7 +1278,7 @@ account directive. Some things to note:
with a wildcard; every account posted to must be declared. with a wildcard; every account posted to must be declared.
 
File: hledger_journal.info, Node: Account comments, Next: Account subdirectives, Prev: Account existence, Up: Declaring accounts File: hledger_journal.info, Node: Account comments, Next: Account subdirectives, Prev: Account error checking, Up: Declaring accounts
1.13.8.2 Account comments 1.13.8.2 Account comments
......................... .........................
@ -1990,56 +2004,58 @@ Node: Default year39916
Ref: #default-year40085 Ref: #default-year40085
Node: Declaring commodities40492 Node: Declaring commodities40492
Ref: #declaring-commodities40675 Ref: #declaring-commodities40675
Node: Default commodity42480 Node: Commodity error checking42519
Ref: #default-commodity42666 Ref: #commodity-error-checking42679
Node: Declaring market prices43555 Node: Default commodity42936
Ref: #declaring-market-prices43750 Ref: #default-commodity43122
Node: Declaring accounts44607 Node: Declaring market prices44011
Ref: #declaring-accounts44793 Ref: #declaring-market-prices44206
Node: Account existence45990 Node: Declaring accounts45063
Ref: #account-existence46151 Ref: #declaring-accounts45249
Node: Account comments47387 Node: Account error checking46451
Ref: #account-comments47576 Ref: #account-error-checking46627
Node: Account subdirectives48000 Node: Account comments47806
Ref: #account-subdirectives48195 Ref: #account-comments48000
Node: Account types48508 Node: Account subdirectives48424
Ref: #account-types48692 Ref: #account-subdirectives48619
Node: Account display order51738 Node: Account types48932
Ref: #account-display-order51908 Ref: #account-types49116
Node: Rewriting accounts53059 Node: Account display order52162
Ref: #rewriting-accounts53244 Ref: #account-display-order52332
Node: Basic aliases54001 Node: Rewriting accounts53483
Ref: #basic-aliases54147 Ref: #rewriting-accounts53668
Node: Regex aliases54851 Node: Basic aliases54425
Ref: #regex-aliases55023 Ref: #basic-aliases54571
Node: Combining aliases55742 Node: Regex aliases55275
Ref: #combining-aliases55935 Ref: #regex-aliases55447
Node: Aliases and multiple files57211 Node: Combining aliases56166
Ref: #aliases-and-multiple-files57420 Ref: #combining-aliases56359
Node: end aliases57999 Node: Aliases and multiple files57635
Ref: #end-aliases58156 Ref: #aliases-and-multiple-files57844
Node: Default parent account58257 Node: end aliases58423
Ref: #default-parent-account58425 Ref: #end-aliases58580
Node: Periodic transactions59309 Node: Default parent account58681
Ref: #periodic-transactions59484 Ref: #default-parent-account58849
Node: Periodic rule syntax61356 Node: Periodic transactions59733
Ref: #periodic-rule-syntax61562 Ref: #periodic-transactions59908
Node: Two spaces between period expression and description!62266 Node: Periodic rule syntax61780
Ref: #two-spaces-between-period-expression-and-description62585 Ref: #periodic-rule-syntax61986
Node: Forecasting with periodic transactions63269 Node: Two spaces between period expression and description!62690
Ref: #forecasting-with-periodic-transactions63574 Ref: #two-spaces-between-period-expression-and-description63009
Node: Budgeting with periodic transactions65629 Node: Forecasting with periodic transactions63693
Ref: #budgeting-with-periodic-transactions65868 Ref: #forecasting-with-periodic-transactions63998
Node: Auto postings66277 Node: Budgeting with periodic transactions66053
Ref: #auto-postings66417 Ref: #budgeting-with-periodic-transactions66292
Node: Auto postings and multiple files68596 Node: Auto postings66701
Ref: #auto-postings-and-multiple-files68800 Ref: #auto-postings66841
Node: Auto postings and dates69009 Node: Auto postings and multiple files69020
Ref: #auto-postings-and-dates69283 Ref: #auto-postings-and-multiple-files69224
Node: Auto postings and transaction balancing / inferred amounts / balance assertions69458 Node: Auto postings and dates69433
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions69809 Ref: #auto-postings-and-dates69707
Node: Auto posting tags70151 Node: Auto postings and transaction balancing / inferred amounts / balance assertions69882
Ref: #auto-posting-tags70366 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions70233
Node: Auto posting tags70575
Ref: #auto-posting-tags70790
 
End Tag Table End Tag Table

24
hledger-lib/hledger_journal.txt
View File

@ -892,6 +892,12 @@ FILE FORMAT
Note hledger normally uses banker's rounding, so 0.5 displayed with Note hledger normally uses banker's rounding, so 0.5 displayed with
zero decimal digits is "0". (More at Commodity display style.) zero decimal digits is "0". (More at Commodity display style.)
Commodity error checking
In strict mode, enabled with the -s/--strict flag, hledger will report
an error if a commodity symbol is used that has not been declared by a
commodity directive. This works similarly to account error checking,
see the notes there for more details.
Default commodity Default commodity
The D directive sets a default commodity, to be used for amounts with- The D directive sets a default commodity, to be used for amounts with-
out a commodity symbol (ie, plain numbers). This commodity will be ap- out a commodity symbol (ie, plain numbers). This commodity will be ap-
@ -970,17 +976,16 @@ FILE FORMAT
account assets:bank:checking account assets:bank:checking
Account existence Account error checking
By default, accounts come into existence when a transaction references By default, accounts come into existence when a transaction references
them. This is convenient, but when you mis-spell an account name in a them by name. This is convenient, but it means hledger can't warn you
transaction, hledger won't be able to detect it. Usually this isn't a when you mis-spell an account name in the journal. Usually you'll find
big problem, as you'll notice the error in balance reports, or when the error later, as an extra account in balance reports, or an incor-
reconciling account balances. rect balance when reconciling.
When you want more error checking, you can enable strict mode with the In strict mode, enabled with the -s/--strict flag, hledger will report
-s/--strict flag. Then hledger will will report an error if any trans- an error if any transaction uses an account name that has not been de-
action references an account that has not been declared by an account clared by an account directive. Some notes:
directive. Some things to note:
o The declaration is case-sensitive; transactions must use the correct o The declaration is case-sensitive; transactions must use the correct
account name capitalisation. account name capitalisation.
@ -1070,6 +1075,7 @@ FILE FORMAT
^(debts?|lia- Liability ^(debts?|lia- Liability
bilit(y|ies))(:|$) bilit(y|ies))(:|$)
^equity(:|$) Equity ^equity(:|$) Equity
^(income|revenue)s?(:|$) Revenue ^(income|revenue)s?(:|$) Revenue
^expenses?(:|$) Expense ^expenses?(:|$) Expense

81
hledger/hledger.1
View File

@ -1078,8 +1078,14 @@ Do all balance assertions pass ?
With the \f[C]-s\f[R]/\f[C]--strict\f[R] flag, additional checks are With the \f[C]-s\f[R]/\f[C]--strict\f[R] flag, additional checks are
performed: performed:
.IP \[bu] 2 .IP \[bu] 2
Are all accounts referenced by transactions declared with an account Are all accounts posted to, declared with an \f[C]account\f[R] directive
directive ? ?
(Account error checking)
.IP \[bu] 2
Are all commodities declared with a \f[C]commodity\f[R] directive ?
(Commodity error checking)
.PP
See also: https://hledger.org/checking-for-errors.html
.PP .PP
\f[I]experimental.\f[R] \f[I]experimental.\f[R]
.SS Output destination .SS Output destination
@ -3530,28 +3536,67 @@ Instead of absolute values percentages can be displayed with
This command also supports the output destination and output format This command also supports the output destination and output format
options The output formats supported are \f[C]txt\f[R], \f[C]csv\f[R], options The output formats supported are \f[C]txt\f[R], \f[C]csv\f[R],
\f[C]html\f[R], and (experimental) \f[C]json\f[R]. \f[C]html\f[R], and (experimental) \f[C]json\f[R].
.SS check-dates .SS check
.PP .PP
check-dates check
.PD 0 .PD 0
.P .P
.PD .PD
Check that transactions are sorted by increasing date. Check for various kinds of errors in your data.
With --date2, checks secondary dates instead.
With --strict, dates must also be unique.
With a query, only matched transactions\[aq] dates are checked.
Reads the default journal file, or another specified with -f.
.SS check-dupes
.PP .PP
check-dupes hledger provides a number of built-in error checks to help prevent
.PD 0 problems in your data.
.P Some, but not all, of these are run automatically before all commands.
.PD You can also use this \f[C]check\f[R] command to run any of the
Reports account names having the same leaf but different prefixes. available tests.
In other words, two or more leaves that are categorized differently. They are named, and run, as follows:
Reads the default journal file, or another specified as an argument.
.PP .PP
An example: http://stefanorodighiero.net/software/hledger-dupes.html \f[C]hledger check\f[R] runs the basic checks, like all other commands,
but with no output unless there is a problem.
These are:
.IP \[bu] 2
\f[B]parseable\f[R] - data files are well-formed and can be successfully
parsed
.IP \[bu] 2
\f[B]autobalanced\f[R] - all transactions are balanced, inferring
missing amounts where necessary, and possibly converting commodities
using transaction prices or automatically-inferred transaction prices
.IP \[bu] 2
\f[B]assertions\f[R] - all balance assertions are passing (except with
\f[C]-I\f[R]/\f[C]--ignore-assertions\f[R])
.PP
\f[C]hledger check --strict\f[R] also runs the additional \[dq]strict
mode\[dq] checks, which are:
.IP \[bu] 2
\f[B]accounts\f[R] - all account names used by transactions have been
declared
.IP \[bu] 2
\f[B]commodities\f[R] - all commodity symbols used have been declared
.PP
\f[C]hledger check CHECK1 CHECK2 ...\f[R] runs all of the named checks,
in turn.
This may be useful when neither the default nor strict checks are
exactly what you want, or when you want to focus on a single check of
interest.
The arguments are standard lowercase names for the checks.
Currently only these checks can be run in this way:
.IP \[bu] 2
\f[B]dates\f[R] - transactions are ordered by date (similar to the old
\f[C]check-dates\f[R] command)
.IP \[bu] 2
\f[B]leafnames\f[R] - all account leaf names are unique ((similar to the
old \f[C]check-dupes\f[R] command)
.PP
See also:
.PP
Some checks are shipped as addon scripts for now (cf
https://github.com/simonmichael/hledger/tree/master/bin, and Cookbook ->
Scripting):
.IP \[bu] 2
\f[B]tagfiles\f[R] - all tag values containing / (a forward slash) exist
as file paths
.IP \[bu] 2
\f[B]fancyassertions\f[R] - more complex balance assertions are passing
.SS close .SS close
.PP .PP
close, equity close, equity

478
hledger/hledger.info
View File

@ -1017,8 +1017,12 @@ without a lot of declarations:
With the '-s'/'--strict' flag, additional checks are performed: With the '-s'/'--strict' flag, additional checks are performed:
* Are all accounts referenced by transactions declared with an * Are all accounts posted to, declared with an 'account' directive ?
account directive ? (Account error checking)
* Are all commodities declared with a 'commodity' directive ?
(Commodity error checking)
See also: https://hledger.org/checking-for-errors.html
_experimental._ _experimental._
@ -1972,8 +1976,7 @@ detailed command help.
* balancesheet:: * balancesheet::
* balancesheetequity:: * balancesheetequity::
* cashflow:: * cashflow::
* check-dates:: * check::
* check-dupes::
* close:: * close::
* codes:: * codes::
* commodities:: * commodities::
@ -2921,7 +2924,7 @@ options The output formats supported are 'txt', 'csv', 'html', and
(experimental) 'json'. (experimental) 'json'.
 
File: hledger.info, Node: cashflow, Next: check-dates, Prev: balancesheetequity, Up: COMMANDS File: hledger.info, Node: cashflow, Next: check, Prev: balancesheetequity, Up: COMMANDS
3.8 cashflow 3.8 cashflow
============ ============
@ -2963,34 +2966,63 @@ options The output formats supported are 'txt', 'csv', 'html', and
(experimental) 'json'. (experimental) 'json'.
 
File: hledger.info, Node: check-dates, Next: check-dupes, Prev: cashflow, Up: COMMANDS File: hledger.info, Node: check, Next: close, Prev: cashflow, Up: COMMANDS
3.9 check-dates 3.9 check
=============== =========
check-dates check
Check that transactions are sorted by increasing date. With -date2, Check for various kinds of errors in your data.
checks secondary dates instead. With -strict, dates must also be
unique. With a query, only matched transactions' dates are checked. hledger provides a number of built-in error checks to help prevent
Reads the default journal file, or another specified with -f. problems in your data. Some, but not all, of these are run
automatically before all commands. You can also use this 'check'
command to run any of the available tests. They are named, and run, as
follows:
'hledger check' runs the basic checks, like all other commands, but
with no output unless there is a problem. These are:
* *parseable* - data files are well-formed and can be successfully
parsed
* *autobalanced* - all transactions are balanced, inferring missing
amounts where necessary, and possibly converting commodities using
transaction prices or automatically-inferred transaction prices
* *assertions* - all balance assertions are passing (except with
'-I'/'--ignore-assertions')
'hledger check --strict' also runs the additional "strict mode"
checks, which are:
* *accounts* - all account names used by transactions have been
declared
* *commodities* - all commodity symbols used have been declared
'hledger check CHECK1 CHECK2 ...' runs all of the named checks, in
turn. This may be useful when neither the default nor strict checks are
exactly what you want, or when you want to focus on a single check of
interest. The arguments are standard lowercase names for the checks.
Currently only these checks can be run in this way:
* *dates* - transactions are ordered by date (similar to the old
'check-dates' command)
* *leafnames* - all account leaf names are unique ((similar to the
old 'check-dupes' command)
See also:
Some checks are shipped as addon scripts for now (cf
https://github.com/simonmichael/hledger/tree/master/bin, and Cookbook ->
Scripting):
* *tagfiles* - all tag values containing / (a forward slash) exist as
file paths
* *fancyassertions* - more complex balance assertions are passing
 
File: hledger.info, Node: check-dupes, Next: close, Prev: check-dates, Up: COMMANDS File: hledger.info, Node: close, Next: codes, Prev: check, Up: COMMANDS
3.10 check-dupes 3.10 close
================
check-dupes
Reports account names having the same leaf but different prefixes. In
other words, two or more leaves that are categorized differently. Reads
the default journal file, or another specified as an argument.
An example: http://stefanorodighiero.net/software/hledger-dupes.html

File: hledger.info, Node: close, Next: codes, Prev: check-dupes, Up: COMMANDS
3.11 close
========== ==========
close, equity close, equity
@ -3030,7 +3062,7 @@ you have many foreign currency or investment transactions.
 
File: hledger.info, Node: close usage, Up: close File: hledger.info, Node: close usage, Up: close
3.11.1 close usage 3.10.1 close usage
------------------ ------------------
If you split your journal files by time (eg yearly), you will typically If you split your journal files by time (eg yearly), you will typically
@ -3101,7 +3133,7 @@ breaking balance assertions:
 
File: hledger.info, Node: codes, Next: commodities, Prev: close, Up: COMMANDS File: hledger.info, Node: codes, Next: commodities, Prev: close, Up: COMMANDS
3.12 codes 3.11 codes
========== ==========
codes codes
@ -3147,7 +3179,7 @@ $ hledger codes -E
 
File: hledger.info, Node: commodities, Next: descriptions, Prev: codes, Up: COMMANDS File: hledger.info, Node: commodities, Next: descriptions, Prev: codes, Up: COMMANDS
3.13 commodities 3.12 commodities
================ ================
commodities commodities
@ -3156,7 +3188,7 @@ List all commodity/currency symbols used or declared in the journal.
 
File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: COMMANDS File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: COMMANDS
3.14 descriptions 3.13 descriptions
================= =================
descriptions descriptions
@ -3176,7 +3208,7 @@ Person A
 
File: hledger.info, Node: diff, Next: files, Prev: descriptions, Up: COMMANDS File: hledger.info, Node: diff, Next: files, Prev: descriptions, Up: COMMANDS
3.15 diff 3.14 diff
========= =========
diff diff
@ -3211,7 +3243,7 @@ These transactions are in the second file only:
 
File: hledger.info, Node: files, Next: help, Prev: diff, Up: COMMANDS File: hledger.info, Node: files, Next: help, Prev: diff, Up: COMMANDS
3.16 files 3.15 files
========== ==========
files files
@ -3221,7 +3253,7 @@ file names matching the regular expression (case sensitive) are shown.
 
File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS
3.17 help 3.16 help
========= =========
help help
@ -3261,7 +3293,7 @@ DESCRIPTION
 
File: hledger.info, Node: import, Next: incomestatement, Prev: help, Up: COMMANDS File: hledger.info, Node: import, Next: incomestatement, Prev: help, Up: COMMANDS
3.18 import 3.17 import
=========== ===========
import import
@ -3291,7 +3323,7 @@ $ hledger import --dry ... | hledger -f- print unknown --ignore-assertions
 
File: hledger.info, Node: Importing balance assignments, Next: Commodity display styles, Up: import File: hledger.info, Node: Importing balance assignments, Next: Commodity display styles, Up: import
3.18.1 Importing balance assignments 3.17.1 Importing balance assignments
------------------------------------ ------------------------------------
Entries added by import will have their posting amounts made explicit Entries added by import will have their posting amounts made explicit
@ -3310,7 +3342,7 @@ please test it and send a pull request.)
 
File: hledger.info, Node: Commodity display styles, Prev: Importing balance assignments, Up: import File: hledger.info, Node: Commodity display styles, Prev: Importing balance assignments, Up: import
3.18.2 Commodity display styles 3.17.2 Commodity display styles
------------------------------- -------------------------------
Imported amounts will be formatted according to the canonical commodity Imported amounts will be formatted according to the canonical commodity
@ -3319,7 +3351,7 @@ styles (declared or inferred) in the main journal file.
 
File: hledger.info, Node: incomestatement, Next: notes, Prev: import, Up: COMMANDS File: hledger.info, Node: incomestatement, Next: notes, Prev: import, Up: COMMANDS
3.19 incomestatement 3.18 incomestatement
==================== ====================
incomestatement, is incomestatement, is
@ -3369,7 +3401,7 @@ options The output formats supported are 'txt', 'csv', 'html', and
 
File: hledger.info, Node: notes, Next: payees, Prev: incomestatement, Up: COMMANDS File: hledger.info, Node: notes, Next: payees, Prev: incomestatement, Up: COMMANDS
3.20 notes 3.19 notes
========== ==========
notes notes
@ -3389,7 +3421,7 @@ Snacks
 
File: hledger.info, Node: payees, Next: prices, Prev: notes, Up: COMMANDS File: hledger.info, Node: payees, Next: prices, Prev: notes, Up: COMMANDS
3.21 payees 3.20 payees
=========== ===========
payees payees
@ -3411,7 +3443,7 @@ Person A
 
File: hledger.info, Node: prices, Next: print, Prev: payees, Up: COMMANDS File: hledger.info, Node: prices, Next: print, Prev: payees, Up: COMMANDS
3.22 prices 3.21 prices
=========== ===========
prices prices
@ -3424,7 +3456,7 @@ Price amounts are always displayed with their full precision.
 
File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMANDS File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMANDS
3.23 print 3.22 print
========== ==========
print, txns, p print, txns, p
@ -3533,7 +3565,7 @@ $ hledger print -Ocsv
 
File: hledger.info, Node: print-unique, Next: register, Prev: print, Up: COMMANDS File: hledger.info, Node: print-unique, Next: register, Prev: print, Up: COMMANDS
3.24 print-unique 3.23 print-unique
================= =================
print-unique print-unique
@ -3554,7 +3586,7 @@ $ LEDGER_FILE=unique.journal hledger print-unique
 
File: hledger.info, Node: register, Next: register-match, Prev: print-unique, Up: COMMANDS File: hledger.info, Node: register, Next: register-match, Prev: print-unique, Up: COMMANDS
3.25 register 3.24 register
============= =============
register, reg, r register, reg, r
@ -3652,7 +3684,7 @@ length and comparable to the others in the report.
 
File: hledger.info, Node: Custom register output, Up: register File: hledger.info, Node: Custom register output, Up: register
3.25.1 Custom register output 3.24.1 Custom register output
----------------------------- -----------------------------
register uses the full terminal width by default, except on windows. register uses the full terminal width by default, except on windows.
@ -3684,7 +3716,7 @@ options The output formats supported are 'txt', 'csv', and
 
File: hledger.info, Node: register-match, Next: rewrite, Prev: register, Up: COMMANDS File: hledger.info, Node: register-match, Next: rewrite, Prev: register, Up: COMMANDS
3.26 register-match 3.25 register-match
=================== ===================
register-match register-match
@ -3697,7 +3729,7 @@ ledger-autosync detect already-seen transactions when importing.
 
File: hledger.info, Node: rewrite, Next: roi, Prev: register-match, Up: COMMANDS File: hledger.info, Node: rewrite, Next: roi, Prev: register-match, Up: COMMANDS
3.27 rewrite 3.26 rewrite
============ ============
rewrite rewrite
@ -3749,7 +3781,7 @@ commodity.
 
File: hledger.info, Node: Re-write rules in a file, Up: rewrite File: hledger.info, Node: Re-write rules in a file, Up: rewrite
3.27.1 Re-write rules in a file 3.26.1 Re-write rules in a file
------------------------------- -------------------------------
During the run this tool will execute so called "Automated Transactions" During the run this tool will execute so called "Automated Transactions"
@ -3792,7 +3824,7 @@ postings.
 
File: hledger.info, Node: Diff output format, Next: rewrite vs print --auto, Up: Re-write rules in a file File: hledger.info, Node: Diff output format, Next: rewrite vs print --auto, Up: Re-write rules in a file
3.27.1.1 Diff output format 3.26.1.1 Diff output format
........................... ...........................
To use this tool for batch modification of your journal files you may To use this tool for batch modification of your journal files you may
@ -3833,7 +3865,7 @@ output from 'hledger print'.
 
File: hledger.info, Node: rewrite vs print --auto, Prev: Diff output format, Up: Re-write rules in a file File: hledger.info, Node: rewrite vs print --auto, Prev: Diff output format, Up: Re-write rules in a file
3.27.1.2 rewrite vs. print -auto 3.26.1.2 rewrite vs. print -auto
................................ ................................
This command predates print -auto, and currently does much the same This command predates print -auto, and currently does much the same
@ -3853,7 +3885,7 @@ thing, but with these differences:
 
File: hledger.info, Node: roi, Next: stats, Prev: rewrite, Up: COMMANDS File: hledger.info, Node: roi, Next: stats, Prev: rewrite, Up: COMMANDS
3.28 roi 3.27 roi
======== ========
roi roi
@ -4109,7 +4141,7 @@ $ hledger roi -Y --inv investment --pnl "unrealized"
 
File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: COMMANDS File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: COMMANDS
3.29 stats 3.28 stats
========== ==========
stats stats
@ -4140,7 +4172,7 @@ selection.
 
File: hledger.info, Node: tags, Next: test, Prev: stats, Up: COMMANDS File: hledger.info, Node: tags, Next: test, Prev: stats, Up: COMMANDS
3.30 tags 3.29 tags
========= =========
tags tags
@ -4160,7 +4192,7 @@ they are omitted.
 
File: hledger.info, Node: test, Next: Add-on commands, Prev: tags, Up: COMMANDS File: hledger.info, Node: test, Next: Add-on commands, Prev: tags, Up: COMMANDS
3.31 test 3.30 test
========= =========
test test
@ -4187,7 +4219,7 @@ $ hledger test -- -pData.Amount --color=never
 
File: hledger.info, Node: Add-on commands, Prev: test, Up: COMMANDS File: hledger.info, Node: Add-on commands, Prev: test, Up: COMMANDS
3.32 Add-on commands 3.31 Add-on commands
==================== ====================
hledger also searches for external add-on commands, and will include hledger also searches for external add-on commands, and will include
@ -4228,7 +4260,7 @@ interfaces. These are maintained and released along with hledger:
 
File: hledger.info, Node: ui, Next: web, Up: Add-on commands File: hledger.info, Node: ui, Next: web, Up: Add-on commands
3.32.1 ui 3.31.1 ui
--------- ---------
hledger-ui provides an efficient terminal interface. hledger-ui provides an efficient terminal interface.
@ -4236,7 +4268,7 @@ hledger-ui provides an efficient terminal interface.
 
File: hledger.info, Node: web, Next: iadd, Prev: ui, Up: Add-on commands File: hledger.info, Node: web, Next: iadd, Prev: ui, Up: Add-on commands
3.32.2 web 3.31.2 web
---------- ----------
hledger-web provides a simple web interface. hledger-web provides a simple web interface.
@ -4246,7 +4278,7 @@ hledger-web provides a simple web interface.
 
File: hledger.info, Node: iadd, Next: interest, Prev: web, Up: Add-on commands File: hledger.info, Node: iadd, Next: interest, Prev: web, Up: Add-on commands
3.32.3 iadd 3.31.3 iadd
----------- -----------
hledger-iadd is a more interactive, terminal UI replacement for the add hledger-iadd is a more interactive, terminal UI replacement for the add
@ -4255,7 +4287,7 @@ command.
 
File: hledger.info, Node: interest, Prev: iadd, Up: Add-on commands File: hledger.info, Node: interest, Prev: iadd, Up: Add-on commands
3.32.4 interest 3.31.4 interest
--------------- ---------------
hledger-interest generates interest transactions for an account hledger-interest generates interest transactions for an account
@ -4454,170 +4486,168 @@ Node: Input files30574
Ref: #input-files30710 Ref: #input-files30710
Node: Strict mode33009 Node: Strict mode33009
Ref: #strict-mode33145 Ref: #strict-mode33145
Node: Output destination33626 Node: Output destination33793
Ref: #output-destination33778 Ref: #output-destination33945
Node: Output format34203 Node: Output format34370
Ref: #output-format34355 Ref: #output-format34522
Node: Regular expressions36522 Node: Regular expressions36689
Ref: #regular-expressions36679 Ref: #regular-expressions36846
Node: Smart dates38415 Node: Smart dates38582
Ref: #smart-dates38566 Ref: #smart-dates38733
Node: Report start & end date39927 Node: Report start & end date40094
Ref: #report-start-end-date40099 Ref: #report-start-end-date40266
Node: Report intervals41596 Node: Report intervals41763
Ref: #report-intervals41761 Ref: #report-intervals41928
Node: Period expressions42151 Node: Period expressions42318
Ref: #period-expressions42311 Ref: #period-expressions42478
Node: Depth limiting46684 Node: Depth limiting46851
Ref: #depth-limiting46828 Ref: #depth-limiting46995
Node: Pivoting47160 Node: Pivoting47327
Ref: #pivoting47283 Ref: #pivoting47450
Node: Valuation48959 Node: Valuation49126
Ref: #valuation49061 Ref: #valuation49228
Node: -B Cost49750 Node: -B Cost49917
Ref: #b-cost49854 Ref: #b-cost50021
Node: -V Value49987 Node: -V Value50154
Ref: #v-value50133 Ref: #v-value50300
Node: -X Value in specified commodity50328 Node: -X Value in specified commodity50495
Ref: #x-value-in-specified-commodity50527 Ref: #x-value-in-specified-commodity50694
Node: Valuation date50676 Node: Valuation date50843
Ref: #valuation-date50844 Ref: #valuation-date51011
Node: Market prices51266 Node: Market prices51433
Ref: #market-prices51446 Ref: #market-prices51613
Node: --infer-value market prices from transactions52388 Node: --infer-value market prices from transactions52555
Ref: #infer-value-market-prices-from-transactions52637 Ref: #infer-value-market-prices-from-transactions52804
Node: Valuation commodity53919 Node: Valuation commodity54086
Ref: #valuation-commodity54128 Ref: #valuation-commodity54295
Node: Simple valuation examples55354 Node: Simple valuation examples55521
Ref: #simple-valuation-examples55556 Ref: #simple-valuation-examples55723
Node: --value Flexible valuation56215 Node: --value Flexible valuation56382
Ref: #value-flexible-valuation56423 Ref: #value-flexible-valuation56590
Node: More valuation examples58370 Node: More valuation examples58537
Ref: #more-valuation-examples58579 Ref: #more-valuation-examples58746
Node: Effect of valuation on reports60584 Node: Effect of valuation on reports60751
Ref: #effect-of-valuation-on-reports60772 Ref: #effect-of-valuation-on-reports60939
Node: COMMANDS67791 Node: COMMANDS67958
Ref: #commands67899 Ref: #commands68066
Node: accounts69007 Node: accounts69152
Ref: #accounts69105 Ref: #accounts69250
Node: activity69804 Node: activity69949
Ref: #activity69914 Ref: #activity70059
Node: add70297 Node: add70442
Ref: #add70398 Ref: #add70543
Node: aregister73191 Node: aregister73336
Ref: #aregister73303 Ref: #aregister73448
Node: aregister and custom posting dates74676 Node: aregister and custom posting dates74821
Ref: #aregister-and-custom-posting-dates74849 Ref: #aregister-and-custom-posting-dates74994
Ref: #output-format-175442 Ref: #output-format-175587
Node: balance75847 Node: balance75992
Ref: #balance75964 Ref: #balance76109
Node: Classic balance report77444 Node: Classic balance report77589
Ref: #classic-balance-report77617 Ref: #classic-balance-report77762
Node: Customising the classic balance report78941 Node: Customising the classic balance report79086
Ref: #customising-the-classic-balance-report79169 Ref: #customising-the-classic-balance-report79314
Node: Colour support81245 Node: Colour support81390
Ref: #colour-support81412 Ref: #colour-support81557
Node: Flat mode81508 Node: Flat mode81653
Ref: #flat-mode81656 Ref: #flat-mode81801
Node: Depth limited balance reports82069 Node: Depth limited balance reports82214
Ref: #depth-limited-balance-reports82254 Ref: #depth-limited-balance-reports82399
Node: Percentages82710 Node: Percentages82855
Ref: #percentages82867 Ref: #percentages83012
Node: Sorting by amount84004 Node: Sorting by amount84149
Ref: #sorting-by-amount84170 Ref: #sorting-by-amount84315
Node: Multicolumn balance report84664 Node: Multicolumn balance report84809
Ref: #multicolumn-balance-report84850 Ref: #multicolumn-balance-report84995
Node: Budget report90447 Node: Budget report90592
Ref: #budget-report90590 Ref: #budget-report90735
Node: Budget report start date95879 Node: Budget report start date96024
Ref: #budget-report-start-date96044 Ref: #budget-report-start-date96189
Node: Nested budgets97376 Node: Nested budgets97521
Ref: #nested-budgets97521 Ref: #nested-budgets97666
Ref: #output-format-2101004 Ref: #output-format-2101149
Node: balancesheet101165 Node: balancesheet101310
Ref: #balancesheet101301 Ref: #balancesheet101446
Node: balancesheetequity102813 Node: balancesheetequity102958
Ref: #balancesheetequity102962 Ref: #balancesheetequity103107
Node: cashflow104038 Node: cashflow104183
Ref: #cashflow104166 Ref: #cashflow104305
Node: check-dates105382 Node: check105521
Ref: #check-dates105509 Ref: #check105624
Node: check-dupes105788 Node: close107565
Ref: #check-dupes105914 Ref: #close107667
Node: close106207 Node: close usage109189
Ref: #close106315 Ref: #close-usage109282
Node: close usage107837 Node: codes112095
Ref: #close-usage107930 Ref: #codes112203
Node: codes110743 Node: commodities112915
Ref: #codes110851 Ref: #commodities113042
Node: commodities111563 Node: descriptions113124
Ref: #commodities111690 Ref: #descriptions113252
Node: descriptions111772 Node: diff113556
Ref: #descriptions111900 Ref: #diff113662
Node: diff112204 Node: files114709
Ref: #diff112310 Ref: #files114809
Node: files113357 Node: help114956
Ref: #files113457 Ref: #help115056
Node: help113604 Node: import116137
Ref: #help113704 Ref: #import116251
Node: import114785 Node: Importing balance assignments117173
Ref: #import114899 Ref: #importing-balance-assignments117354
Node: Importing balance assignments115821 Node: Commodity display styles118003
Ref: #importing-balance-assignments116002 Ref: #commodity-display-styles118174
Node: Commodity display styles116651 Node: incomestatement118303
Ref: #commodity-display-styles116822 Ref: #incomestatement118436
Node: incomestatement116951 Node: notes119781
Ref: #incomestatement117084 Ref: #notes119894
Node: notes118429 Node: payees120262
Ref: #notes118542 Ref: #payees120368
Node: payees118910 Node: prices120788
Ref: #payees119016 Ref: #prices120894
Node: prices119436 Node: print121235
Ref: #prices119542 Ref: #print121345
Node: print119883 Node: print-unique126141
Ref: #print119993 Ref: #print-unique126267
Node: print-unique124789 Node: register126552
Ref: #print-unique124915 Ref: #register126679
Node: register125200 Node: Custom register output131128
Ref: #register125327 Ref: #custom-register-output131257
Node: Custom register output129776 Node: register-match132594
Ref: #custom-register-output129905 Ref: #register-match132728
Node: register-match131242 Node: rewrite133079
Ref: #register-match131376 Ref: #rewrite133194
Node: rewrite131727 Node: Re-write rules in a file135049
Ref: #rewrite131842 Ref: #re-write-rules-in-a-file135183
Node: Re-write rules in a file133697 Node: Diff output format136393
Ref: #re-write-rules-in-a-file133831 Ref: #diff-output-format136562
Node: Diff output format135041 Node: rewrite vs print --auto137654
Ref: #diff-output-format135210 Ref: #rewrite-vs.-print---auto137833
Node: rewrite vs print --auto136302 Node: roi138389
Ref: #rewrite-vs.-print---auto136481 Ref: #roi138487
Node: roi137037 Node: stats150697
Ref: #roi137135 Ref: #stats150796
Node: stats149345 Node: tags151584
Ref: #stats149444 Ref: #tags151682
Node: tags150232 Node: test152201
Ref: #tags150330 Ref: #test152309
Node: test150849 Node: Add-on commands153056
Ref: #test150957 Ref: #add-on-commands153173
Node: Add-on commands151704 Node: ui154516
Ref: #add-on-commands151821 Ref: #ui154604
Node: ui153164 Node: web154658
Ref: #ui153252 Ref: #web154761
Node: web153306 Node: iadd154877
Ref: #web153409 Ref: #iadd154988
Node: iadd153525 Node: interest155070
Ref: #iadd153636 Ref: #interest155177
Node: interest153718 Node: ENVIRONMENT155417
Ref: #interest153825 Ref: #environment155529
Node: ENVIRONMENT154065 Node: FILES156514
Ref: #environment154177 Ref: #files-1156617
Node: FILES155162 Node: LIMITATIONS156830
Ref: #files-1155265 Ref: #limitations156949
Node: LIMITATIONS155478 Node: TROUBLESHOOTING157691
Ref: #limitations155597 Ref: #troubleshooting157804
Node: TROUBLESHOOTING156339
Ref: #troubleshooting156452
 
End Tag Table End Tag Table

76
hledger/hledger.txt
View File

@ -870,8 +870,13 @@ OPTIONS
With the -s/--strict flag, additional checks are performed: With the -s/--strict flag, additional checks are performed:
o Are all accounts referenced by transactions declared with an account o Are all accounts posted to, declared with an account directive ?
directive ? (Account error checking)
o Are all commodities declared with a commodity directive ? (Commodity
error checking)
See also: https://hledger.org/checking-for-errors.html
experimental. experimental.
@ -998,12 +1003,12 @@ OPTIONS
10/1 month and day in current year 10/1 month and day in current year
21 day in current month 21 day in current month
october, oct start of month in current year october, oct start of month in current year
yesterday, today, tomor- -1, 0, 1 days from today yesterday, today, tomor- -1, 0, 1 days from today
row row
last/this/next -1, 0, 1 periods from the current period last/this/next -1, 0, 1 periods from the current period
day/week/month/quar- day/week/month/quar-
ter/year ter/year
20181201 8 digit YYYYMMDD with valid year month and day 20181201 8 digit YYYYMMDD with valid year month and day
201812 6 digit YYYYMM with valid year and month 201812 6 digit YYYYMM with valid year and month
@ -1139,7 +1144,6 @@ OPTIONS
2008/11/25" 2008/11/25"
-p "quarterly from starts on 2009/04/01, ends on 2009/06/30, -p "quarterly from starts on 2009/04/01, ends on 2009/06/30,
2009-05-05 to 2009-06-01" which are first and last days of Q2 2009 2009-05-05 to 2009-06-01" which are first and last days of Q2 2009
-p "yearly from starts on 2009/01/01, first day of 2009 -p "yearly from starts on 2009/01/01, first day of 2009
2009-12-29" 2009-12-29"
@ -1616,6 +1620,10 @@ OPTIONS
start start start start
balance sums of costs same as not sup- balance value at balance sums of costs same as not sup- balance value at
changes of postings --value=end ported change in DATE/today of changes of postings --value=end ported change in DATE/today of
(bal, is, in period each period, sums of post- (bal, is, in period each period, sums of post-
@ -2547,20 +2555,56 @@ COMMANDS
tions The output formats supported are txt, csv, html, and (experimen- tions The output formats supported are txt, csv, html, and (experimen-
tal) json. tal) json.
check-dates check
check-dates check
Check that transactions are sorted by increasing date. With --date2, Check for various kinds of errors in your data.
checks secondary dates instead. With --strict, dates must also be
unique. With a query, only matched transactions' dates are checked.
Reads the default journal file, or another specified with -f.
check-dupes hledger provides a number of built-in error checks to help prevent
check-dupes problems in your data. Some, but not all, of these are run automati-
Reports account names having the same leaf but different prefixes. In cally before all commands. You can also use this check command to run
other words, two or more leaves that are categorized differently. any of the available tests. They are named, and run, as follows:
Reads the default journal file, or another specified as an argument.
An example: http://stefanorodighiero.net/software/hledger-dupes.html hledger check runs the basic checks, like all other commands, but with
no output unless there is a problem. These are:
o parseable - data files are well-formed and can be successfully parsed
o autobalanced - all transactions are balanced, inferring missing
amounts where necessary, and possibly converting commodities using
transaction prices or automatically-inferred transaction prices
o assertions - all balance assertions are passing (except with -I/--ig-
nore-assertions)
hledger check --strict also runs the additional "strict mode" checks,
which are:
o accounts - all account names used by transactions have been declared
o commodities - all commodity symbols used have been declared
hledger check CHECK1 CHECK2 ... runs all of the named checks, in turn.
This may be useful when neither the default nor strict checks are ex-
actly what you want, or when you want to focus on a single check of in-
terest. The arguments are standard lowercase names for the checks.
Currently only these checks can be run in this way:
o dates - transactions are ordered by date (similar to the old check-
dates command)
o leafnames - all account leaf names are unique ((similar to the old
check-dupes command)
See also:
Some checks are shipped as addon scripts for now (cf
https://github.com/simonmichael/hledger/tree/master/bin, and Cookbook
-> Scripting):
o tagfiles - all tag values containing / (a forward slash) exist as
file paths
o fancyassertions - more complex balance assertions are passing
close close
close, equity close, equity