;doc: fix flags marker appearing in manuals
$FLAGS$ didn't work (nor =FLAGS=); _FLAGS it is.. [ci skip]
This commit is contained in:
parent
95f1172c1b
commit
4a7a700d93
@ -209,7 +209,9 @@ The journal file path when not specified with `-f`.
|
|||||||
Default: `~/.hledger.journal` (on windows, perhaps `C:/Users/USER/.hledger.journal`).
|
Default: `~/.hledger.journal` (on windows, perhaps `C:/Users/USER/.hledger.journal`).
|
||||||
}} )m4_dnl
|
}} )m4_dnl
|
||||||
m4_dnl
|
m4_dnl
|
||||||
m4_dnl Dummy macro to strip $FLAGS$ marker in command docs.
|
m4_dnl The _FLAGS marker is used in generating command help (see
|
||||||
m4_dnl Not using underscore here, because latest pandoc strips those.
|
m4_dnl CliOptions.parseCommandDoc), but should be removed when generating manuals.
|
||||||
m4_define({{$FLAGS$}}, {{}})m4_dnl
|
m4_dnl Just one underscore here, so pandoc doesn't strip them
|
||||||
|
m4_dnl ($FLAGS$ and =FLAGS= didn't work, not sure why).
|
||||||
|
m4_define({{_FLAGS}}, {{}})m4_dnl
|
||||||
m4_dnl
|
m4_dnl
|
||||||
|
|||||||
@ -303,9 +303,9 @@ hledgerCommandMode doc unnamedflaggroup namedflaggroups hiddenflaggroup argsdesc
|
|||||||
--
|
--
|
||||||
-- - First line: the command name then any aliases, as one or more space or comma-separated words
|
-- - First line: the command name then any aliases, as one or more space or comma-separated words
|
||||||
--
|
--
|
||||||
-- - Second line to a line containing just $FLAGS$, or the end: the short help
|
-- - Second line to a line containing just _FLAGS, or the end: the short help
|
||||||
--
|
--
|
||||||
-- - Any lines after $FLAGS$: the long help (split into lines for cmdargs)
|
-- - Any lines after _FLAGS: the long help (split into lines for cmdargs)
|
||||||
--
|
--
|
||||||
-- The CLI help displays the short help, then the cmdargs-generated
|
-- The CLI help displays the short help, then the cmdargs-generated
|
||||||
-- flags list, then the long help (which some day we might make
|
-- flags list, then the long help (which some day we might make
|
||||||
@ -319,7 +319,7 @@ parseCommandDoc t =
|
|||||||
(l:ls) -> Just (names, shorthelp, longhelplines)
|
(l:ls) -> Just (names, shorthelp, longhelplines)
|
||||||
where
|
where
|
||||||
names = words $ map (\c -> if c `elem` [',','\\'] then ' ' else c) l
|
names = words $ map (\c -> if c `elem` [',','\\'] then ' ' else c) l
|
||||||
(shorthelpls, longhelpls) = break (== "$FLAGS$") ls
|
(shorthelpls, longhelpls) = break (== "_FLAGS") ls
|
||||||
shorthelp = unlines $ reverse $ dropWhile null $ reverse shorthelpls
|
shorthelp = unlines $ reverse $ dropWhile null $ reverse shorthelpls
|
||||||
longhelplines = dropWhile null $ drop 1 longhelpls
|
longhelplines = dropWhile null $ drop 1 longhelpls
|
||||||
|
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
accounts, a\
|
accounts, a\
|
||||||
Show account names.
|
Show account names.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command lists account names, either declared with account directives
|
This command lists account names, either declared with account directives
|
||||||
(--declared), posted to (--used), or both (the default).
|
(--declared), posted to (--used), or both (the default).
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
accounts, a
|
accounts, a
|
||||||
Show account names.
|
Show account names.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command lists account names, either declared with account
|
This command lists account names, either declared with account
|
||||||
directives (--declared), posted to (--used), or both (the default). With
|
directives (--declared), posted to (--used), or both (the default). With
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
activity\
|
activity\
|
||||||
Show an ascii barchart of posting counts per interval.
|
Show an ascii barchart of posting counts per interval.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The activity command displays an ascii histogram showing transaction
|
The activity command displays an ascii histogram showing transaction
|
||||||
counts by day, week, month or other reporting interval (by day is the
|
counts by day, week, month or other reporting interval (by day is the
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
activity
|
activity
|
||||||
Show an ascii barchart of posting counts per interval.
|
Show an ascii barchart of posting counts per interval.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The activity command displays an ascii histogram showing transaction
|
The activity command displays an ascii histogram showing transaction
|
||||||
counts by day, week, month or other reporting interval (by day is the
|
counts by day, week, month or other reporting interval (by day is the
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
add\
|
add\
|
||||||
Prompt for transactions and add them to the journal.
|
Prompt for transactions and add them to the journal.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Many hledger users edit their journals directly with a text editor, or generate them from CSV.
|
Many hledger users edit their journals directly with a text editor, or generate them from CSV.
|
||||||
For more interactive data entry, there is the `add` command,
|
For more interactive data entry, there is the `add` command,
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
add
|
add
|
||||||
Prompt for transactions and add them to the journal.
|
Prompt for transactions and add them to the journal.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Many hledger users edit their journals directly with a text editor, or
|
Many hledger users edit their journals directly with a text editor, or
|
||||||
generate them from CSV. For more interactive data entry, there is the
|
generate them from CSV. For more interactive data entry, there is the
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
balance, bal, b\
|
balance, bal, b\
|
||||||
Show accounts and their balances.
|
Show accounts and their balances.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The balance command is hledger's most versatile command.
|
The balance command is hledger's most versatile command.
|
||||||
Note, despite the name, it is not always used for showing real-world account balances;
|
Note, despite the name, it is not always used for showing real-world account balances;
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
balance, bal, b
|
balance, bal, b
|
||||||
Show accounts and their balances.
|
Show accounts and their balances.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The balance command is hledger's most versatile command. Note, despite
|
The balance command is hledger's most versatile command. Note, despite
|
||||||
the name, it is not always used for showing real-world account balances;
|
the name, it is not always used for showing real-world account balances;
|
||||||
|
|||||||
@ -8,7 +8,7 @@ Note this report shows all account balances with normal positive sign
|
|||||||
(like conventional financial statements, unlike balance/print/register)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|||||||
@ -8,7 +8,7 @@ Note this report shows all account balances with normal positive sign
|
|||||||
(like conventional financial statements, unlike balance/print/register)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|||||||
@ -2,7 +2,7 @@ balancesheetequity, bse\
|
|||||||
Just like [balancesheet](#balancesheet), but also reports Equity
|
Just like [balancesheet](#balancesheet), but also reports Equity
|
||||||
(which it assumes is under a top-level `equity` account).
|
(which it assumes is under a top-level `equity` account).
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
```shell
|
```shell
|
||||||
|
|||||||
@ -2,7 +2,7 @@ balancesheetequity, bse
|
|||||||
Just like balancesheet, but also reports Equity (which it assumes is
|
Just like balancesheet, but also reports Equity (which it assumes is
|
||||||
under a top-level equity account).
|
under a top-level equity account).
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|||||||
@ -7,7 +7,7 @@ Note this report shows all account balances with normal positive sign
|
|||||||
(like conventional financial statements, unlike balance/print/register)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
```shell
|
```shell
|
||||||
|
|||||||
@ -6,7 +6,7 @@ contain receivable or A/R in their name. Note this report shows all
|
|||||||
account balances with normal positive sign (like conventional financial
|
account balances with normal positive sign (like conventional financial
|
||||||
statements, unlike balance/print/register) (experimental).
|
statements, unlike balance/print/register) (experimental).
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|||||||
@ -5,4 +5,4 @@ With --strict, dates must also be unique.
|
|||||||
With a query, only matched transactions' dates are checked.
|
With a query, only matched transactions' dates are checked.
|
||||||
Reads the default journal file, or another specified with -f.
|
Reads the default journal file, or another specified with -f.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -4,4 +4,4 @@ checks secondary dates instead. With --strict, dates must also be
|
|||||||
unique. With a query, only matched transactions' dates are checked.
|
unique. With a query, only matched transactions' dates are checked.
|
||||||
Reads the default journal file, or another specified with -f.
|
Reads the default journal file, or another specified with -f.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -3,6 +3,6 @@ Reports account names having the same leaf but different prefixes.
|
|||||||
In other words, two or more leaves that are categorized differently.
|
In other words, two or more leaves that are categorized differently.
|
||||||
Reads the default journal file, or another specified as an argument.
|
Reads the default journal file, or another specified as an argument.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
||||||
|
|||||||
@ -3,6 +3,6 @@ Reports account names having the same leaf but different prefixes. In
|
|||||||
other words, two or more leaves that are categorized differently. Reads
|
other words, two or more leaves that are categorized differently. Reads
|
||||||
the default journal file, or another specified as an argument.
|
the default journal file, or another specified as an argument.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
||||||
|
|||||||
@ -5,7 +5,7 @@ Useful for bringing asset/liability balances forward into a new journal file,
|
|||||||
or for closing out revenues/expenses to retained earnings at the end of a
|
or for closing out revenues/expenses to retained earnings at the end of a
|
||||||
period.
|
period.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The closing transaction transfers balances to "equity:closing balances",
|
The closing transaction transfers balances to "equity:closing balances",
|
||||||
and the opening transaction transfers balances from "equity:opening balances",
|
and the opening transaction transfers balances from "equity:opening balances",
|
||||||
|
|||||||
@ -5,7 +5,7 @@ Useful for bringing asset/liability balances forward into a new journal
|
|||||||
file, or for closing out revenues/expenses to retained earnings at the
|
file, or for closing out revenues/expenses to retained earnings at the
|
||||||
end of a period.
|
end of a period.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The closing transaction transfers balances to "equity:closing balances",
|
The closing transaction transfers balances to "equity:closing balances",
|
||||||
and the opening transaction transfers balances from "equity:opening
|
and the opening transaction transfers balances from "equity:opening
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
commodities\
|
commodities\
|
||||||
List all commodity/currency symbols used or declared in the journal.
|
List all commodity/currency symbols used or declared in the journal.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
commodities
|
commodities
|
||||||
List all commodity/currency symbols used or declared in the journal.
|
List all commodity/currency symbols used or declared in the journal.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
descriptions
|
descriptions
|
||||||
Show descriptions.
|
Show descriptions.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command lists all descriptions that appear in transactions.
|
This command lists all descriptions that appear in transactions.
|
||||||
|
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
descriptions Show descriptions.
|
descriptions Show descriptions.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command lists all descriptions that appear in transactions.
|
This command lists all descriptions that appear in transactions.
|
||||||
|
|
||||||
|
|||||||
@ -15,7 +15,7 @@ from your bank (eg as CSV data). When hledger and your bank disagree
|
|||||||
about the account balance, you can compare the bank data with your
|
about the account balance, you can compare the bank data with your
|
||||||
journal to find out the cause.
|
journal to find out the cause.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
|
|||||||
@ -14,7 +14,7 @@ your bank (eg as CSV data). When hledger and your bank disagree about
|
|||||||
the account balance, you can compare the bank data with your journal to
|
the account balance, you can compare the bank data with your journal to
|
||||||
find out the cause.
|
find out the cause.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
|
|||||||
@ -2,4 +2,4 @@ files\
|
|||||||
List all files included in the journal. With a REGEX argument,
|
List all files included in the journal. With a REGEX argument,
|
||||||
only file names matching the regular expression (case sensitive) are shown.
|
only file names matching the regular expression (case sensitive) are shown.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -2,4 +2,4 @@ files
|
|||||||
List all files included in the journal. With a REGEX argument, only file
|
List all files included in the journal. With a REGEX argument, only file
|
||||||
names matching the regular expression (case sensitive) are shown.
|
names matching the regular expression (case sensitive) are shown.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
help\
|
help\
|
||||||
Show any of the hledger manuals.
|
Show any of the hledger manuals.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The `help` command displays any of the main [hledger manuals](/docs.html), in one of several ways.
|
The `help` command displays any of the main [hledger manuals](/docs.html), in one of several ways.
|
||||||
Run it with no argument to list the manuals, or provide a full or partial manual name to select one.
|
Run it with no argument to list the manuals, or provide a full or partial manual name to select one.
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
help
|
help
|
||||||
Show any of the hledger manuals.
|
Show any of the hledger manuals.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The help command displays any of the main hledger manuals, in one of
|
The help command displays any of the main hledger manuals, in one of
|
||||||
several ways. Run it with no argument to list the manuals, or provide a
|
several ways. Run it with no argument to list the manuals, or provide a
|
||||||
|
|||||||
@ -4,7 +4,7 @@ the main journal file. Or with --dry-run, just print the transactions
|
|||||||
that would be added. Or with --catchup, just mark all of the FILEs'
|
that would be added. Or with --catchup, just mark all of the FILEs'
|
||||||
transactions as imported, without actually importing any.
|
transactions as imported, without actually importing any.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The input files are specified as arguments - no need to write -f before each one.
|
The input files are specified as arguments - no need to write -f before each one.
|
||||||
So eg to add new transactions from all CSV files to the main journal, it's just:
|
So eg to add new transactions from all CSV files to the main journal, it's just:
|
||||||
|
|||||||
@ -4,7 +4,7 @@ the main journal file. Or with --dry-run, just print the transactions
|
|||||||
that would be added. Or with --catchup, just mark all of the FILEs'
|
that would be added. Or with --catchup, just mark all of the FILEs'
|
||||||
transactions as imported, without actually importing any.
|
transactions as imported, without actually importing any.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The input files are specified as arguments - no need to write -f before
|
The input files are specified as arguments - no need to write -f before
|
||||||
each one. So eg to add new transactions from all CSV files to the main
|
each one. So eg to add new transactions from all CSV files to the main
|
||||||
|
|||||||
@ -7,7 +7,7 @@ Note this report shows all account balances with normal positive sign
|
|||||||
(like conventional financial statements, unlike balance/print/register)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command displays a simple
|
This command displays a simple
|
||||||
[income statement](http://en.wikipedia.org/wiki/Income_statement). It
|
[income statement](http://en.wikipedia.org/wiki/Income_statement). It
|
||||||
|
|||||||
@ -6,7 +6,7 @@ forms also allowed). Note this report shows all account balances with
|
|||||||
normal positive sign (like conventional financial statements, unlike
|
normal positive sign (like conventional financial statements, unlike
|
||||||
balance/print/register) (experimental).
|
balance/print/register) (experimental).
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command displays a simple income statement. It currently assumes
|
This command displays a simple income statement. It currently assumes
|
||||||
that you have top-level accounts named income (or revenue) and expense
|
that you have top-level accounts named income (or revenue) and expense
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
notes
|
notes
|
||||||
Show notes.
|
Show notes.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command lists all notes that appear in transactions.
|
This command lists all notes that appear in transactions.
|
||||||
|
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
notes Show notes.
|
notes Show notes.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command lists all notes that appear in transactions.
|
This command lists all notes that appear in transactions.
|
||||||
|
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
payees
|
payees
|
||||||
Show payee names.
|
Show payee names.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command lists all payee names that appear in transactions.
|
This command lists all payee names that appear in transactions.
|
||||||
|
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
payees Show payee names.
|
payees Show payee names.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command lists all payee names that appear in transactions.
|
This command lists all payee names that appear in transactions.
|
||||||
|
|
||||||
|
|||||||
@ -5,4 +5,4 @@ With --inverted-costs, also print inverse prices based on transaction prices.
|
|||||||
Prices (and postings providing prices) can be filtered by a query.
|
Prices (and postings providing prices) can be filtered by a query.
|
||||||
Price amounts are always displayed with their full precision.
|
Price amounts are always displayed with their full precision.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -5,4 +5,4 @@ synthetic market prices based on transaction prices. With
|
|||||||
Prices (and postings providing prices) can be filtered by a query. Price
|
Prices (and postings providing prices) can be filtered by a query. Price
|
||||||
amounts are always displayed with their full precision.
|
amounts are always displayed with their full precision.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
print, txns, p\
|
print, txns, p\
|
||||||
Show transaction journal entries, sorted by date.
|
Show transaction journal entries, sorted by date.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The print command displays full journal entries (transactions) from
|
The print command displays full journal entries (transactions) from
|
||||||
the journal file in date order, tidily formatted.
|
the journal file in date order, tidily formatted.
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
print, txns, p
|
print, txns, p
|
||||||
Show transaction journal entries, sorted by date.
|
Show transaction journal entries, sorted by date.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The print command displays full journal entries (transactions) from the
|
The print command displays full journal entries (transactions) from the
|
||||||
journal file in date order, tidily formatted. With --date2, transactions
|
journal file in date order, tidily formatted. With --date2, transactions
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
print-unique\
|
print-unique\
|
||||||
Print transactions which do not reuse an already-seen description.
|
Print transactions which do not reuse an already-seen description.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
print-unique
|
print-unique
|
||||||
Print transactions which do not reuse an already-seen description.
|
Print transactions which do not reuse an already-seen description.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|||||||
@ -58,12 +58,12 @@ Here are more special features/conventions of command doc files (see
|
|||||||
markdown formatting though, eg to define a list.
|
markdown formatting though, eg to define a list.
|
||||||
|
|
||||||
- After the short help, there should be a paragraph containing just
|
- After the short help, there should be a paragraph containing just
|
||||||
$FLAGS$. This marks the end of the short help, and it will be
|
_FLAGS. This marks the end of the short help, and it will be
|
||||||
replaced in command line help by the flags list. (Without it, the
|
replaced in command line help by the flags list. (Without it, the
|
||||||
flags list appears at the end of command line help.) The flags list
|
flags list appears at the end of command line help.) The flags list
|
||||||
will not appear in the hledger manual.
|
will not appear in the hledger manual.
|
||||||
|
|
||||||
- Long help (as many paragraphs as needed) follows the $FLAGS$ marker.
|
- Long help (as many paragraphs as needed) follows the _FLAGS marker.
|
||||||
This often ends with one or more examples.
|
This often ends with one or more examples.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
register, reg, r\
|
register, reg, r\
|
||||||
Show postings and their running total.
|
Show postings and their running total.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The register command displays postings in date order, one per line,
|
The register command displays postings in date order, one per line,
|
||||||
and their running total. This is typically used with a
|
and their running total. This is typically used with a
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
register, reg, r
|
register, reg, r
|
||||||
Show postings and their running total.
|
Show postings and their running total.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The register command displays postings in date order, one per line, and
|
The register command displays postings in date order, one per line, and
|
||||||
their running total. This is typically used with a query selecting a
|
their running total. This is typically used with a query selecting a
|
||||||
|
|||||||
@ -5,4 +5,4 @@ If there are multiple equally good matches, it shows the most recent.
|
|||||||
Query options (options, not arguments) can be used to restrict the search space.
|
Query options (options, not arguments) can be used to restrict the search space.
|
||||||
Helps ledger-autosync detect already-seen transactions when importing.
|
Helps ledger-autosync detect already-seen transactions when importing.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -5,4 +5,4 @@ matches, it shows the most recent. Query options (options, not
|
|||||||
arguments) can be used to restrict the search space. Helps
|
arguments) can be used to restrict the search space. Helps
|
||||||
ledger-autosync detect already-seen transactions when importing.
|
ledger-autosync detect already-seen transactions when importing.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -2,7 +2,7 @@ rewrite\
|
|||||||
Print all transactions, rewriting the postings of matched transactions.
|
Print all transactions, rewriting the postings of matched transactions.
|
||||||
For now the only rewrite available is adding new postings, like print --auto.
|
For now the only rewrite available is adding new postings, like print --auto.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This is a start at a generic rewriter of transaction entries.
|
This is a start at a generic rewriter of transaction entries.
|
||||||
It reads the default journal and prints the transactions, like print,
|
It reads the default journal and prints the transactions, like print,
|
||||||
|
|||||||
@ -3,7 +3,7 @@ Print all transactions, rewriting the postings of matched transactions.
|
|||||||
For now the only rewrite available is adding new postings, like print
|
For now the only rewrite available is adding new postings, like print
|
||||||
--auto.
|
--auto.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This is a start at a generic rewriter of transaction entries. It reads
|
This is a start at a generic rewriter of transaction entries. It reads
|
||||||
the default journal and prints the transactions, like print, but adds
|
the default journal and prints the transactions, like print, but adds
|
||||||
|
|||||||
@ -2,7 +2,7 @@ roi\
|
|||||||
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return
|
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return
|
||||||
on your investments.
|
on your investments.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command assumes that you have account(s) that hold nothing but
|
This command assumes that you have account(s) that hold nothing but
|
||||||
your investments and whenever you record current appraisal/valuation
|
your investments and whenever you record current appraisal/valuation
|
||||||
|
|||||||
@ -2,7 +2,7 @@ roi
|
|||||||
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
|
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
|
||||||
your investments.
|
your investments.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command assumes that you have account(s) that hold nothing but your
|
This command assumes that you have account(s) that hold nothing but your
|
||||||
investments and whenever you record current appraisal/valuation of these
|
investments and whenever you record current appraisal/valuation of these
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
stats\
|
stats\
|
||||||
Show some journal statistics.
|
Show some journal statistics.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The stats command displays summary information for the whole journal, or
|
The stats command displays summary information for the whole journal, or
|
||||||
a matched part of it. With a [reporting interval](#reporting-interval),
|
a matched part of it. With a [reporting interval](#reporting-interval),
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
stats
|
stats
|
||||||
Show some journal statistics.
|
Show some journal statistics.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
The stats command displays summary information for the whole journal, or
|
The stats command displays summary information for the whole journal, or
|
||||||
a matched part of it. With a reporting interval, it shows a report for
|
a matched part of it. With a reporting interval, it shows a report for
|
||||||
|
|||||||
@ -4,4 +4,4 @@ only tag names matching the regular expression (case insensitive) are shown.
|
|||||||
With QUERY arguments, only transactions matching the query are considered.
|
With QUERY arguments, only transactions matching the query are considered.
|
||||||
With --values flag, the tags' unique values are listed instead.
|
With --values flag, the tags' unique values are listed instead.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -5,4 +5,4 @@ shown. With QUERY arguments, only transactions matching the query are
|
|||||||
considered. With --values flag, the tags' unique values are listed
|
considered. With --values flag, the tags' unique values are listed
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
test\
|
test\
|
||||||
Run built-in unit tests.
|
Run built-in unit tests.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command runs the unit tests built in to hledger and hledger-lib,
|
This command runs the unit tests built in to hledger and hledger-lib,
|
||||||
printing the results on stdout. If any test fails, the exit code will
|
printing the results on stdout. If any test fails, the exit code will
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
test
|
test
|
||||||
Run built-in unit tests.
|
Run built-in unit tests.
|
||||||
|
|
||||||
$FLAGS$
|
_FLAGS
|
||||||
|
|
||||||
This command runs the unit tests built in to hledger and hledger-lib,
|
This command runs the unit tests built in to hledger and hledger-lib,
|
||||||
printing the results on stdout. If any test fails, the exit code will be
|
printing the results on stdout. If any test fails, the exit code will be
|
||||||
|
|||||||
@ -1750,8 +1750,6 @@ accounts, a
|
|||||||
.PD
|
.PD
|
||||||
Show account names.
|
Show account names.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
This command lists account names, either declared with account
|
This command lists account names, either declared with account
|
||||||
directives (--declared), posted to (--used), or both (the default).
|
directives (--declared), posted to (--used), or both (the default).
|
||||||
With query arguments, only matched account names and account names
|
With query arguments, only matched account names and account names
|
||||||
@ -1787,8 +1785,6 @@ activity
|
|||||||
.PD
|
.PD
|
||||||
Show an ascii barchart of posting counts per interval.
|
Show an ascii barchart of posting counts per interval.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
The activity command displays an ascii histogram showing transaction
|
The activity command displays an ascii histogram showing transaction
|
||||||
counts by day, week, month or other reporting interval (by day is the
|
counts by day, week, month or other reporting interval (by day is the
|
||||||
default).
|
default).
|
||||||
@ -1813,8 +1809,6 @@ add
|
|||||||
.PD
|
.PD
|
||||||
Prompt for transactions and add them to the journal.
|
Prompt for transactions and add them to the journal.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
Many hledger users edit their journals directly with a text editor, or
|
Many hledger users edit their journals directly with a text editor, or
|
||||||
generate them from CSV.
|
generate them from CSV.
|
||||||
For more interactive data entry, there is the \f[C]add\f[R] command,
|
For more interactive data entry, there is the \f[C]add\f[R] command,
|
||||||
@ -1898,8 +1892,6 @@ balance, bal, b
|
|||||||
.PD
|
.PD
|
||||||
Show accounts and their balances.
|
Show accounts and their balances.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
The balance command is hledger\[aq]s most versatile command.
|
The balance command is hledger\[aq]s most versatile command.
|
||||||
Note, despite the name, it is not always used for showing real-world
|
Note, despite the name, it is not always used for showing real-world
|
||||||
account balances; the more accounting-aware balancesheet and
|
account balances; the more accounting-aware balancesheet and
|
||||||
@ -2521,8 +2513,6 @@ Note this report shows all account balances with normal positive sign
|
|||||||
(like conventional financial statements, unlike balance/print/register)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
Example:
|
Example:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@ -2570,8 +2560,6 @@ balancesheetequity, bse
|
|||||||
Just like balancesheet, but also reports Equity (which it assumes is
|
Just like balancesheet, but also reports Equity (which it assumes is
|
||||||
under a top-level \f[C]equity\f[R] account).
|
under a top-level \f[C]equity\f[R] account).
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
Example:
|
Example:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@ -2616,8 +2604,6 @@ Note this report shows all account balances with normal positive sign
|
|||||||
(like conventional financial statements, unlike balance/print/register)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
Example:
|
Example:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@ -2659,8 +2645,6 @@ With --date2, checks secondary dates instead.
|
|||||||
With --strict, dates must also be unique.
|
With --strict, dates must also be unique.
|
||||||
With a query, only matched transactions\[aq] dates are checked.
|
With a query, only matched transactions\[aq] dates are checked.
|
||||||
Reads the default journal file, or another specified with -f.
|
Reads the default journal file, or another specified with -f.
|
||||||
.PP
|
|
||||||
$FLAGS$
|
|
||||||
.SS check-dupes
|
.SS check-dupes
|
||||||
.PP
|
.PP
|
||||||
check-dupes
|
check-dupes
|
||||||
@ -2671,8 +2655,6 @@ Reports account names having the same leaf but different prefixes.
|
|||||||
In other words, two or more leaves that are categorized differently.
|
In other words, two or more leaves that are categorized differently.
|
||||||
Reads the default journal file, or another specified as an argument.
|
Reads the default journal file, or another specified as an argument.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
||||||
.SS close
|
.SS close
|
||||||
.PP
|
.PP
|
||||||
@ -2687,8 +2669,6 @@ Useful for bringing asset/liability balances forward into a new journal
|
|||||||
file, or for closing out revenues/expenses to retained earnings at the
|
file, or for closing out revenues/expenses to retained earnings at the
|
||||||
end of a period.
|
end of a period.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
The closing transaction transfers balances to \[dq]equity:closing
|
The closing transaction transfers balances to \[dq]equity:closing
|
||||||
balances\[dq], and the opening transaction transfers balances from
|
balances\[dq], and the opening transaction transfers balances from
|
||||||
\[dq]equity:opening balances\[dq], or you can customise these with the
|
\[dq]equity:opening balances\[dq], or you can customise these with the
|
||||||
@ -2794,14 +2774,10 @@ commodities
|
|||||||
.P
|
.P
|
||||||
.PD
|
.PD
|
||||||
List all commodity/currency symbols used or declared in the journal.
|
List all commodity/currency symbols used or declared in the journal.
|
||||||
.PP
|
|
||||||
$FLAGS$
|
|
||||||
.SS descriptions
|
.SS descriptions
|
||||||
.PP
|
.PP
|
||||||
descriptions Show descriptions.
|
descriptions Show descriptions.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
This command lists all descriptions that appear in transactions.
|
This command lists all descriptions that appear in transactions.
|
||||||
.PP
|
.PP
|
||||||
Examples:
|
Examples:
|
||||||
@ -2835,8 +2811,6 @@ from your bank (eg as CSV data).
|
|||||||
When hledger and your bank disagree about the account balance, you can
|
When hledger and your bank disagree about the account balance, you can
|
||||||
compare the bank data with your journal to find out the cause.
|
compare the bank data with your journal to find out the cause.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
Examples:
|
Examples:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@ -2861,8 +2835,6 @@ files
|
|||||||
List all files included in the journal.
|
List all files included in the journal.
|
||||||
With a REGEX argument, only file names matching the regular expression
|
With a REGEX argument, only file names matching the regular expression
|
||||||
(case sensitive) are shown.
|
(case sensitive) are shown.
|
||||||
.PP
|
|
||||||
$FLAGS$
|
|
||||||
.SS help
|
.SS help
|
||||||
.PP
|
.PP
|
||||||
help
|
help
|
||||||
@ -2871,8 +2843,6 @@ help
|
|||||||
.PD
|
.PD
|
||||||
Show any of the hledger manuals.
|
Show any of the hledger manuals.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
The \f[C]help\f[R] command displays any of the main hledger manuals, in
|
The \f[C]help\f[R] command displays any of the main hledger manuals, in
|
||||||
one of several ways.
|
one of several ways.
|
||||||
Run it with no argument to list the manuals, or provide a full or
|
Run it with no argument to list the manuals, or provide a full or
|
||||||
@ -2925,8 +2895,6 @@ Or with --dry-run, just print the transactions that would be added.
|
|||||||
Or with --catchup, just mark all of the FILEs\[aq] transactions as
|
Or with --catchup, just mark all of the FILEs\[aq] transactions as
|
||||||
imported, without actually importing any.
|
imported, without actually importing any.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
The input files are specified as arguments - no need to write -f before
|
The input files are specified as arguments - no need to write -f before
|
||||||
each one.
|
each one.
|
||||||
So eg to add new transactions from all CSV files to the main journal,
|
So eg to add new transactions from all CSV files to the main journal,
|
||||||
@ -2979,8 +2947,6 @@ Note this report shows all account balances with normal positive sign
|
|||||||
(like conventional financial statements, unlike balance/print/register)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
This command displays a simple income statement.
|
This command displays a simple income statement.
|
||||||
It currently assumes that you have top-level accounts named
|
It currently assumes that you have top-level accounts named
|
||||||
\f[C]income\f[R] (or \f[C]revenue\f[R]) and \f[C]expense\f[R] (plural
|
\f[C]income\f[R] (or \f[C]revenue\f[R]) and \f[C]expense\f[R] (plural
|
||||||
@ -3025,8 +2991,6 @@ selection.
|
|||||||
.PP
|
.PP
|
||||||
notes Show notes.
|
notes Show notes.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
This command lists all notes that appear in transactions.
|
This command lists all notes that appear in transactions.
|
||||||
.PP
|
.PP
|
||||||
Examples:
|
Examples:
|
||||||
@ -3042,8 +3006,6 @@ Snacks
|
|||||||
.PP
|
.PP
|
||||||
payees Show payee names.
|
payees Show payee names.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
This command lists all payee names that appear in transactions.
|
This command lists all payee names that appear in transactions.
|
||||||
.PP
|
.PP
|
||||||
Examples:
|
Examples:
|
||||||
@ -3069,8 +3031,6 @@ With --inverted-costs, also print inverse prices based on transaction
|
|||||||
prices.
|
prices.
|
||||||
Prices (and postings providing prices) can be filtered by a query.
|
Prices (and postings providing prices) can be filtered by a query.
|
||||||
Price amounts are always displayed with their full precision.
|
Price amounts are always displayed with their full precision.
|
||||||
.PP
|
|
||||||
$FLAGS$
|
|
||||||
.SS print
|
.SS print
|
||||||
.PP
|
.PP
|
||||||
print, txns, p
|
print, txns, p
|
||||||
@ -3079,8 +3039,6 @@ print, txns, p
|
|||||||
.PD
|
.PD
|
||||||
Show transaction journal entries, sorted by date.
|
Show transaction journal entries, sorted by date.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
The print command displays full journal entries (transactions) from the
|
The print command displays full journal entries (transactions) from the
|
||||||
journal file in date order, tidily formatted.
|
journal file in date order, tidily formatted.
|
||||||
With --date2, transactions are sorted by secondary date instead.
|
With --date2, transactions are sorted by secondary date instead.
|
||||||
@ -3207,8 +3165,6 @@ print-unique
|
|||||||
.PD
|
.PD
|
||||||
Print transactions which do not reuse an already-seen description.
|
Print transactions which do not reuse an already-seen description.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
Example:
|
Example:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@ -3232,8 +3188,6 @@ register, reg, r
|
|||||||
.PD
|
.PD
|
||||||
Show postings and their running total.
|
Show postings and their running total.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
The register command displays postings in date order, one per line, and
|
The register command displays postings in date order, one per line, and
|
||||||
their running total.
|
their running total.
|
||||||
This is typically used with a query selecting a particular account, to
|
This is typically used with a query selecting a particular account, to
|
||||||
@ -3390,8 +3344,6 @@ If there are multiple equally good matches, it shows the most recent.
|
|||||||
Query options (options, not arguments) can be used to restrict the
|
Query options (options, not arguments) can be used to restrict the
|
||||||
search space.
|
search space.
|
||||||
Helps ledger-autosync detect already-seen transactions when importing.
|
Helps ledger-autosync detect already-seen transactions when importing.
|
||||||
.PP
|
|
||||||
$FLAGS$
|
|
||||||
.SS rewrite
|
.SS rewrite
|
||||||
.PP
|
.PP
|
||||||
rewrite
|
rewrite
|
||||||
@ -3402,8 +3354,6 @@ Print all transactions, rewriting the postings of matched transactions.
|
|||||||
For now the only rewrite available is adding new postings, like print
|
For now the only rewrite available is adding new postings, like print
|
||||||
--auto.
|
--auto.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
This is a start at a generic rewriter of transaction entries.
|
This is a start at a generic rewriter of transaction entries.
|
||||||
It reads the default journal and prints the transactions, like print,
|
It reads the default journal and prints the transactions, like print,
|
||||||
but adds one or more specified postings to any transactions matching
|
but adds one or more specified postings to any transactions matching
|
||||||
@ -3575,8 +3525,6 @@ roi
|
|||||||
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
|
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
|
||||||
your investments.
|
your investments.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
This command assumes that you have account(s) that hold nothing but your
|
This command assumes that you have account(s) that hold nothing but your
|
||||||
investments and whenever you record current appraisal/valuation of these
|
investments and whenever you record current appraisal/valuation of these
|
||||||
investments you offset unrealized profit and loss into account(s) that,
|
investments you offset unrealized profit and loss into account(s) that,
|
||||||
@ -3603,8 +3551,6 @@ stats
|
|||||||
.PD
|
.PD
|
||||||
Show some journal statistics.
|
Show some journal statistics.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
The stats command displays summary information for the whole journal, or
|
The stats command displays summary information for the whole journal, or
|
||||||
a matched part of it.
|
a matched part of it.
|
||||||
With a reporting interval, it shows a report for each report period.
|
With a reporting interval, it shows a report for each report period.
|
||||||
@ -3642,8 +3588,6 @@ With a TAGREGEX argument, only tag names matching the regular expression
|
|||||||
With QUERY arguments, only transactions matching the query are
|
With QUERY arguments, only transactions matching the query are
|
||||||
considered.
|
considered.
|
||||||
With --values flag, the tags\[aq] unique values are listed instead.
|
With --values flag, the tags\[aq] unique values are listed instead.
|
||||||
.PP
|
|
||||||
$FLAGS$
|
|
||||||
.SS test
|
.SS test
|
||||||
.PP
|
.PP
|
||||||
test
|
test
|
||||||
@ -3652,8 +3596,6 @@ test
|
|||||||
.PD
|
.PD
|
||||||
Run built-in unit tests.
|
Run built-in unit tests.
|
||||||
.PP
|
.PP
|
||||||
$FLAGS$
|
|
||||||
.PP
|
|
||||||
This command runs the unit tests built in to hledger and hledger-lib,
|
This command runs the unit tests built in to hledger and hledger-lib,
|
||||||
printing the results on stdout.
|
printing the results on stdout.
|
||||||
If any test fails, the exit code will be non-zero.
|
If any test fails, the exit code will be non-zero.
|
||||||
|
|||||||
@ -1348,8 +1348,6 @@ File: hledger.info, Node: accounts, Next: activity, Up: COMMANDS
|
|||||||
accounts, a
|
accounts, a
|
||||||
Show account names.
|
Show account names.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command lists account names, either declared with account
|
This command lists account names, either declared with account
|
||||||
directives (-declared), posted to (-used), or both (the default). With
|
directives (-declared), posted to (-used), or both (the default). With
|
||||||
query arguments, only matched account names and account names referenced
|
query arguments, only matched account names and account names referenced
|
||||||
@ -1380,8 +1378,6 @@ File: hledger.info, Node: activity, Next: add, Prev: accounts, Up: COMMANDS
|
|||||||
activity
|
activity
|
||||||
Show an ascii barchart of posting counts per interval.
|
Show an ascii barchart of posting counts per interval.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The activity command displays an ascii histogram showing transaction
|
The activity command displays an ascii histogram showing transaction
|
||||||
counts by day, week, month or other reporting interval (by day is the
|
counts by day, week, month or other reporting interval (by day is the
|
||||||
default). With query arguments, it counts only matched transactions.
|
default). With query arguments, it counts only matched transactions.
|
||||||
@ -1403,8 +1399,6 @@ File: hledger.info, Node: add, Next: balance, Prev: activity, Up: COMMANDS
|
|||||||
add
|
add
|
||||||
Prompt for transactions and add them to the journal.
|
Prompt for transactions and add them to the journal.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Many hledger users edit their journals directly with a text editor,
|
Many hledger users edit their journals directly with a text editor,
|
||||||
or generate them from CSV. For more interactive data entry, there is the
|
or generate them from CSV. For more interactive data entry, there is the
|
||||||
'add' command, which prompts interactively on the console for new
|
'add' command, which prompts interactively on the console for new
|
||||||
@ -1476,8 +1470,6 @@ File: hledger.info, Node: balance, Next: balancesheet, Prev: add, Up: COMMAN
|
|||||||
balance, bal, b
|
balance, bal, b
|
||||||
Show accounts and their balances.
|
Show accounts and their balances.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The balance command is hledger's most versatile command. Note,
|
The balance command is hledger's most versatile command. Note,
|
||||||
despite the name, it is not always used for showing real-world account
|
despite the name, it is not always used for showing real-world account
|
||||||
balances; the more accounting-aware balancesheet and incomestatement may
|
balances; the more accounting-aware balancesheet and incomestatement may
|
||||||
@ -2049,8 +2041,6 @@ date). It assumes that these accounts are under a top-level 'asset' or
|
|||||||
(like conventional financial statements, unlike balance/print/register)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger balancesheet
|
$ hledger balancesheet
|
||||||
@ -2094,8 +2084,6 @@ balancesheetequity, bse
|
|||||||
Just like balancesheet, but also reports Equity (which it assumes is
|
Just like balancesheet, but also reports Equity (which it assumes is
|
||||||
under a top-level 'equity' account).
|
under a top-level 'equity' account).
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger balancesheetequity
|
$ hledger balancesheetequity
|
||||||
@ -2136,8 +2124,6 @@ contain 'receivable' or 'A/R' in their name. Note this report shows all
|
|||||||
account balances with normal positive sign (like conventional financial
|
account balances with normal positive sign (like conventional financial
|
||||||
statements, unlike balance/print/register) (experimental).
|
statements, unlike balance/print/register) (experimental).
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger cashflow
|
$ hledger cashflow
|
||||||
@ -2175,8 +2161,6 @@ checks secondary dates instead. With -strict, dates must also be
|
|||||||
unique. With a query, only matched transactions' dates are checked.
|
unique. With a query, only matched transactions' dates are checked.
|
||||||
Reads the default journal file, or another specified with -f.
|
Reads the default journal file, or another specified with -f.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: check-dupes, Next: close, Prev: check-dates, Up: COMMANDS
|
File: hledger.info, Node: check-dupes, Next: close, Prev: check-dates, Up: COMMANDS
|
||||||
|
|
||||||
@ -2188,8 +2172,6 @@ Reports account names having the same leaf but different prefixes. In
|
|||||||
other words, two or more leaves that are categorized differently. Reads
|
other words, two or more leaves that are categorized differently. Reads
|
||||||
the default journal file, or another specified as an argument.
|
the default journal file, or another specified as an argument.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
||||||
|
|
||||||
|
|
||||||
@ -2205,8 +2187,6 @@ Useful for bringing asset/liability balances forward into a new journal
|
|||||||
file, or for closing out revenues/expenses to retained earnings at the
|
file, or for closing out revenues/expenses to retained earnings at the
|
||||||
end of a period.
|
end of a period.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The closing transaction transfers balances to "equity:closing
|
The closing transaction transfers balances to "equity:closing
|
||||||
balances", and the opening transaction transfers balances from
|
balances", and the opening transaction transfers balances from
|
||||||
"equity:opening balances", or you can customise these with the
|
"equity:opening balances", or you can customise these with the
|
||||||
@ -2293,8 +2273,6 @@ File: hledger.info, Node: commodities, Next: descriptions, Prev: close, Up:
|
|||||||
commodities
|
commodities
|
||||||
List all commodity/currency symbols used or declared in the journal.
|
List all commodity/currency symbols used or declared in the journal.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: COMMANDS
|
File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: COMMANDS
|
||||||
|
|
||||||
@ -2303,8 +2281,6 @@ File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: C
|
|||||||
|
|
||||||
descriptions Show descriptions.
|
descriptions Show descriptions.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command lists all descriptions that appear in transactions.
|
This command lists all descriptions that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -2337,8 +2313,6 @@ from your bank (eg as CSV data). When hledger and your bank disagree
|
|||||||
about the account balance, you can compare the bank data with your
|
about the account balance, you can compare the bank data with your
|
||||||
journal to find out the cause.
|
journal to find out the cause.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
$ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro
|
$ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro
|
||||||
@ -2361,8 +2335,6 @@ files
|
|||||||
List all files included in the journal. With a REGEX argument, only
|
List all files included in the journal. With a REGEX argument, only
|
||||||
file names matching the regular expression (case sensitive) are shown.
|
file names matching the regular expression (case sensitive) are shown.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS
|
File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS
|
||||||
|
|
||||||
@ -2372,8 +2344,6 @@ File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS
|
|||||||
help
|
help
|
||||||
Show any of the hledger manuals.
|
Show any of the hledger manuals.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The 'help' command displays any of the main hledger manuals, in one
|
The 'help' command displays any of the main hledger manuals, in one
|
||||||
of several ways. Run it with no argument to list the manuals, or
|
of several ways. Run it with no argument to list the manuals, or
|
||||||
provide a full or partial manual name to select one.
|
provide a full or partial manual name to select one.
|
||||||
@ -2417,8 +2387,6 @@ the main journal file. Or with -dry-run, just print the transactions
|
|||||||
that would be added. Or with -catchup, just mark all of the FILEs'
|
that would be added. Or with -catchup, just mark all of the FILEs'
|
||||||
transactions as imported, without actually importing any.
|
transactions as imported, without actually importing any.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The input files are specified as arguments - no need to write -f
|
The input files are specified as arguments - no need to write -f
|
||||||
before each one. So eg to add new transactions from all CSV files to
|
before each one. So eg to add new transactions from all CSV files to
|
||||||
the main journal, it's just: 'hledger import *.csv'
|
the main journal, it's just: 'hledger import *.csv'
|
||||||
@ -2469,8 +2437,6 @@ plural forms also allowed). Note this report shows all account balances
|
|||||||
with normal positive sign (like conventional financial statements,
|
with normal positive sign (like conventional financial statements,
|
||||||
unlike balance/print/register) (experimental).
|
unlike balance/print/register) (experimental).
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command displays a simple income statement. It currently
|
This command displays a simple income statement. It currently
|
||||||
assumes that you have top-level accounts named 'income' (or 'revenue')
|
assumes that you have top-level accounts named 'income' (or 'revenue')
|
||||||
and 'expense' (plural forms also allowed.)
|
and 'expense' (plural forms also allowed.)
|
||||||
@ -2513,8 +2479,6 @@ File: hledger.info, Node: notes, Next: payees, Prev: incomestatement, Up: CO
|
|||||||
|
|
||||||
notes Show notes.
|
notes Show notes.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command lists all notes that appear in transactions.
|
This command lists all notes that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -2531,8 +2495,6 @@ File: hledger.info, Node: payees, Next: prices, Prev: notes, Up: COMMANDS
|
|||||||
|
|
||||||
payees Show payee names.
|
payees Show payee names.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command lists all payee names that appear in transactions.
|
This command lists all payee names that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -2555,8 +2517,6 @@ synthetic market prices based on transaction prices. With
|
|||||||
Prices (and postings providing prices) can be filtered by a query.
|
Prices (and postings providing prices) can be filtered by a query.
|
||||||
Price amounts are always displayed with their full precision.
|
Price amounts are always displayed with their full precision.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMANDS
|
File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMANDS
|
||||||
|
|
||||||
@ -2566,8 +2526,6 @@ File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMA
|
|||||||
print, txns, p
|
print, txns, p
|
||||||
Show transaction journal entries, sorted by date.
|
Show transaction journal entries, sorted by date.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The print command displays full journal entries (transactions) from
|
The print command displays full journal entries (transactions) from
|
||||||
the journal file in date order, tidily formatted. With -date2,
|
the journal file in date order, tidily formatted. With -date2,
|
||||||
transactions are sorted by secondary date instead.
|
transactions are sorted by secondary date instead.
|
||||||
@ -2669,8 +2627,6 @@ File: hledger.info, Node: print-unique, Next: register, Prev: print, Up: COM
|
|||||||
print-unique
|
print-unique
|
||||||
Print transactions which do not reuse an already-seen description.
|
Print transactions which do not reuse an already-seen description.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ cat unique.journal
|
$ cat unique.journal
|
||||||
@ -2692,8 +2648,6 @@ File: hledger.info, Node: register, Next: register-match, Prev: print-unique,
|
|||||||
register, reg, r
|
register, reg, r
|
||||||
Show postings and their running total.
|
Show postings and their running total.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The register command displays postings in date order, one per line,
|
The register command displays postings in date order, one per line,
|
||||||
and their running total. This is typically used with a query selecting
|
and their running total. This is typically used with a query selecting
|
||||||
a particular account, to see that account's activity:
|
a particular account, to see that account's activity:
|
||||||
@ -2819,8 +2773,6 @@ good matches, it shows the most recent. Query options (options, not
|
|||||||
arguments) can be used to restrict the search space. Helps
|
arguments) can be used to restrict the search space. Helps
|
||||||
ledger-autosync detect already-seen transactions when importing.
|
ledger-autosync detect already-seen transactions when importing.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: rewrite, Next: roi, Prev: register-match, Up: COMMANDS
|
File: hledger.info, Node: rewrite, Next: roi, Prev: register-match, Up: COMMANDS
|
||||||
|
|
||||||
@ -2832,8 +2784,6 @@ Print all transactions, rewriting the postings of matched transactions.
|
|||||||
For now the only rewrite available is adding new postings, like print
|
For now the only rewrite available is adding new postings, like print
|
||||||
-auto.
|
-auto.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This is a start at a generic rewriter of transaction entries. It
|
This is a start at a generic rewriter of transaction entries. It
|
||||||
reads the default journal and prints the transactions, like print, but
|
reads the default journal and prints the transactions, like print, but
|
||||||
adds one or more specified postings to any transactions matching QUERY.
|
adds one or more specified postings to any transactions matching QUERY.
|
||||||
@ -2989,8 +2939,6 @@ roi
|
|||||||
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
|
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
|
||||||
your investments.
|
your investments.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command assumes that you have account(s) that hold nothing but
|
This command assumes that you have account(s) that hold nothing but
|
||||||
your investments and whenever you record current appraisal/valuation of
|
your investments and whenever you record current appraisal/valuation of
|
||||||
these investments you offset unrealized profit and loss into account(s)
|
these investments you offset unrealized profit and loss into account(s)
|
||||||
@ -3018,8 +2966,6 @@ File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: COMMANDS
|
|||||||
stats
|
stats
|
||||||
Show some journal statistics.
|
Show some journal statistics.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The stats command displays summary information for the whole journal,
|
The stats command displays summary information for the whole journal,
|
||||||
or a matched part of it. With a reporting interval, it shows a report
|
or a matched part of it. With a reporting interval, it shows a report
|
||||||
for each report period.
|
for each report period.
|
||||||
@ -3055,8 +3001,6 @@ shown. With QUERY arguments, only transactions matching the query are
|
|||||||
considered. With -values flag, the tags' unique values are listed
|
considered. With -values flag, the tags' unique values are listed
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: test, Prev: tags, Up: COMMANDS
|
File: hledger.info, Node: test, Prev: tags, Up: COMMANDS
|
||||||
|
|
||||||
@ -3066,8 +3010,6 @@ File: hledger.info, Node: test, Prev: tags, Up: COMMANDS
|
|||||||
test
|
test
|
||||||
Run built-in unit tests.
|
Run built-in unit tests.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command runs the unit tests built in to hledger and hledger-lib,
|
This command runs the unit tests built in to hledger and hledger-lib,
|
||||||
printing the results on stdout. If any test fails, the exit code will
|
printing the results on stdout. If any test fails, the exit code will
|
||||||
be non-zero.
|
be non-zero.
|
||||||
@ -3287,111 +3229,111 @@ Node: COMMANDS43892
|
|||||||
Ref: #commands44004
|
Ref: #commands44004
|
||||||
Node: accounts45068
|
Node: accounts45068
|
||||||
Ref: #accounts45166
|
Ref: #accounts45166
|
||||||
Node: activity45877
|
Node: activity45865
|
||||||
Ref: #activity45987
|
Ref: #activity45975
|
||||||
Node: add46382
|
Node: add46358
|
||||||
Ref: #add46481
|
Ref: #add46457
|
||||||
Node: balance49232
|
Node: balance49196
|
||||||
Ref: #balance49343
|
Ref: #balance49307
|
||||||
Node: Classic balance report50813
|
Node: Classic balance report50765
|
||||||
Ref: #classic-balance-report50986
|
Ref: #classic-balance-report50938
|
||||||
Node: Customising the classic balance report52355
|
Node: Customising the classic balance report52307
|
||||||
Ref: #customising-the-classic-balance-report52583
|
Ref: #customising-the-classic-balance-report52535
|
||||||
Node: Colour support54659
|
Node: Colour support54611
|
||||||
Ref: #colour-support54826
|
Ref: #colour-support54778
|
||||||
Node: Flat mode54999
|
Node: Flat mode54951
|
||||||
Ref: #flat-mode55147
|
Ref: #flat-mode55099
|
||||||
Node: Depth limited balance reports55560
|
Node: Depth limited balance reports55512
|
||||||
Ref: #depth-limited-balance-reports55745
|
Ref: #depth-limited-balance-reports55697
|
||||||
Node: Percentages56201
|
Node: Percentages56153
|
||||||
Ref: #percentages56367
|
Ref: #percentages56319
|
||||||
Node: Multicolumn balance report57504
|
Node: Multicolumn balance report57456
|
||||||
Ref: #multicolumn-balance-report57684
|
Ref: #multicolumn-balance-report57636
|
||||||
Node: Budget report62998
|
Node: Budget report62950
|
||||||
Ref: #budget-report63141
|
Ref: #budget-report63093
|
||||||
Node: Nested budgets68343
|
Node: Nested budgets68295
|
||||||
Ref: #nested-budgets68455
|
Ref: #nested-budgets68407
|
||||||
Ref: #output-format-171936
|
Ref: #output-format-171888
|
||||||
Node: balancesheet72014
|
Node: balancesheet71966
|
||||||
Ref: #balancesheet72150
|
Ref: #balancesheet72102
|
||||||
Node: balancesheetequity73545
|
Node: balancesheetequity73485
|
||||||
Ref: #balancesheetequity73694
|
Ref: #balancesheetequity73634
|
||||||
Node: cashflow74267
|
Node: cashflow74195
|
||||||
Ref: #cashflow74395
|
Ref: #cashflow74323
|
||||||
Node: check-dates75503
|
Node: check-dates75419
|
||||||
Ref: #check-dates75630
|
Ref: #check-dates75546
|
||||||
Node: check-dupes75921
|
Node: check-dupes75825
|
||||||
Ref: #check-dupes76045
|
Ref: #check-dupes75949
|
||||||
Node: close76350
|
Node: close76242
|
||||||
Ref: #close76464
|
Ref: #close76356
|
||||||
Node: commodities80142
|
Node: commodities80022
|
||||||
Ref: #commodities80269
|
Ref: #commodities80149
|
||||||
Node: descriptions80363
|
Node: descriptions80231
|
||||||
Ref: #descriptions80491
|
Ref: #descriptions80359
|
||||||
Node: diff80684
|
Node: diff80540
|
||||||
Ref: #diff80790
|
Ref: #diff80646
|
||||||
Node: files81849
|
Node: files81693
|
||||||
Ref: #files81949
|
Ref: #files81793
|
||||||
Node: help82108
|
Node: help81940
|
||||||
Ref: #help82208
|
Ref: #help82040
|
||||||
Node: import83301
|
Node: import83121
|
||||||
Ref: #import83415
|
Ref: #import83235
|
||||||
Node: Importing balance assignments84320
|
Node: Importing balance assignments84128
|
||||||
Ref: #importing-balance-assignments84468
|
Ref: #importing-balance-assignments84276
|
||||||
Node: incomestatement85117
|
Node: incomestatement84925
|
||||||
Ref: #incomestatement85250
|
Ref: #incomestatement85058
|
||||||
Node: notes86666
|
Node: notes86462
|
||||||
Ref: #notes86779
|
Ref: #notes86575
|
||||||
Node: payees86917
|
Node: payees86701
|
||||||
Ref: #payees87023
|
Ref: #payees86807
|
||||||
Node: prices87193
|
Node: prices86965
|
||||||
Ref: #prices87299
|
Ref: #prices87071
|
||||||
Node: print87652
|
Node: print87412
|
||||||
Ref: #print87762
|
Ref: #print87522
|
||||||
Node: print-unique92267
|
Node: print-unique92015
|
||||||
Ref: #print-unique92393
|
Ref: #print-unique92141
|
||||||
Node: register92690
|
Node: register92426
|
||||||
Ref: #register92817
|
Ref: #register92553
|
||||||
Node: Custom register output97001
|
Node: Custom register output96725
|
||||||
Ref: #custom-register-output97130
|
Ref: #custom-register-output96854
|
||||||
Node: register-match98392
|
Node: register-match98116
|
||||||
Ref: #register-match98526
|
Ref: #register-match98250
|
||||||
Node: rewrite98889
|
Node: rewrite98601
|
||||||
Ref: #rewrite99004
|
Ref: #rewrite98716
|
||||||
Node: Re-write rules in a file100871
|
Node: Re-write rules in a file100571
|
||||||
Ref: #re-write-rules-in-a-file101005
|
Ref: #re-write-rules-in-a-file100705
|
||||||
Node: Diff output format102215
|
Node: Diff output format101915
|
||||||
Ref: #diff-output-format102384
|
Ref: #diff-output-format102084
|
||||||
Node: rewrite vs print --auto103476
|
Node: rewrite vs print --auto103176
|
||||||
Ref: #rewrite-vs.-print---auto103655
|
Ref: #rewrite-vs.-print---auto103355
|
||||||
Node: roi104211
|
Node: roi103911
|
||||||
Ref: #roi104309
|
Ref: #roi104009
|
||||||
Node: stats105333
|
Node: stats105021
|
||||||
Ref: #stats105432
|
Ref: #stats105120
|
||||||
Node: tags106232
|
Node: tags105908
|
||||||
Ref: #tags106330
|
Ref: #tags106006
|
||||||
Node: test106636
|
Node: test106300
|
||||||
Ref: #test106720
|
Ref: #test106384
|
||||||
Node: ADD-ON COMMANDS107479
|
Node: ADD-ON COMMANDS107131
|
||||||
Ref: #add-on-commands107589
|
Ref: #add-on-commands107241
|
||||||
Node: Official add-ons108877
|
Node: Official add-ons108529
|
||||||
Ref: #official-add-ons109017
|
Ref: #official-add-ons108669
|
||||||
Node: ui109097
|
Node: ui108749
|
||||||
Ref: #ui109184
|
Ref: #ui108836
|
||||||
Node: web109238
|
Node: web108890
|
||||||
Ref: #web109327
|
Ref: #web108979
|
||||||
Node: Third party add-ons109373
|
Node: Third party add-ons109025
|
||||||
Ref: #third-party-add-ons109548
|
Ref: #third-party-add-ons109200
|
||||||
Node: iadd109667
|
Node: iadd109319
|
||||||
Ref: #iadd109768
|
Ref: #iadd109420
|
||||||
Node: interest109850
|
Node: interest109502
|
||||||
Ref: #interest109959
|
Ref: #interest109611
|
||||||
Node: Experimental add-ons110054
|
Node: Experimental add-ons109706
|
||||||
Ref: #experimental-add-ons110206
|
Ref: #experimental-add-ons109858
|
||||||
Node: autosync110444
|
Node: autosync110096
|
||||||
Ref: #autosync110555
|
Ref: #autosync110207
|
||||||
Node: chart110794
|
Node: chart110446
|
||||||
Ref: #chart110899
|
Ref: #chart110551
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|||||||
@ -1173,8 +1173,6 @@ COMMANDS
|
|||||||
accounts, a
|
accounts, a
|
||||||
Show account names.
|
Show account names.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command lists account names, either declared with account direc-
|
This command lists account names, either declared with account direc-
|
||||||
tives (--declared), posted to (--used), or both (the default). With
|
tives (--declared), posted to (--used), or both (the default). With
|
||||||
query arguments, only matched account names and account names refer-
|
query arguments, only matched account names and account names refer-
|
||||||
@ -1200,8 +1198,6 @@ COMMANDS
|
|||||||
activity
|
activity
|
||||||
Show an ascii barchart of posting counts per interval.
|
Show an ascii barchart of posting counts per interval.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The activity command displays an ascii histogram showing transaction
|
The activity command displays an ascii histogram showing transaction
|
||||||
counts by day, week, month or other reporting interval (by day is the
|
counts by day, week, month or other reporting interval (by day is the
|
||||||
default). With query arguments, it counts only matched transactions.
|
default). With query arguments, it counts only matched transactions.
|
||||||
@ -1218,8 +1214,6 @@ COMMANDS
|
|||||||
add
|
add
|
||||||
Prompt for transactions and add them to the journal.
|
Prompt for transactions and add them to the journal.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Many hledger users edit their journals directly with a text editor, or
|
Many hledger users edit their journals directly with a text editor, or
|
||||||
generate them from CSV. For more interactive data entry, there is the
|
generate them from CSV. For more interactive data entry, there is the
|
||||||
add command, which prompts interactively on the console for new trans-
|
add command, which prompts interactively on the console for new trans-
|
||||||
@ -1293,8 +1287,6 @@ COMMANDS
|
|||||||
balance, bal, b
|
balance, bal, b
|
||||||
Show accounts and their balances.
|
Show accounts and their balances.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The balance command is hledger's most versatile command. Note, despite
|
The balance command is hledger's most versatile command. Note, despite
|
||||||
the name, it is not always used for showing real-world account bal-
|
the name, it is not always used for showing real-world account bal-
|
||||||
ances; the more accounting-aware balancesheet and incomestatement may
|
ances; the more accounting-aware balancesheet and incomestatement may
|
||||||
@ -1805,8 +1797,6 @@ COMMANDS
|
|||||||
(like conventional financial statements, unlike balance/print/register)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger balancesheet
|
$ hledger balancesheet
|
||||||
@ -1845,8 +1835,6 @@ COMMANDS
|
|||||||
Just like balancesheet, but also reports Equity (which it assumes is
|
Just like balancesheet, but also reports Equity (which it assumes is
|
||||||
under a top-level equity account).
|
under a top-level equity account).
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger balancesheetequity
|
$ hledger balancesheetequity
|
||||||
@ -1882,8 +1870,6 @@ COMMANDS
|
|||||||
account balances with normal positive sign (like conventional financial
|
account balances with normal positive sign (like conventional financial
|
||||||
statements, unlike balance/print/register) (experimental).
|
statements, unlike balance/print/register) (experimental).
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger cashflow
|
$ hledger cashflow
|
||||||
@ -1916,16 +1902,12 @@ COMMANDS
|
|||||||
unique. With a query, only matched transactions' dates are checked.
|
unique. With a query, only matched transactions' dates are checked.
|
||||||
Reads the default journal file, or another specified with -f.
|
Reads the default journal file, or another specified with -f.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
check-dupes
|
check-dupes
|
||||||
check-dupes
|
check-dupes
|
||||||
Reports account names having the same leaf but different prefixes. In
|
Reports account names having the same leaf but different prefixes. In
|
||||||
other words, two or more leaves that are categorized differently.
|
other words, two or more leaves that are categorized differently.
|
||||||
Reads the default journal file, or another specified as an argument.
|
Reads the default journal file, or another specified as an argument.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
||||||
|
|
||||||
close
|
close
|
||||||
@ -1936,8 +1918,6 @@ COMMANDS
|
|||||||
file, or for closing out revenues/expenses to retained earnings at the
|
file, or for closing out revenues/expenses to retained earnings at the
|
||||||
end of a period.
|
end of a period.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The closing transaction transfers balances to "equity:closing bal-
|
The closing transaction transfers balances to "equity:closing bal-
|
||||||
ances", and the opening transaction transfers balances from "eq-
|
ances", and the opening transaction transfers balances from "eq-
|
||||||
uity:opening balances", or you can customise these with the --close-to
|
uity:opening balances", or you can customise these with the --close-to
|
||||||
@ -2018,13 +1998,9 @@ COMMANDS
|
|||||||
commodities
|
commodities
|
||||||
List all commodity/currency symbols used or declared in the journal.
|
List all commodity/currency symbols used or declared in the journal.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
descriptions
|
descriptions
|
||||||
descriptions Show descriptions.
|
descriptions Show descriptions.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command lists all descriptions that appear in transactions.
|
This command lists all descriptions that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -2051,8 +2027,6 @@ COMMANDS
|
|||||||
the account balance, you can compare the bank data with your journal to
|
the account balance, you can compare the bank data with your journal to
|
||||||
find out the cause.
|
find out the cause.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
$ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro
|
$ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro
|
||||||
@ -2070,14 +2044,10 @@ COMMANDS
|
|||||||
List all files included in the journal. With a REGEX argument, only
|
List all files included in the journal. With a REGEX argument, only
|
||||||
file names matching the regular expression (case sensitive) are shown.
|
file names matching the regular expression (case sensitive) are shown.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
help
|
help
|
||||||
help
|
help
|
||||||
Show any of the hledger manuals.
|
Show any of the hledger manuals.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The help command displays any of the main hledger manuals, in one of
|
The help command displays any of the main hledger manuals, in one of
|
||||||
several ways. Run it with no argument to list the manuals, or provide
|
several ways. Run it with no argument to list the manuals, or provide
|
||||||
a full or partial manual name to select one.
|
a full or partial manual name to select one.
|
||||||
@ -2116,8 +2086,6 @@ COMMANDS
|
|||||||
tions that would be added. Or with --catchup, just mark all of the
|
tions that would be added. Or with --catchup, just mark all of the
|
||||||
FILEs' transactions as imported, without actually importing any.
|
FILEs' transactions as imported, without actually importing any.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The input files are specified as arguments - no need to write -f before
|
The input files are specified as arguments - no need to write -f before
|
||||||
each one. So eg to add new transactions from all CSV files to the main
|
each one. So eg to add new transactions from all CSV files to the main
|
||||||
journal, it's just: hledger import *.csv
|
journal, it's just: hledger import *.csv
|
||||||
@ -2154,8 +2122,6 @@ COMMANDS
|
|||||||
with normal positive sign (like conventional financial statements, un-
|
with normal positive sign (like conventional financial statements, un-
|
||||||
like balance/print/register) (experimental).
|
like balance/print/register) (experimental).
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command displays a simple income statement. It currently assumes
|
This command displays a simple income statement. It currently assumes
|
||||||
that you have top-level accounts named income (or revenue) and expense
|
that you have top-level accounts named income (or revenue) and expense
|
||||||
(plural forms also allowed.)
|
(plural forms also allowed.)
|
||||||
@ -2193,8 +2159,6 @@ COMMANDS
|
|||||||
notes
|
notes
|
||||||
notes Show notes.
|
notes Show notes.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command lists all notes that appear in transactions.
|
This command lists all notes that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -2206,8 +2170,6 @@ COMMANDS
|
|||||||
payees
|
payees
|
||||||
payees Show payee names.
|
payees Show payee names.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command lists all payee names that appear in transactions.
|
This command lists all payee names that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -2225,14 +2187,10 @@ COMMANDS
|
|||||||
Prices (and postings providing prices) can be filtered by a query.
|
Prices (and postings providing prices) can be filtered by a query.
|
||||||
Price amounts are always displayed with their full precision.
|
Price amounts are always displayed with their full precision.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
print
|
print
|
||||||
print, txns, p
|
print, txns, p
|
||||||
Show transaction journal entries, sorted by date.
|
Show transaction journal entries, sorted by date.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The print command displays full journal entries (transactions) from the
|
The print command displays full journal entries (transactions) from the
|
||||||
journal file in date order, tidily formatted. With --date2, transac-
|
journal file in date order, tidily formatted. With --date2, transac-
|
||||||
tions are sorted by secondary date instead.
|
tions are sorted by secondary date instead.
|
||||||
@ -2333,8 +2291,6 @@ COMMANDS
|
|||||||
print-unique
|
print-unique
|
||||||
Print transactions which do not reuse an already-seen description.
|
Print transactions which do not reuse an already-seen description.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ cat unique.journal
|
$ cat unique.journal
|
||||||
@ -2351,8 +2307,6 @@ COMMANDS
|
|||||||
register, reg, r
|
register, reg, r
|
||||||
Show postings and their running total.
|
Show postings and their running total.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The register command displays postings in date order, one per line, and
|
The register command displays postings in date order, one per line, and
|
||||||
their running total. This is typically used with a query selecting a
|
their running total. This is typically used with a query selecting a
|
||||||
particular account, to see that account's activity:
|
particular account, to see that account's activity:
|
||||||
@ -2463,16 +2417,12 @@ COMMANDS
|
|||||||
arguments) can be used to restrict the search space. Helps ledger-au-
|
arguments) can be used to restrict the search space. Helps ledger-au-
|
||||||
tosync detect already-seen transactions when importing.
|
tosync detect already-seen transactions when importing.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
rewrite
|
rewrite
|
||||||
rewrite
|
rewrite
|
||||||
Print all transactions, rewriting the postings of matched transactions.
|
Print all transactions, rewriting the postings of matched transactions.
|
||||||
For now the only rewrite available is adding new postings, like print
|
For now the only rewrite available is adding new postings, like print
|
||||||
--auto.
|
--auto.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This is a start at a generic rewriter of transaction entries. It reads
|
This is a start at a generic rewriter of transaction entries. It reads
|
||||||
the default journal and prints the transactions, like print, but adds
|
the default journal and prints the transactions, like print, but adds
|
||||||
one or more specified postings to any transactions matching QUERY. The
|
one or more specified postings to any transactions matching QUERY. The
|
||||||
@ -2597,8 +2547,6 @@ COMMANDS
|
|||||||
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return
|
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return
|
||||||
on your investments.
|
on your investments.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command assumes that you have account(s) that hold nothing but
|
This command assumes that you have account(s) that hold nothing but
|
||||||
your investments and whenever you record current appraisal/valuation of
|
your investments and whenever you record current appraisal/valuation of
|
||||||
these investments you offset unrealized profit and loss into account(s)
|
these investments you offset unrealized profit and loss into account(s)
|
||||||
@ -2621,8 +2569,6 @@ COMMANDS
|
|||||||
stats
|
stats
|
||||||
Show some journal statistics.
|
Show some journal statistics.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
The stats command displays summary information for the whole journal,
|
The stats command displays summary information for the whole journal,
|
||||||
or a matched part of it. With a reporting interval, it shows a report
|
or a matched part of it. With a reporting interval, it shows a report
|
||||||
for each report period.
|
for each report period.
|
||||||
@ -2653,14 +2599,10 @@ COMMANDS
|
|||||||
considered. With --values flag, the tags' unique values are listed in-
|
considered. With --values flag, the tags' unique values are listed in-
|
||||||
stead.
|
stead.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
test
|
test
|
||||||
test
|
test
|
||||||
Run built-in unit tests.
|
Run built-in unit tests.
|
||||||
|
|
||||||
$FLAGS$
|
|
||||||
|
|
||||||
This command runs the unit tests built in to hledger and hledger-lib,
|
This command runs the unit tests built in to hledger and hledger-lib,
|
||||||
printing the results on stdout. If any test fails, the exit code will
|
printing the results on stdout. If any test fails, the exit code will
|
||||||
be non-zero.
|
be non-zero.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user