doc: updated generated manuals
This commit is contained in:
Simon Michael
parent
07d0ec4534
commit
2bee53af96
@ -85,11 +85,12 @@ date\-format\ %\-m/%\-d/%Y\ %l:%M\ %p
|
||||
\f[I]\f[C]FIELDNAME2\f[]\f[]...
|
||||
.PP
|
||||
This (a) names the CSV fields, in order (names may not contain
|
||||
whitespace, but may be omitted), and (b) assigns them to journal entry
|
||||
fields if you use any of these standard field names: \f[C]date\f[],
|
||||
\f[C]date2\f[], \f[C]status\f[], \f[C]code\f[], \f[C]description\f[],
|
||||
\f[C]comment\f[], \f[C]account1\f[], \f[C]account2\f[], \f[C]amount\f[],
|
||||
\f[C]amount\-in\f[], \f[C]amount\-out\f[], \f[C]currency\f[].
|
||||
whitespace; uninteresting names may be left blank), and (b) assigns them
|
||||
to journal entry fields if you use any of these standard field names:
|
||||
\f[C]date\f[], \f[C]date2\f[], \f[C]status\f[], \f[C]code\f[],
|
||||
\f[C]description\f[], \f[C]comment\f[], \f[C]account1\f[],
|
||||
\f[C]account2\f[], \f[C]amount\f[], \f[C]amount\-in\f[],
|
||||
\f[C]amount\-out\f[], \f[C]currency\f[].
|
||||
Eg:
|
||||
.IP
|
||||
.nf
|
||||
@ -154,8 +155,8 @@ matched by one of the PATTERNs.
|
||||
The patterns are case\-insensitive regular expressions which match
|
||||
anywhere within the whole CSV record (it\[aq]s not yet possible to match
|
||||
within a specific field).
|
||||
When there are multiple patterns they should be written on separate
|
||||
lines, unindented.
|
||||
When there are multiple patterns they can be written on separate lines,
|
||||
unindented.
|
||||
The field assignments are on separate lines indented by at least one
|
||||
space.
|
||||
Examples:
|
||||
|
||||
@ -94,10 +94,11 @@ File: hledger_csv.5.info, Node: field list, Next: field assignment, Prev: dat
|
||||
`fields'_`FIELDNAME1'_, _`FIELDNAME2'_...
|
||||
|
||||
This (a) names the CSV fields, in order (names may not contain
|
||||
whitespace, but may be omitted), and (b) assigns them to journal entry
|
||||
fields if you use any of these standard field names: `date', `date2',
|
||||
`status', `code', `description', `comment', `account1', `account2',
|
||||
`amount', `amount-in', `amount-out', `currency'. Eg:
|
||||
whitespace; uninteresting names may be left blank), and (b) assigns them
|
||||
to journal entry fields if you use any of these standard field names:
|
||||
`date', `date2', `status', `code', `description', `comment',
|
||||
`account1', `account2', `amount', `amount-in', `amount-out',
|
||||
`currency'. Eg:
|
||||
|
||||
|
||||
# use the 1st, 2nd and 4th CSV fields as the entry's date, description and amount,
|
||||
@ -149,9 +150,9 @@ _`FIELDASSIGNMENTS'_...
|
||||
matched by one of the PATTERNs. The patterns are case-insensitive
|
||||
regular expressions which match anywhere within the whole CSV record
|
||||
(it's not yet possible to match within a specific field). When there are
|
||||
multiple patterns they should be written on separate lines, unindented.
|
||||
The field assignments are on separate lines indented by at least one
|
||||
space. Examples:
|
||||
multiple patterns they can be written on separate lines, unindented. The
|
||||
field assignments are on separate lines indented by at least one space.
|
||||
Examples:
|
||||
|
||||
|
||||
# if the CSV record contains "groceries", set account2 to "expenses:groceries"
|
||||
@ -218,13 +219,13 @@ Node: date-format1413
|
||||
Ref: #date-format1542
|
||||
Node: field list2051
|
||||
Ref: #field-list2190
|
||||
Node: field assignment2866
|
||||
Ref: #field-assignment3023
|
||||
Node: conditional block3528
|
||||
Ref: #conditional-block3684
|
||||
Node: include4574
|
||||
Ref: #include4685
|
||||
Node: TIPS4916
|
||||
Ref: #tips5000
|
||||
Node: field assignment2885
|
||||
Ref: #field-assignment3042
|
||||
Node: conditional block3547
|
||||
Ref: #conditional-block3703
|
||||
Node: include4590
|
||||
Ref: #include4701
|
||||
Node: TIPS4932
|
||||
Ref: #tips5016
|
||||
|
||||
End Tag Table
|
||||
|
||||
@ -55,10 +55,10 @@ CSV RULES
|
||||
fieldsFIELDNAME1, FIELDNAME2...
|
||||
|
||||
This (a) names the CSV fields, in order (names may not contain white-
|
||||
space, but may be omitted), and (b) assigns them to journal entry
|
||||
fields if you use any of these standard field names: date, date2, sta-
|
||||
tus, code, description, comment, account1, account2, amount, amount-in,
|
||||
amount-out, currency. Eg:
|
||||
space; uninteresting names may be left blank), and (b) assigns them to
|
||||
journal entry fields if you use any of these standard field names:
|
||||
date, date2, status, code, description, comment, account1, account2,
|
||||
amount, amount-in, amount-out, currency. Eg:
|
||||
|
||||
# use the 1st, 2nd and 4th CSV fields as the entry's date, description and amount,
|
||||
# and give the 7th and 8th fields meaningful names for later reference:
|
||||
@ -98,7 +98,7 @@ CSV RULES
|
||||
matched by one of the PATTERNs. The patterns are case-insensitive reg-
|
||||
ular expressions which match anywhere within the whole CSV record (it's
|
||||
not yet possible to match within a specific field). When there are
|
||||
multiple patterns they should be written on separate lines, unindented.
|
||||
multiple patterns they can be written on separate lines, unindented.
|
||||
The field assignments are on separate lines indented by at least one
|
||||
space. Examples:
|
||||
|
||||
|
||||
@ -228,17 +228,24 @@ deeper, \f[C]left\f[] returns to the previous screen,
|
||||
move up and down through lists.
|
||||
Vi\-style \f[C]h\f[]/\f[C]j\f[]/\f[C]k\f[]/\f[C]l\f[] movement keys are
|
||||
also supported.
|
||||
A tip: movement speed is limited by your keyboard repeat rate, to move
|
||||
(A tip: movement speed is limited by your keyboard repeat rate, to move
|
||||
faster you may want to adjust that.
|
||||
(On a mac, the Karabiner app is one way to do that).
|
||||
On a mac, the Karabiner app is one way to do that.)
|
||||
.PP
|
||||
\f[C]/\f[] lets you set or change the filter query, which limits the
|
||||
data shown on most screens (in addition to the quick filters described
|
||||
below).
|
||||
On most screens, \f[C]/\f[] lets you set or change the filter query,
|
||||
which limits the data shown (this filter is in addition to the quick
|
||||
filters described below).
|
||||
While editing the query you can use typical command\-line edit keys
|
||||
(CTRL\-a/e/d/k, cursor keys etc.), and \f[C]ENTER\f[]to set the new
|
||||
filter or \f[C]ESCAPE\f[]to cancel.
|
||||
.PP
|
||||
\f[C]d\f[] cycles through the common report period durations: day, week,
|
||||
month, quarter, year, and unlimited (the default).
|
||||
When the report duration is limited in this way, \f[C]n\f[] and
|
||||
\f[C]p\f[] step to the next or previous day/week/month/etc.
|
||||
(To set arbitrary start/end dates, you can use \f[C]/\f[] to set a
|
||||
\f[C]date:\f[] query.)
|
||||
.PP
|
||||
\f[C]BACKSPACE\f[] or \f[C]DELETE\f[] clears any filters in effect.
|
||||
.PP
|
||||
\f[C]ESCAPE\f[] removes any filters currently in effect, and jumps to
|
||||
@ -273,7 +280,8 @@ Additional screen\-specific keys are described below.
|
||||
This is normally the first screen displayed.
|
||||
It lists accounts and their balances, like hledger\[aq]s balance
|
||||
command.
|
||||
By default, it shows all accounts and their latest ending balances.
|
||||
By default, it shows all accounts and their latest ending balances
|
||||
(including the balances of subaccounts).
|
||||
if you specify a query on the command line, it shows just the matched
|
||||
accounts and the balances from matched transactions.
|
||||
.PP
|
||||
@ -288,8 +296,10 @@ To remove the depth limit, set it higher than the maximum account depth,
|
||||
or press \f[C]ESCAPE\f[].
|
||||
.PP
|
||||
\f[C]F\f[] toggles flat mode on and off.
|
||||
In flat mode, accounts are listed without indentation (and account
|
||||
registers will exclude subaccounts, see below).
|
||||
In flat mode, accounts are listed without indentation, and show their
|
||||
subaccount\-excluding balances, except for accounts which have been
|
||||
clipped by a depth limit, which show their inclusive balances (as with
|
||||
hledger\[aq]s balance command).
|
||||
.PP
|
||||
\f[C]C\f[] toggles cleared mode, in which uncleared transactions and
|
||||
postings are not shown.
|
||||
@ -346,12 +356,14 @@ $\ hledger\-ui\ \-\-register\ checking\ \-\-cleared
|
||||
.fi
|
||||
.RE
|
||||
.PP
|
||||
Normally the register screen shows transactions in the current account
|
||||
The register screen normally shows transactions in the current account
|
||||
and any of its subaccounts (inclusive mode).
|
||||
If it was entered from accounts screen in flat mode, it shows
|
||||
transactions affecting this account specifically, without considering
|
||||
subaccounts (exclusive mode).
|
||||
As on the accounts screen you can toggle this with the \f[C]F\f[] key.
|
||||
If it was entered from the accounts screen in flat mode, where the
|
||||
selected account was not depth\-clipped and therefore was showing its
|
||||
subaccount\-excluding balance, the register too will omit the
|
||||
transactions of subaccounts (exclusive mode).
|
||||
This means the register always shows the transactions responsible for
|
||||
the balance being displayed on the accounts screen.
|
||||
.PP
|
||||
\f[C]C\f[] toggles cleared mode, in which uncleared transactions and
|
||||
postings are not shown.
|
||||
|
||||
@ -159,15 +159,21 @@ again (or `ESCAPE', or `LEFT') to close it.
|
||||
The cursor keys navigate: `right' (or `enter') goes deeper, `left'
|
||||
returns to the previous screen, `up'/`down'/`page up'/`page
|
||||
down'/`home'/`end' move up and down through lists. Vi-style
|
||||
`h'/`j'/`k'/`l' movement keys are also supported. A tip: movement speed
|
||||
is limited by your keyboard repeat rate, to move faster you may want to
|
||||
adjust that. (On a mac, the Karabiner app is one way to do that).
|
||||
`h'/`j'/`k'/`l' movement keys are also supported. (A tip: movement
|
||||
speed is limited by your keyboard repeat rate, to move faster you may
|
||||
want to adjust that. On a mac, the Karabiner app is one way to do that.)
|
||||
|
||||
`/' lets you set or change the filter query, which limits the data
|
||||
shown on most screens (in addition to the quick filters described
|
||||
below). While editing the query you can use typical command-line edit
|
||||
keys (CTRL-a/e/d/k, cursor keys etc.), and `ENTER'to set the new filter
|
||||
or `ESCAPE'to cancel.
|
||||
On most screens, `/' lets you set or change the filter query, which
|
||||
limits the data shown (this filter is in addition to the quick filters
|
||||
described below). While editing the query you can use typical
|
||||
command-line edit keys (CTRL-a/e/d/k, cursor keys etc.), and `ENTER'to
|
||||
set the new filter or `ESCAPE'to cancel.
|
||||
|
||||
`d' cycles through the common report period durations: day, week,
|
||||
month, quarter, year, and unlimited (the default). When the report
|
||||
duration is limited in this way, `n' and `p' step to the next or
|
||||
previous day/week/month/etc. (To set arbitrary start/end dates, you can
|
||||
use `/' to set a `date:' query.)
|
||||
|
||||
`BACKSPACE' or `DELETE' clears any filters in effect.
|
||||
|
||||
@ -216,9 +222,9 @@ File: hledger-ui.1.info, Node: Accounts screen, Next: Register screen, Up: SC
|
||||
|
||||
This is normally the first screen displayed. It lists accounts and their
|
||||
balances, like hledger's balance command. By default, it shows all
|
||||
accounts and their latest ending balances. if you specify a query on the
|
||||
command line, it shows just the matched accounts and the balances from
|
||||
matched transactions.
|
||||
accounts and their latest ending balances (including the balances of
|
||||
subaccounts). if you specify a query on the command line, it shows just
|
||||
the matched accounts and the balances from matched transactions.
|
||||
|
||||
Account names are normally indented to show the hierarchy (tree
|
||||
mode). To see less detail, set a depth limit by pressing a number key,
|
||||
@ -228,8 +234,9 @@ limit. To remove the depth limit, set it higher than the maximum
|
||||
account depth, or press `ESCAPE'.
|
||||
|
||||
`F' toggles flat mode on and off. In flat mode, accounts are listed
|
||||
without indentation (and account registers will exclude subaccounts, see
|
||||
below).
|
||||
without indentation, and show their subaccount-excluding balances,
|
||||
except for accounts which have been clipped by a depth limit, which show
|
||||
their inclusive balances (as with hledger's balance command).
|
||||
|
||||
`C' toggles cleared mode, in which uncleared transactions and
|
||||
postings are not shown. `U' toggles uncleared mode, in which only
|
||||
@ -278,11 +285,13 @@ a check register. Each line represents one transaction and shows:
|
||||
$ hledger-ui --register checking --cleared
|
||||
|
||||
|
||||
Normally the register screen shows transactions in the current
|
||||
The register screen normally shows transactions in the current
|
||||
account and any of its subaccounts (inclusive mode). If it was entered
|
||||
from accounts screen in flat mode, it shows transactions affecting this
|
||||
account specifically, without considering subaccounts (exclusive mode).
|
||||
As on the accounts screen you can toggle this with the `F' key.
|
||||
from the accounts screen in flat mode, where the selected account was
|
||||
not depth-clipped and therefore was showing its subaccount-excluding
|
||||
balance, the register too will omit the transactions of subaccounts
|
||||
(exclusive mode). This means the register always shows the transactions
|
||||
responsible for the balance being displayed on the accounts screen.
|
||||
|
||||
`C' toggles cleared mode, in which uncleared transactions and
|
||||
postings are not shown. `U' toggles uncleared mode, in which only
|
||||
@ -340,15 +349,15 @@ Node: OPTIONS825
|
||||
Ref: #options924
|
||||
Node: KEYS3805
|
||||
Ref: #keys3902
|
||||
Node: SCREENS5791
|
||||
Ref: #screens5878
|
||||
Node: Accounts screen5968
|
||||
Ref: #accounts-screen6098
|
||||
Node: Register screen7403
|
||||
Ref: #register-screen7560
|
||||
Node: Transaction screen9381
|
||||
Ref: #transaction-screen9541
|
||||
Node: Error screen10408
|
||||
Ref: #error-screen10532
|
||||
Node: SCREENS6114
|
||||
Ref: #screens6201
|
||||
Node: Accounts screen6291
|
||||
Ref: #accounts-screen6421
|
||||
Node: Register screen7887
|
||||
Ref: #register-screen8044
|
||||
Node: Transaction screen10004
|
||||
Ref: #transaction-screen10164
|
||||
Node: Error screen11031
|
||||
Ref: #error-screen11155
|
||||
|
||||
End Tag Table
|
||||
|
||||
@ -148,15 +148,21 @@ KEYS
|
||||
The cursor keys navigate: right (or enter) goes deeper, left returns to
|
||||
the previous screen, up/down/page up/page down/home/end move up and
|
||||
down through lists. Vi-style h/j/k/l movement keys are also supported.
|
||||
A tip: movement speed is limited by your keyboard repeat rate, to move
|
||||
faster you may want to adjust that. (On a mac, the Karabiner app is
|
||||
one way to do that).
|
||||
(A tip: movement speed is limited by your keyboard repeat rate, to move
|
||||
faster you may want to adjust that. On a mac, the Karabiner app is one
|
||||
way to do that.)
|
||||
|
||||
/ lets you set or change the filter query, which limits the data shown
|
||||
on most screens (in addition to the quick filters described below).
|
||||
While editing the query you can use typical command-line edit keys
|
||||
(CTRL-a/e/d/k, cursor keys etc.), and ENTERto set the new filter or
|
||||
ESCAPEto cancel.
|
||||
On most screens, / lets you set or change the filter query, which lim-
|
||||
its the data shown (this filter is in addition to the quick filters
|
||||
described below). While editing the query you can use typical com-
|
||||
mand-line edit keys (CTRL-a/e/d/k, cursor keys etc.), and ENTERto set
|
||||
the new filter or ESCAPEto cancel.
|
||||
|
||||
d cycles through the common report period durations: day, week, month,
|
||||
quarter, year, and unlimited (the default). When the report duration
|
||||
is limited in this way, n and p step to the next or previous
|
||||
day/week/month/etc. (To set arbitrary start/end dates, you can use /
|
||||
to set a date: query.)
|
||||
|
||||
BACKSPACE or DELETE clears any filters in effect.
|
||||
|
||||
@ -187,9 +193,9 @@ SCREENS
|
||||
Accounts screen
|
||||
This is normally the first screen displayed. It lists accounts and
|
||||
their balances, like hledger's balance command. By default, it shows
|
||||
all accounts and their latest ending balances. if you specify a query
|
||||
on the command line, it shows just the matched accounts and the bal-
|
||||
ances from matched transactions.
|
||||
all accounts and their latest ending balances (including the balances
|
||||
of subaccounts). if you specify a query on the command line, it shows
|
||||
just the matched accounts and the balances from matched transactions.
|
||||
|
||||
Account names are normally indented to show the hierarchy (tree mode).
|
||||
To see less detail, set a depth limit by pressing a number key, 1 to 9.
|
||||
@ -199,17 +205,18 @@ SCREENS
|
||||
ESCAPE.
|
||||
|
||||
F toggles flat mode on and off. In flat mode, accounts are listed
|
||||
without indentation (and account registers will exclude subaccounts,
|
||||
see below).
|
||||
without indentation, and show their subaccount-excluding balances,
|
||||
except for accounts which have been clipped by a depth limit, which
|
||||
show their inclusive balances (as with hledger's balance command).
|
||||
|
||||
C toggles cleared mode, in which uncleared transactions and postings
|
||||
are not shown. U toggles uncleared mode, in which only uncleared
|
||||
C toggles cleared mode, in which uncleared transactions and postings
|
||||
are not shown. U toggles uncleared mode, in which only uncleared
|
||||
transactions/postings are shown.
|
||||
|
||||
R toggles real mode, in which virtual postings are ignored.
|
||||
|
||||
Z toggles nonzero mode, in which only accounts with nonzero balances
|
||||
are shown (hledger-ui shows zero items by default, unlike command-line
|
||||
Z toggles nonzero mode, in which only accounts with nonzero balances
|
||||
are shown (hledger-ui shows zero items by default, unlike command-line
|
||||
hledger).
|
||||
|
||||
Press right or enter to view an account's transactions register.
|
||||
@ -218,15 +225,15 @@ SCREENS
|
||||
This screen shows the transactions affecting a particular account, like
|
||||
a check register. Each line represents one transaction and shows:
|
||||
|
||||
o the other account(s) involved, in abbreviated form. (If there are
|
||||
both real and virtual postings, it shows only the accounts affected
|
||||
o the other account(s) involved, in abbreviated form. (If there are
|
||||
both real and virtual postings, it shows only the accounts affected
|
||||
by real postings.)
|
||||
|
||||
o the overall change to the current account's balance; positive for an
|
||||
o the overall change to the current account's balance; positive for an
|
||||
inflow to this account, negative for an outflow.
|
||||
|
||||
o the current account's historic balance (if no query other than a date
|
||||
limit is in effect) or the running total starting from zero (other-
|
||||
limit is in effect) or the running total starting from zero (other-
|
||||
wise), after the transaction.
|
||||
Eg, these will show historic balances:
|
||||
|
||||
@ -241,11 +248,14 @@ SCREENS
|
||||
$ hledger-ui --begin 'this month' desc:market
|
||||
$ hledger-ui --register checking --cleared
|
||||
|
||||
Normally the register screen shows transactions in the current account
|
||||
and any of its subaccounts (inclusive mode). If it was entered from
|
||||
accounts screen in flat mode, it shows transactions affecting this
|
||||
account specifically, without considering subaccounts (exclusive mode).
|
||||
As on the accounts screen you can toggle this with the F key.
|
||||
The register screen normally shows transactions in the current account
|
||||
and any of its subaccounts (inclusive mode). If it was entered from
|
||||
the accounts screen in flat mode, where the selected account was not
|
||||
depth-clipped and therefore was showing its subaccount-excluding bal-
|
||||
ance, the register too will omit the transactions of subaccounts
|
||||
(exclusive mode). This means the register always shows the transac-
|
||||
tions responsible for the balance being displayed on the accounts
|
||||
screen.
|
||||
|
||||
C toggles cleared mode, in which uncleared transactions and postings
|
||||
are not shown. U toggles uncleared mode, in which only uncleared
|
||||
|
||||
@ -465,11 +465,10 @@ T{
|
||||
T}@T{
|
||||
T}
|
||||
.TE
|
||||
.SS Reporting interval
|
||||
.SS Report interval
|
||||
.PP
|
||||
A reporting interval can be specified so that commands like register,
|
||||
balance and activity will divide their reports into multiple report
|
||||
periods.
|
||||
A report interval can be specified so that commands like register,
|
||||
balance and activity will divide their reports into multiple subperiods.
|
||||
The basic intervals can be selected with one of \f[C]\-D/\-\-daily\f[],
|
||||
\f[C]\-W/\-\-weekly\f[], \f[C]\-M/\-\-monthly\f[],
|
||||
\f[C]\-Q/\-\-quarterly\f[], or \f[C]\-Y/\-\-yearly\f[].
|
||||
@ -477,15 +476,9 @@ More complex intervals may be specified with a period expression.
|
||||
.SS Period expressions
|
||||
.PP
|
||||
The \f[C]\-p/\-\-period\f[] option accepts period expressions, a
|
||||
shorthand way of expressing a start date, end date, and or reporting
|
||||
shorthand way of expressing a start date, end date, and/or report
|
||||
interval all at once.
|
||||
Note a period expression on the command line will cause any other date
|
||||
flags
|
||||
(\f[C]\-b\f[]/\f[C]\-e\f[]/\f[C]\-D\f[]/\f[C]\-W\f[]/\f[C]\-M\f[]/\f[C]\-Q\f[]/\f[C]\-Y\f[])
|
||||
to be ignored.
|
||||
.PP
|
||||
hledger\[aq]s period expressions are similar to Ledger\[aq]s, though not
|
||||
identical.
|
||||
Here\[aq]s a basic period expression specifying the first quarter of
|
||||
2009.
|
||||
Note, hledger always treats start dates as inclusive and end dates as
|
||||
@ -580,11 +573,14 @@ just that day; equivalent to "2009/1/1 to 2009/1/2"
|
||||
T}
|
||||
.TE
|
||||
.PP
|
||||
Period expressions can also start with (or be) a reporting interval:
|
||||
\f[C]daily\f[], \f[C]weekly\f[], \f[C]monthly\f[], \f[C]quarterly\f[],
|
||||
\f[C]yearly\f[], or one of the \f[C]every\ ...\f[] expressions below.
|
||||
Optionally the word \f[C]in\f[] may appear between the reporting
|
||||
interval and the start/end dates.
|
||||
The argument of \f[C]\-p\f[] can also begin with, or be, a report
|
||||
interval expression.
|
||||
The basic report intervals are \f[C]daily\f[], \f[C]weekly\f[],
|
||||
\f[C]monthly\f[], \f[C]quarterly\f[], or \f[C]yearly\f[], which have the
|
||||
same effect as the \f[C]\-D\f[],\f[C]\-W\f[],\f[C]\-M\f[],\f[C]\-Q\f[],
|
||||
or \f[C]\-Y\f[] flags.
|
||||
Between report interval and start/end dates (if any), the word
|
||||
\f[C]in\f[] is optional.
|
||||
Examples:
|
||||
.PP
|
||||
.TS
|
||||
@ -597,24 +593,41 @@ T{
|
||||
\f[C]\-p\ "monthly\ in\ 2008"\f[]
|
||||
T}
|
||||
T{
|
||||
\f[C]\-p\ "bimonthly\ from\ 2008"\f[]
|
||||
T}
|
||||
T{
|
||||
\f[C]\-p\ "quarterly"\f[]
|
||||
T}
|
||||
.TE
|
||||
.PP
|
||||
The following more complex report intervals are also supported:
|
||||
\f[C]biweekly\f[], \f[C]bimonthly\f[],
|
||||
\f[C]every\ N\ days|weeks|months|quarters|years\f[],
|
||||
\f[C]every\ Nth\ day\ [of\ month]\f[],
|
||||
\f[C]every\ Nth\ day\ of\ week\f[].
|
||||
.PP
|
||||
Examples:
|
||||
.PP
|
||||
.TS
|
||||
tab(@);
|
||||
l.
|
||||
T{
|
||||
\f[C]\-p\ "bimonthly\ from\ 2008"\f[]
|
||||
T}
|
||||
T{
|
||||
\f[C]\-p\ "every\ 2\ weeks"\f[]
|
||||
T}
|
||||
T{
|
||||
\f[C]\-p\ "every\ 5\ days\ from\ 1/3"\f[]
|
||||
T}
|
||||
T{
|
||||
\f[C]\-p\ "every\ 15th\ day\ of\ month"\f[]
|
||||
T}
|
||||
T{
|
||||
\f[C]\-p\ "every\ 4th\ day\ of\ week"\f[]
|
||||
T}
|
||||
.TE
|
||||
.PP
|
||||
Show historical balances at end of 15th each month (N is exclusive end
|
||||
date):
|
||||
.PP
|
||||
\f[C]hledger\ balance\ \-H\ \-p\ "every\ 16th\ day"\f[]
|
||||
.PP
|
||||
Group postings from start of wednesday to end of next tuesday (N is
|
||||
start date and exclusive end date):
|
||||
.PP
|
||||
\f[C]hledger\ register\ checking\ \-p\ "every\ 3rd\ day\ of\ week"\f[]
|
||||
.SS Regular Expressions
|
||||
.PP
|
||||
hledger uses regular expressions in a number of places:
|
||||
@ -739,15 +752,16 @@ match transaction descriptions
|
||||
.TP
|
||||
.B \f[B]\f[C]date:PERIODEXPR\f[]\f[]
|
||||
match dates within the specified period.
|
||||
PERIODEXPR should not include a reporting interval.
|
||||
The command\-line \f[C]\-\-date2\f[] flag makes this match secondary
|
||||
dates instead (like the \f[C]\-b\f[]/\f[C]\-e\f[]/\f[C]\-p\f[] options).
|
||||
PERIODEXPR is a period expression (with no report interval).
|
||||
Examples: \f[C]date:2016\f[], \f[C]date:thismonth\f[],
|
||||
\f[C]date:2000/2/1\-2/15\f[], date:\f[C]lastweek\-\f[].
|
||||
The command\-line \f[C]\-\-date2\f[] flag makes \f[C]date:\f[] match
|
||||
secondary dates instead.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[B]\f[C]date2:PERIODEXPR\f[]\f[]
|
||||
match secondary dates within the specified period.
|
||||
PERIODEXPR should not include a reporting interval.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
|
||||
@ -294,7 +294,7 @@ cur:\\\\$'.
|
||||
* Repeated options::
|
||||
* Depth limiting::
|
||||
* Smart dates::
|
||||
* Reporting interval::
|
||||
* Report interval::
|
||||
* Period expressions::
|
||||
* Regular Expressions::
|
||||
|
||||
@ -329,7 +329,7 @@ register will show only the uppermost accounts in the account tree, down
|
||||
to level N. Use this when you want a summary with less detail.
|
||||
|
||||
|
||||
File: hledger.1.info, Node: Smart dates, Next: Reporting interval, Prev: Depth limiting, Up: OPTIONS
|
||||
File: hledger.1.info, Node: Smart dates, Next: Report interval, Prev: Depth limiting, Up: OPTIONS
|
||||
|
||||
2.4 Smart dates
|
||||
===============
|
||||
@ -352,31 +352,28 @@ omitted (defaulting to 1).
|
||||
`today', `yesterday', `tomorrow'
|
||||
|
||||
|
||||
File: hledger.1.info, Node: Reporting interval, Next: Period expressions, Prev: Smart dates, Up: OPTIONS
|
||||
File: hledger.1.info, Node: Report interval, Next: Period expressions, Prev: Smart dates, Up: OPTIONS
|
||||
|
||||
2.5 Reporting interval
|
||||
======================
|
||||
2.5 Report interval
|
||||
===================
|
||||
|
||||
A reporting interval can be specified so that commands like register,
|
||||
balance and activity will divide their reports into multiple report
|
||||
periods. The basic intervals can be selected with one of `-D/--daily',
|
||||
A report interval can be specified so that commands like register,
|
||||
balance and activity will divide their reports into multiple subperiods.
|
||||
The basic intervals can be selected with one of `-D/--daily',
|
||||
`-W/--weekly', `-M/--monthly', `-Q/--quarterly', or `-Y/--yearly'. More
|
||||
complex intervals may be specified with a period expression.
|
||||
|
||||
|
||||
File: hledger.1.info, Node: Period expressions, Next: Regular Expressions, Prev: Reporting interval, Up: OPTIONS
|
||||
File: hledger.1.info, Node: Period expressions, Next: Regular Expressions, Prev: Report interval, Up: OPTIONS
|
||||
|
||||
2.6 Period expressions
|
||||
======================
|
||||
|
||||
The `-p/--period' option accepts period expressions, a shorthand way of
|
||||
expressing a start date, end date, and or reporting interval all at
|
||||
once. Note a period expression on the command line will cause any other
|
||||
date flags (`-b'/`-e'/`-D'/`-W'/`-M'/`-Q'/`-Y') to be ignored.
|
||||
expressing a start date, end date, and/or report interval all at once.
|
||||
|
||||
hledger's period expressions are similar to Ledger's, though not
|
||||
identical. Here's a basic period expression specifying the first quarter
|
||||
of 2009. Note, hledger always treats start dates as inclusive and end
|
||||
Here's a basic period expression specifying the first quarter of
|
||||
2009. Note, hledger always treats start dates as inclusive and end
|
||||
dates as exclusive:
|
||||
|
||||
`-p "from 2009/1/1 to 2009/4/1"'
|
||||
@ -411,19 +408,35 @@ date like so:
|
||||
`-p "2009/1"' the month of jan; equivalent to "2009/1/1 to 2009/2/1"
|
||||
`-p "2009/1/1"' just that day; equivalent to "2009/1/1 to 2009/1/2"
|
||||
|
||||
Period expressions can also start with (or be) a reporting interval:
|
||||
`daily', `weekly', `monthly', `quarterly', `yearly', or one of the
|
||||
`every ...' expressions below. Optionally the word `in' may appear
|
||||
between the reporting interval and the start/end dates. Examples:
|
||||
The argument of `-p' can also begin with, or be, a report interval
|
||||
expression. The basic report intervals are `daily', `weekly',
|
||||
`monthly', `quarterly', or `yearly', which have the same effect as the
|
||||
`-D',`-W',`-M',`-Q', or `-Y' flags. Between report interval and
|
||||
start/end dates (if any), the word `in' is optional. Examples:
|
||||
|
||||
`-p "weekly from 2009/1/1 to 2009/4/1"'
|
||||
`-p "monthly in 2008"'
|
||||
`-p "bimonthly from 2008"'
|
||||
`-p "quarterly"'
|
||||
|
||||
The following more complex report intervals are also supported:
|
||||
`biweekly', `bimonthly', `every N days|weeks|months|quarters|years',
|
||||
`every Nth day [of month]', `every Nth day of week'.
|
||||
|
||||
Examples:
|
||||
|
||||
`-p "bimonthly from 2008"'
|
||||
`-p "every 2 weeks"'
|
||||
`-p "every 5 days from 1/3"'
|
||||
`-p "every 15th day of month"'
|
||||
`-p "every 4th day of week"'
|
||||
|
||||
Show historical balances at end of 15th each month (N is exclusive
|
||||
end date):
|
||||
|
||||
`hledger balance -H -p "every 16th day"'
|
||||
|
||||
Group postings from start of wednesday to end of next tuesday (N is
|
||||
start date and exclusive end date):
|
||||
|
||||
`hledger register checking -p "every 3rd day of week"'
|
||||
|
||||
|
||||
File: hledger.1.info, Node: Regular Expressions, Prev: Period expressions, Up: OPTIONS
|
||||
@ -540,14 +553,14 @@ match (or negatively match)
|
||||
match transaction descriptions
|
||||
|
||||
*`date:PERIODEXPR'*
|
||||
match dates within the specified period. PERIODEXPR should not
|
||||
include a reporting interval. The command-line `--date2' flag
|
||||
makes this match secondary dates instead (like the `-b'/`-e'/`-p'
|
||||
options).
|
||||
match dates within the specified period. PERIODEXPR is a period
|
||||
expression (with no report interval). Examples: `date:2016',
|
||||
`date:thismonth', `date:2000/2/1-2/15', date:`lastweek-'. The
|
||||
command-line `--date2' flag makes `date:' match secondary dates
|
||||
instead.
|
||||
|
||||
*`date2:PERIODEXPR'*
|
||||
match secondary dates within the specified period. PERIODEXPR
|
||||
should not include a reporting interval.
|
||||
match secondary dates within the specified period.
|
||||
|
||||
*`depth:N'*
|
||||
match (or display, depending on command) accounts at or above this
|
||||
@ -2079,95 +2092,95 @@ Node: EXAMPLES1875
|
||||
Ref: #examples1977
|
||||
Node: OPTIONS3981
|
||||
Ref: #options4085
|
||||
Node: Multiple files8961
|
||||
Ref: #multiple-files9086
|
||||
Node: Repeated options9351
|
||||
Ref: #repeated-options9503
|
||||
Node: Depth limiting9623
|
||||
Ref: #depth-limiting9768
|
||||
Node: Smart dates9969
|
||||
Ref: #smart-dates10110
|
||||
Node: Reporting interval11107
|
||||
Ref: #reporting-interval11266
|
||||
Node: Period expressions11609
|
||||
Ref: #period-expressions11776
|
||||
Node: Regular Expressions13822
|
||||
Ref: #regular-expressions13964
|
||||
Node: QUERIES15447
|
||||
Ref: #queries15551
|
||||
Node: COMMANDS18853
|
||||
Ref: #commands18967
|
||||
Node: accounts19640
|
||||
Ref: #accounts19740
|
||||
Node: activity20722
|
||||
Ref: #activity20834
|
||||
Node: add21193
|
||||
Ref: #add21294
|
||||
Node: balance23953
|
||||
Ref: #balance24066
|
||||
Node: Flat mode26782
|
||||
Ref: #flat-mode26909
|
||||
Node: Depth limited balance reports27328
|
||||
Ref: #depth-limited-balance-reports27531
|
||||
Node: Multicolumn balance reports27952
|
||||
Ref: #multicolumn-balance-reports28154
|
||||
Node: Market value32803
|
||||
Ref: #market-value32967
|
||||
Node: Custom balance output33460
|
||||
Ref: #custom-balance-output33633
|
||||
Node: Output destination35737
|
||||
Ref: #output-destination35902
|
||||
Node: CSV output36172
|
||||
Ref: #csv-output36291
|
||||
Node: balancesheet36688
|
||||
Ref: #balancesheet36816
|
||||
Node: cashflow37468
|
||||
Ref: #cashflow37585
|
||||
Node: help38275
|
||||
Ref: #help38387
|
||||
Node: incomestatement39224
|
||||
Ref: #incomestatement39354
|
||||
Node: info40081
|
||||
Ref: #info40188
|
||||
Node: man40550
|
||||
Ref: #man40647
|
||||
Node: print41050
|
||||
Ref: #print41155
|
||||
Node: register42506
|
||||
Ref: #register42619
|
||||
Node: Custom register output46960
|
||||
Ref: #custom-register-output47091
|
||||
Node: stats48388
|
||||
Ref: #stats48494
|
||||
Node: test49375
|
||||
Ref: #test49462
|
||||
Node: ADD-ON COMMANDS49829
|
||||
Ref: #add-on-commands49965
|
||||
Node: api51253
|
||||
Ref: #api51345
|
||||
Node: autosync51379
|
||||
Ref: #autosync51494
|
||||
Node: diff53809
|
||||
Ref: #diff53919
|
||||
Node: equity54583
|
||||
Ref: #equity54697
|
||||
Node: interest56025
|
||||
Ref: #interest56142
|
||||
Node: irr59226
|
||||
Ref: #irr59339
|
||||
Node: print-unique61714
|
||||
Ref: #print-unique61844
|
||||
Node: rewrite62102
|
||||
Ref: #rewrite62221
|
||||
Node: ui62750
|
||||
Ref: #ui62850
|
||||
Node: web62891
|
||||
Ref: #web62979
|
||||
Node: TROUBLESHOOTING63012
|
||||
Ref: #troubleshooting63131
|
||||
Node: Run-time problems63185
|
||||
Ref: #run-time-problems63328
|
||||
Node: Known limitations65272
|
||||
Ref: #known-limitations65415
|
||||
Node: Multiple files8958
|
||||
Ref: #multiple-files9083
|
||||
Node: Repeated options9348
|
||||
Ref: #repeated-options9500
|
||||
Node: Depth limiting9620
|
||||
Ref: #depth-limiting9765
|
||||
Node: Smart dates9966
|
||||
Ref: #smart-dates10104
|
||||
Node: Report interval11101
|
||||
Ref: #report-interval11251
|
||||
Node: Period expressions11587
|
||||
Ref: #period-expressions11751
|
||||
Node: Regular Expressions14086
|
||||
Ref: #regular-expressions14228
|
||||
Node: QUERIES15711
|
||||
Ref: #queries15815
|
||||
Node: COMMANDS19125
|
||||
Ref: #commands19239
|
||||
Node: accounts19912
|
||||
Ref: #accounts20012
|
||||
Node: activity20994
|
||||
Ref: #activity21106
|
||||
Node: add21465
|
||||
Ref: #add21566
|
||||
Node: balance24225
|
||||
Ref: #balance24338
|
||||
Node: Flat mode27054
|
||||
Ref: #flat-mode27181
|
||||
Node: Depth limited balance reports27600
|
||||
Ref: #depth-limited-balance-reports27803
|
||||
Node: Multicolumn balance reports28224
|
||||
Ref: #multicolumn-balance-reports28426
|
||||
Node: Market value33075
|
||||
Ref: #market-value33239
|
||||
Node: Custom balance output33732
|
||||
Ref: #custom-balance-output33905
|
||||
Node: Output destination36009
|
||||
Ref: #output-destination36174
|
||||
Node: CSV output36444
|
||||
Ref: #csv-output36563
|
||||
Node: balancesheet36960
|
||||
Ref: #balancesheet37088
|
||||
Node: cashflow37740
|
||||
Ref: #cashflow37857
|
||||
Node: help38547
|
||||
Ref: #help38659
|
||||
Node: incomestatement39496
|
||||
Ref: #incomestatement39626
|
||||
Node: info40353
|
||||
Ref: #info40460
|
||||
Node: man40822
|
||||
Ref: #man40919
|
||||
Node: print41322
|
||||
Ref: #print41427
|
||||
Node: register42778
|
||||
Ref: #register42891
|
||||
Node: Custom register output47232
|
||||
Ref: #custom-register-output47363
|
||||
Node: stats48660
|
||||
Ref: #stats48766
|
||||
Node: test49647
|
||||
Ref: #test49734
|
||||
Node: ADD-ON COMMANDS50101
|
||||
Ref: #add-on-commands50237
|
||||
Node: api51525
|
||||
Ref: #api51617
|
||||
Node: autosync51651
|
||||
Ref: #autosync51766
|
||||
Node: diff54081
|
||||
Ref: #diff54191
|
||||
Node: equity54855
|
||||
Ref: #equity54969
|
||||
Node: interest56297
|
||||
Ref: #interest56414
|
||||
Node: irr59498
|
||||
Ref: #irr59611
|
||||
Node: print-unique61986
|
||||
Ref: #print-unique62116
|
||||
Node: rewrite62374
|
||||
Ref: #rewrite62493
|
||||
Node: ui63022
|
||||
Ref: #ui63122
|
||||
Node: web63163
|
||||
Ref: #web63251
|
||||
Node: TROUBLESHOOTING63284
|
||||
Ref: #troubleshooting63403
|
||||
Node: Run-time problems63457
|
||||
Ref: #run-time-problems63600
|
||||
Node: Known limitations65544
|
||||
Ref: #known-limitations65687
|
||||
|
||||
End Tag Table
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user