;doc: update manuals
This commit is contained in:
parent
6b174ae8a5
commit
2bce910904
@ -1,2 +1,2 @@
|
|||||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||||
m4_define({{_monthyear_}}, {{April 2022}})m4_dnl
|
m4_define({{_monthyear_}}, {{May 2022}})m4_dnl
|
||||||
|
|||||||
@ -1,2 +1,2 @@
|
|||||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||||
m4_define({{_monthyear_}}, {{April 2022}})m4_dnl
|
m4_define({{_monthyear_}}, {{May 2022}})m4_dnl
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
|
|
||||||
.TH "HLEDGER-UI" "1" "April 2022" "hledger-ui-1.25.99 " "hledger User Manuals"
|
.TH "HLEDGER-UI" "1" "May 2022" "hledger-ui-1.25.99 " "hledger User Manuals"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -548,4 +548,4 @@ SEE ALSO
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
hledger-ui-1.25.99 April 2022 HLEDGER-UI(1)
|
hledger-ui-1.25.99 May 2022 HLEDGER-UI(1)
|
||||||
|
|||||||
@ -1,2 +1,2 @@
|
|||||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||||
m4_define({{_monthyear_}}, {{April 2022}})m4_dnl
|
m4_define({{_monthyear_}}, {{May 2022}})m4_dnl
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
|
|
||||||
.TH "HLEDGER-WEB" "1" "April 2022" "hledger-web-1.25.99 " "hledger User Manuals"
|
.TH "HLEDGER-WEB" "1" "May 2022" "hledger-web-1.25.99 " "hledger User Manuals"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -585,4 +585,4 @@ SEE ALSO
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
hledger-web-1.25.99 April 2022 HLEDGER-WEB(1)
|
hledger-web-1.25.99 May 2022 HLEDGER-WEB(1)
|
||||||
|
|||||||
@ -1,2 +1,2 @@
|
|||||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||||
m4_define({{_monthyear_}}, {{April 2022}})m4_dnl
|
m4_define({{_monthyear_}}, {{May 2022}})m4_dnl
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
.\"t
|
.\"t
|
||||||
|
|
||||||
.TH "HLEDGER" "1" "April 2022" "hledger-1.25.99 " "hledger User Manuals"
|
.TH "HLEDGER" "1" "May 2022" "hledger-1.25.99 " "hledger User Manuals"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -1155,7 +1155,7 @@ Examples:
|
|||||||
.PP
|
.PP
|
||||||
.TS
|
.TS
|
||||||
tab(@);
|
tab(@);
|
||||||
lw(25.5n) lw(44.5n).
|
lw(26.0n) lw(44.0n).
|
||||||
T{
|
T{
|
||||||
\f[C]-p \[dq]bimonthly from 2008\[dq]\f[R]
|
\f[C]-p \[dq]bimonthly from 2008\[dq]\f[R]
|
||||||
T}@T{
|
T}@T{
|
||||||
@ -1167,7 +1167,7 @@ T}@T{
|
|||||||
starts on closest preceding Monday
|
starts on closest preceding Monday
|
||||||
T}
|
T}
|
||||||
T{
|
T{
|
||||||
\f[C]-p \[dq]every 5 month from 2009/03\[dq]\f[R]
|
\f[C]-p \[dq]every 5 months from 2009/03\[dq]\f[R]
|
||||||
T}@T{
|
T}@T{
|
||||||
periods will have boundaries on 2009/03/01, 2009/08/01, ...
|
periods will have boundaries on 2009/03/01, 2009/08/01, ...
|
||||||
T}
|
T}
|
||||||
@ -3023,10 +3023,11 @@ 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,
|
||||||
which prompts interactively on the console for new transactions, and
|
which prompts interactively on the console for new transactions, and
|
||||||
appends them to the journal file (if there are multiple
|
appends them to the main journal file (which should be in journal
|
||||||
\f[C]-f FILE\f[R] options, the first file is used.) Existing
|
format).
|
||||||
transactions are not changed.
|
Existing transactions are not changed.
|
||||||
This is the only hledger command that writes to the journal file.
|
This is one of the few hledger commands that writes to the journal file
|
||||||
|
(see also \f[C]import\f[R]).
|
||||||
.PP
|
.PP
|
||||||
To use it, just run \f[C]hledger add\f[R] and follow the prompts.
|
To use it, just run \f[C]hledger add\f[R] and follow the prompts.
|
||||||
You can add as many transactions as you like; when you are finished,
|
You can add as many transactions as you like; when you are finished,
|
||||||
@ -4539,17 +4540,36 @@ cashflow, cf
|
|||||||
.P
|
.P
|
||||||
.PD
|
.PD
|
||||||
This command displays a cashflow statement, showing the inflows and
|
This command displays a cashflow statement, showing the inflows and
|
||||||
outflows affecting \[dq]cash\[dq] (ie, liquid) assets.
|
outflows affecting \[dq]cash\[dq] (ie, liquid, easily convertible)
|
||||||
|
assets.
|
||||||
Amounts are shown with normal positive sign, as in conventional
|
Amounts are shown with normal positive sign, as in conventional
|
||||||
financial statements.
|
financial statements.
|
||||||
.PP
|
.PP
|
||||||
The \[dq]cash\[dq] accounts shown are those accounts declared with the
|
\[dq]Cash\[dq] assets are those accounts which are (or whose parents
|
||||||
\f[C]Cash\f[R] type, or otherwise all accounts under a top-level
|
are) declared as \f[C]Cash\f[R] by an account directive, like this:
|
||||||
\f[C]asset\f[R] account (case insensitive, plural allowed) which do not
|
.IP
|
||||||
have \f[C]fixed\f[R], \f[C]investment\f[R], \f[C]receivable\f[R] or
|
.nf
|
||||||
\f[C]A/R\f[R] in their name.
|
\f[C]
|
||||||
|
account some:liquid:asset ; type:C
|
||||||
|
\f[R]
|
||||||
|
.fi
|
||||||
.PP
|
.PP
|
||||||
Example:
|
Or if there are no such declarations, all accounts
|
||||||
|
.IP \[bu] 2
|
||||||
|
under a top-level \f[C]asset\f[R] account (case insensitive, plural
|
||||||
|
allowed)
|
||||||
|
.IP \[bu] 2
|
||||||
|
with some variation of \f[C]cash\f[R], \f[C]bank\f[R],
|
||||||
|
\f[C]checking\f[R] or \f[C]saving\f[R] in their name.
|
||||||
|
.PP
|
||||||
|
More precisely: all accounts matching this case insensitive regular
|
||||||
|
expression:
|
||||||
|
.PP
|
||||||
|
\f[C]\[ha]assets?(:.+)?:(cash|bank|che(ck|que?)(ing)?|savings?|currentcash)(:|$)\f[R]
|
||||||
|
.PP
|
||||||
|
and their subaccounts.
|
||||||
|
.PP
|
||||||
|
An example cashflow report:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
\f[C]
|
\f[C]
|
||||||
@ -5118,11 +5138,17 @@ import
|
|||||||
.P
|
.P
|
||||||
.PD
|
.PD
|
||||||
Read new transactions added to each FILE since last run, and add them to
|
Read new transactions added to each FILE since last run, and add them to
|
||||||
the main journal file.
|
the journal.
|
||||||
Or with --dry-run, just print the transactions that would be added.
|
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
|
||||||
|
This command may append new transactions to the main journal file (which
|
||||||
|
should be in journal format).
|
||||||
|
Existing transactions are not changed.
|
||||||
|
This is one of the few hledger commands that writes to the journal file
|
||||||
|
(see also \f[C]add\f[R]).
|
||||||
|
.PP
|
||||||
Unlike other hledger commands, with \f[C]import\f[R] the journal file is
|
Unlike other hledger commands, with \f[C]import\f[R] the journal file is
|
||||||
an output file, and will be modified, though only by appending (existing
|
an output file, and will be modified, though only by appending (existing
|
||||||
data will not be changed).
|
data will not be changed).
|
||||||
@ -9812,7 +9838,7 @@ A number of other tools and workflows, hledger-specific and otherwise,
|
|||||||
exist for converting, deduplicating, classifying and managing CSV data.
|
exist for converting, deduplicating, classifying and managing CSV data.
|
||||||
See:
|
See:
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
https://hledger.org -> sidebar -> real world setups
|
https://hledger.org/cookbook.html#setups-and-workflows
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
https://plaintextaccounting.org -> data import/conversion
|
https://plaintextaccounting.org -> data import/conversion
|
||||||
.SS Setting amounts
|
.SS Setting amounts
|
||||||
@ -10434,8 +10460,8 @@ $ hledger # show available commands
|
|||||||
$ hledger --help # show common options
|
$ hledger --help # show common options
|
||||||
$ hledger CMD --help # show common and command options, and command help
|
$ hledger CMD --help # show common and command options, and command help
|
||||||
$ hledger help # show available manuals/topics
|
$ hledger help # show available manuals/topics
|
||||||
$ hledger help hledger # show hledger manual as info/man/text (auto-chosen)
|
$ hledger help hledger # show hledger manual, as info/man/text (auto-chosen)
|
||||||
$ hledger help journal --man # show the journal manual as a man page
|
$ hledger help journal -m # show the journal topic, as a man page scrolled to that section
|
||||||
$ hledger help --help # show more detailed help for the help command
|
$ hledger help --help # show more detailed help for the help command
|
||||||
\f[R]
|
\f[R]
|
||||||
.fi
|
.fi
|
||||||
|
|||||||
1052
hledger/hledger.info
1052
hledger/hledger.info
File diff suppressed because it is too large
Load Diff
@ -789,7 +789,7 @@ TIME PERIODS
|
|||||||
-p "bimonthly from 2008" periods will have boundaries on 2008/01/01,
|
-p "bimonthly from 2008" periods will have boundaries on 2008/01/01,
|
||||||
2008/03/01, ...
|
2008/03/01, ...
|
||||||
-p "every 2 weeks" starts on closest preceding Monday
|
-p "every 2 weeks" starts on closest preceding Monday
|
||||||
-p "every 5 month from periods will have boundaries on 2009/03/01,
|
-p "every 5 months from periods will have boundaries on 2009/03/01,
|
||||||
2009/03" 2009/08/01, ...
|
2009/03" 2009/08/01, ...
|
||||||
|
|
||||||
Intervals with custom start date
|
Intervals with custom start date
|
||||||
@ -2009,10 +2009,10 @@ COMMANDS
|
|||||||
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-
|
||||||
actions, and appends them to the journal file (if there are multiple -f
|
actions, and appends them to the main journal file (which should be in
|
||||||
FILE options, the first file is used.) Existing transactions are not
|
journal format). Existing transactions are not changed. This is one
|
||||||
changed. This is the only hledger command that writes to the journal
|
of the few hledger commands that writes to the journal file (see also
|
||||||
file.
|
import).
|
||||||
|
|
||||||
To use it, just run hledger add and follow the prompts. You can add as
|
To use it, just run hledger add and follow the prompts. You can add as
|
||||||
many transactions as you like; when you are finished, enter . or press
|
many transactions as you like; when you are finished, enter . or press
|
||||||
@ -3178,15 +3178,29 @@ COMMANDS
|
|||||||
cashflow
|
cashflow
|
||||||
cashflow, cf
|
cashflow, cf
|
||||||
This command displays a cashflow statement, showing the inflows and
|
This command displays a cashflow statement, showing the inflows and
|
||||||
outflows affecting "cash" (ie, liquid) assets. Amounts are shown with
|
outflows affecting "cash" (ie, liquid, easily convertible) assets.
|
||||||
normal positive sign, as in conventional financial statements.
|
Amounts are shown with normal positive sign, as in conventional finan-
|
||||||
|
cial statements.
|
||||||
|
|
||||||
The "cash" accounts shown are those accounts declared with the Cash
|
"Cash" assets are those accounts which are (or whose parents are)
|
||||||
type, or otherwise all accounts under a top-level asset account (case
|
declared as Cash by an account directive, like this:
|
||||||
insensitive, plural allowed) which do not have fixed, investment,
|
|
||||||
receivable or A/R in their name.
|
|
||||||
|
|
||||||
Example:
|
account some:liquid:asset ; type:C
|
||||||
|
|
||||||
|
Or if there are no such declarations, all accounts
|
||||||
|
|
||||||
|
o under a top-level asset account (case insensitive, plural allowed)
|
||||||
|
|
||||||
|
o with some variation of cash, bank, checking or saving in their name.
|
||||||
|
|
||||||
|
More precisely: all accounts matching this case insensitive regular
|
||||||
|
expression:
|
||||||
|
|
||||||
|
^assets?(:.+)?:(cash|bank|che(ck|que?)(ing)?|savings?|currentcash)(:|$)
|
||||||
|
|
||||||
|
and their subaccounts.
|
||||||
|
|
||||||
|
An example cashflow report:
|
||||||
|
|
||||||
$ hledger cashflow
|
$ hledger cashflow
|
||||||
Cashflow Statement
|
Cashflow Statement
|
||||||
@ -3590,9 +3604,14 @@ COMMANDS
|
|||||||
import
|
import
|
||||||
import
|
import
|
||||||
Read new transactions added to each FILE since last run, and add them
|
Read new transactions added to each FILE since last run, and add them
|
||||||
to the main journal file. Or with --dry-run, just print the transac-
|
to the journal. Or with --dry-run, just print the transactions that
|
||||||
tions that would be added. Or with --catchup, just mark all of the
|
would be added. Or with --catchup, just mark all of the FILEs' trans-
|
||||||
FILEs' transactions as imported, without actually importing any.
|
actions as imported, without actually importing any.
|
||||||
|
|
||||||
|
This command may append new transactions to the main journal file
|
||||||
|
(which should be in journal format). Existing transactions are not
|
||||||
|
changed. This is one of the few hledger commands that writes to the
|
||||||
|
journal file (see also add).
|
||||||
|
|
||||||
Unlike other hledger commands, with import the journal file is an out-
|
Unlike other hledger commands, with import the journal file is an out-
|
||||||
put file, and will be modified, though only by appending (existing data
|
put file, and will be modified, though only by appending (existing data
|
||||||
@ -4616,8 +4635,6 @@ JOURNAL FORMAT
|
|||||||
uncleared recorded but not yet reconciled; needs review
|
uncleared recorded but not yet reconciled; needs review
|
||||||
pending tentatively reconciled (if needed, eg during a big reconcil-
|
pending tentatively reconciled (if needed, eg during a big reconcil-
|
||||||
iation)
|
iation)
|
||||||
|
|
||||||
|
|
||||||
cleared complete, reconciled as far as possible, and considered cor-
|
cleared complete, reconciled as far as possible, and considered cor-
|
||||||
rect
|
rect
|
||||||
|
|
||||||
@ -5282,6 +5299,10 @@ JOURNAL FORMAT
|
|||||||
following entries until end of current file; and its display
|
following entries until end of current file; and its display
|
||||||
style, for reports. Takes precedence over D. Subdirectives:
|
style, for reports. Takes precedence over D. Subdirectives:
|
||||||
format (alternate syntax).
|
format (alternate syntax).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
D Sets a default commodity to use for no-symbol amounts, and Y
|
D Sets a default commodity to use for no-symbol amounts, and Y
|
||||||
its decimal mark for parsing amounts of this commodity in
|
its decimal mark for parsing amounts of this commodity in
|
||||||
following entries until end of current file; and its display
|
following entries until end of current file; and its display
|
||||||
@ -7085,7 +7106,7 @@ CSV FORMAT
|
|||||||
exist for converting, deduplicating, classifying and managing CSV data.
|
exist for converting, deduplicating, classifying and managing CSV data.
|
||||||
See:
|
See:
|
||||||
|
|
||||||
o https://hledger.org -> sidebar -> real world setups
|
o https://hledger.org/cookbook.html#setups-and-workflows
|
||||||
|
|
||||||
o https://plaintextaccounting.org -> data import/conversion
|
o https://plaintextaccounting.org -> data import/conversion
|
||||||
|
|
||||||
@ -7514,8 +7535,8 @@ COMMON TASKS
|
|||||||
$ hledger --help # show common options
|
$ hledger --help # show common options
|
||||||
$ hledger CMD --help # show common and command options, and command help
|
$ hledger CMD --help # show common and command options, and command help
|
||||||
$ hledger help # show available manuals/topics
|
$ hledger help # show available manuals/topics
|
||||||
$ hledger help hledger # show hledger manual as info/man/text (auto-chosen)
|
$ hledger help hledger # show hledger manual, as info/man/text (auto-chosen)
|
||||||
$ hledger help journal --man # show the journal manual as a man page
|
$ hledger help journal -m # show the journal topic, as a man page scrolled to that section
|
||||||
$ hledger help --help # show more detailed help for the help command
|
$ hledger help --help # show more detailed help for the help command
|
||||||
|
|
||||||
Find more docs, chat, mail list, reddit, issue tracker:
|
Find more docs, chat, mail list, reddit, issue tracker:
|
||||||
@ -7985,4 +8006,4 @@ SEE ALSO
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
hledger-1.25.99 April 2022 HLEDGER(1)
|
hledger-1.25.99 May 2022 HLEDGER(1)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user