;doc: update manuals
This commit is contained in:
parent
2a3941682b
commit
21d6b00597
@ -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_}}, {{May 2023}})m4_dnl
|
m4_define({{_monthyear_}}, {{June 2023}})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_}}, {{May 2023}})m4_dnl
|
m4_define({{_monthyear_}}, {{June 2023}})m4_dnl
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
|
|
||||||
.TH "HLEDGER-UI" "1" "May 2023" "hledger-ui-1.29.99 " "hledger User Manuals"
|
.TH "HLEDGER-UI" "1" "June 2023" "hledger-ui-1.30.99 " "hledger User Manuals"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -15,7 +15,7 @@ hledger-ui - robust, friendly plain text accounting (TUI version)
|
|||||||
\f[V]hledger ui -- [OPTS] [QUERYARGS]\f[R]
|
\f[V]hledger ui -- [OPTS] [QUERYARGS]\f[R]
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.PP
|
.PP
|
||||||
This manual is for hledger\[aq]s terminal interface, version 1.29.99.
|
This manual is for hledger\[aq]s terminal interface, version 1.30.99.
|
||||||
See also the hledger manual for common concepts and file formats.
|
See also the hledger manual for common concepts and file formats.
|
||||||
.PP
|
.PP
|
||||||
hledger is a robust, user-friendly, cross-platform set of programs for
|
hledger is a robust, user-friendly, cross-platform set of programs for
|
||||||
|
|||||||
@ -16,7 +16,7 @@ hledger-ui - robust, friendly plain text accounting (TUI version)
|
|||||||
'hledger-ui [OPTS] [QUERYARGS]'
|
'hledger-ui [OPTS] [QUERYARGS]'
|
||||||
'hledger ui -- [OPTS] [QUERYARGS]'
|
'hledger ui -- [OPTS] [QUERYARGS]'
|
||||||
|
|
||||||
This manual is for hledger's terminal interface, version 1.29.99.
|
This manual is for hledger's terminal interface, version 1.30.99.
|
||||||
See also the hledger manual for common concepts and file formats.
|
See also the hledger manual for common concepts and file formats.
|
||||||
|
|
||||||
hledger is a robust, user-friendly, cross-platform set of programs
|
hledger is a robust, user-friendly, cross-platform set of programs
|
||||||
|
|||||||
@ -11,7 +11,7 @@ SYNOPSIS
|
|||||||
hledger ui -- [OPTS] [QUERYARGS]
|
hledger ui -- [OPTS] [QUERYARGS]
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
This manual is for hledger's terminal interface, version 1.29.99. See
|
This manual is for hledger's terminal interface, version 1.30.99. See
|
||||||
also the hledger manual for common concepts and file formats.
|
also the hledger manual for common concepts and file formats.
|
||||||
|
|
||||||
hledger is a robust, user-friendly, cross-platform set of programs for
|
hledger is a robust, user-friendly, cross-platform set of programs for
|
||||||
@ -531,4 +531,4 @@ SEE ALSO
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
hledger-ui-1.29.99 May 2023 HLEDGER-UI(1)
|
hledger-ui-1.30.99 June 2023 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_}}, {{May 2023}})m4_dnl
|
m4_define({{_monthyear_}}, {{June 2023}})m4_dnl
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
|
|
||||||
.TH "HLEDGER-WEB" "1" "May 2023" "hledger-web-1.29.99 " "hledger User Manuals"
|
.TH "HLEDGER-WEB" "1" "June 2023" "hledger-web-1.30.99 " "hledger User Manuals"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -15,7 +15,7 @@ hledger-web - robust, friendly plain text accounting (Web version)
|
|||||||
\f[V]hledger web -- [--serve|--serve-api] [OPTS] [ARGS]\f[R]
|
\f[V]hledger web -- [--serve|--serve-api] [OPTS] [ARGS]\f[R]
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.PP
|
.PP
|
||||||
This manual is for hledger\[aq]s web interface, version 1.29.99.
|
This manual is for hledger\[aq]s web interface, version 1.30.99.
|
||||||
See also the hledger manual for common concepts and file formats.
|
See also the hledger manual for common concepts and file formats.
|
||||||
.PP
|
.PP
|
||||||
hledger is a robust, user-friendly, cross-platform set of programs for
|
hledger is a robust, user-friendly, cross-platform set of programs for
|
||||||
|
|||||||
@ -16,7 +16,7 @@ hledger-web - robust, friendly plain text accounting (Web version)
|
|||||||
'hledger-web [--serve|--serve-api] [OPTS] [ARGS]'
|
'hledger-web [--serve|--serve-api] [OPTS] [ARGS]'
|
||||||
'hledger web -- [--serve|--serve-api] [OPTS] [ARGS]'
|
'hledger web -- [--serve|--serve-api] [OPTS] [ARGS]'
|
||||||
|
|
||||||
This manual is for hledger's web interface, version 1.29.99. See
|
This manual is for hledger's web interface, version 1.30.99. See
|
||||||
also the hledger manual for common concepts and file formats.
|
also the hledger manual for common concepts and file formats.
|
||||||
|
|
||||||
hledger is a robust, user-friendly, cross-platform set of programs
|
hledger is a robust, user-friendly, cross-platform set of programs
|
||||||
|
|||||||
@ -11,7 +11,7 @@ SYNOPSIS
|
|||||||
hledger web -- [--serve|--serve-api] [OPTS] [ARGS]
|
hledger web -- [--serve|--serve-api] [OPTS] [ARGS]
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
This manual is for hledger's web interface, version 1.29.99. See also
|
This manual is for hledger's web interface, version 1.30.99. See also
|
||||||
the hledger manual for common concepts and file formats.
|
the hledger manual for common concepts and file formats.
|
||||||
|
|
||||||
hledger is a robust, user-friendly, cross-platform set of programs for
|
hledger is a robust, user-friendly, cross-platform set of programs for
|
||||||
@ -571,4 +571,4 @@ SEE ALSO
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
hledger-web-1.29.99 May 2023 HLEDGER-WEB(1)
|
hledger-web-1.30.99 June 2023 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_}}, {{May 2023}})m4_dnl
|
m4_define({{_monthyear_}}, {{June 2023}})m4_dnl
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
.\"t
|
.\"t
|
||||||
|
|
||||||
.TH "HLEDGER" "1" "May 2023" "hledger-1.29.99 " "hledger User Manuals"
|
.TH "HLEDGER" "1" "June 2023" "hledger-1.30.99 " "hledger User Manuals"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -27,7 +27,7 @@ hledger is inspired by and largely compatible with ledger(1), and
|
|||||||
largely interconvertible with beancount(1).
|
largely interconvertible with beancount(1).
|
||||||
.PP
|
.PP
|
||||||
This manual is for hledger\[aq]s command line interface, version
|
This manual is for hledger\[aq]s command line interface, version
|
||||||
1.29.99.
|
1.30.99.
|
||||||
It also describes the common options, file formats and concepts used by
|
It also describes the common options, file formats and concepts used by
|
||||||
all hledger programs.
|
all hledger programs.
|
||||||
It might accidentally teach you some bookkeeping/accounting as well!
|
It might accidentally teach you some bookkeeping/accounting as well!
|
||||||
@ -499,11 +499,6 @@ Feel free to skip this section until you need it.
|
|||||||
.PP
|
.PP
|
||||||
If options are repeated in a command line, hledger will generally use
|
If options are repeated in a command line, hledger will generally use
|
||||||
the last (right-most) occurence.
|
the last (right-most) occurence.
|
||||||
Some of the boolean flags will toggle if repeated; these include:
|
|
||||||
\f[V]--invert\f[R], \f[V]--transpose\f[R], \f[V]-r/--related\f[R],
|
|
||||||
\f[V]-%/--percent\f[R], \f[V]-E/--empty\f[R], \f[V]-N/--no-total\f[R],
|
|
||||||
\f[V]-T/--row-total\f[R], \f[V]-A/--average\f[R], and
|
|
||||||
\f[V]-S/--sort-amount\f[R].
|
|
||||||
.SS Special characters
|
.SS Special characters
|
||||||
.SS Single escaping (shell metacharacters)
|
.SS Single escaping (shell metacharacters)
|
||||||
.PP
|
.PP
|
||||||
@ -10057,6 +10052,9 @@ the account to transfer to/from can be changed with
|
|||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
the accounts to be closed/opened can be changed with \f[V]ACCTQUERY\f[R]
|
the accounts to be closed/opened can be changed with \f[V]ACCTQUERY\f[R]
|
||||||
(account query arguments).
|
(account query arguments).
|
||||||
|
.IP \[bu] 2
|
||||||
|
the closing/opening dates can be changed with \f[V]-e DATE\f[R] (a
|
||||||
|
report end date)
|
||||||
.PP
|
.PP
|
||||||
By default just one destination/source posting will be used, with its
|
By default just one destination/source posting will be used, with its
|
||||||
amount left implicit.
|
amount left implicit.
|
||||||
@ -10076,10 +10074,9 @@ This could be useful for troubleshooting.
|
|||||||
.PP
|
.PP
|
||||||
The default closing date is yesterday, or the journal\[aq]s end date,
|
The default closing date is yesterday, or the journal\[aq]s end date,
|
||||||
whichever is later.
|
whichever is later.
|
||||||
You can change this by specifying a report end date; (The report start
|
You can change this by specifying a report end date with \f[V]-e\f[R].
|
||||||
date does not matter.)
|
The last day of the report period will be the closing date, eg
|
||||||
The last day of the report period will be the closing date; eg
|
\f[V]-e 2024\f[R] means \[dq]close on 2023-12-31\[dq].
|
||||||
\f[V]-e 2022\f[R] means \[dq]close on 2022-12-31\[dq].
|
|
||||||
The opening date is always the day after the closing date.
|
The opening date is always the day after the closing date.
|
||||||
.SS close and balance assertions
|
.SS close and balance assertions
|
||||||
.PP
|
.PP
|
||||||
@ -10309,21 +10306,25 @@ Tips:
|
|||||||
.PP
|
.PP
|
||||||
Make your terminal window large enough to see the demo clearly.
|
Make your terminal window large enough to see the demo clearly.
|
||||||
.PP
|
.PP
|
||||||
|
Use the -s/--speed SPEED option to set your preferred playback speed, eg
|
||||||
|
\f[V]-s4\f[R] to play at 4x original speed or \f[V]-s.5\f[R] to play at
|
||||||
|
half speed.
|
||||||
|
The default speed is 2x.
|
||||||
|
.PP
|
||||||
|
Other asciinema options can be added following a double dash, eg
|
||||||
|
\f[V]-- -i.1\f[R] to limit pauses or \f[V]-- -h\f[R] to list
|
||||||
|
asciinema\[aq]s other options.
|
||||||
|
.PP
|
||||||
During playback, several keys are available: SPACE to pause/unpause, .
|
During playback, several keys are available: SPACE to pause/unpause, .
|
||||||
to step forward (while paused), CTRL-c quit.
|
to step forward (while paused), CTRL-c quit.
|
||||||
.PP
|
.PP
|
||||||
asciinema options can be added following a double dash, such as
|
|
||||||
\f[V]-s N\f[R] to adjust speed and \f[V]-i SECS\f[R] to limit pauses.
|
|
||||||
Run \f[V]asciinema -h\f[R] to list these options.
|
|
||||||
.PP
|
|
||||||
Examples:
|
Examples:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
\f[C]
|
\f[C]
|
||||||
$ hledger demo # list available demos
|
$ hledger demo # list available demos
|
||||||
$ hledger demo 1 # play the first demo
|
$ hledger demo 1 # play the first demo at default speed (2x)
|
||||||
$ hledger demo install -- -s5 -i.5 # play the install demo at 5x speed,
|
$ hledger demo install -s4 # play the \[dq]install\[dq] demo at 4x speed
|
||||||
# with pauses limited to half a second
|
|
||||||
\f[R]
|
\f[R]
|
||||||
.fi
|
.fi
|
||||||
.SS descriptions
|
.SS descriptions
|
||||||
|
|||||||
1245
hledger/hledger.info
1245
hledger/hledger.info
File diff suppressed because it is too large
Load Diff
@ -18,7 +18,7 @@ DESCRIPTION
|
|||||||
and largely compatible with ledger(1), and largely interconvertible
|
and largely compatible with ledger(1), and largely interconvertible
|
||||||
with beancount(1).
|
with beancount(1).
|
||||||
|
|
||||||
This manual is for hledger's command line interface, version 1.29.99.
|
This manual is for hledger's command line interface, version 1.30.99.
|
||||||
It also describes the common options, file formats and concepts used by
|
It also describes the common options, file formats and concepts used by
|
||||||
all hledger programs. It might accidentally teach you some bookkeep-
|
all hledger programs. It might accidentally teach you some bookkeep-
|
||||||
ing/accounting as well! You don't need to know everything in here to
|
ing/accounting as well! You don't need to know everything in here to
|
||||||
@ -388,10 +388,7 @@ Command line tips
|
|||||||
|
|
||||||
Option repetition
|
Option repetition
|
||||||
If options are repeated in a command line, hledger will generally use
|
If options are repeated in a command line, hledger will generally use
|
||||||
the last (right-most) occurence. Some of the boolean flags will toggle
|
the last (right-most) occurence.
|
||||||
if repeated; these include: --invert, --transpose, -r/--related,
|
|
||||||
-%/--percent, -E/--empty, -N/--no-total, -T/--row-total, -A/--average,
|
|
||||||
and -S/--sort-amount.
|
|
||||||
|
|
||||||
Special characters
|
Special characters
|
||||||
Single escaping (shell metacharacters)
|
Single escaping (shell metacharacters)
|
||||||
@ -1610,8 +1607,6 @@ Journal
|
|||||||
READING DATA:
|
READING DATA:
|
||||||
Rewrite account names alias
|
Rewrite account names alias
|
||||||
Comment out sections of the file comment
|
Comment out sections of the file comment
|
||||||
|
|
||||||
|
|
||||||
Declare file's decimal mark, to help decimal-mark
|
Declare file's decimal mark, to help decimal-mark
|
||||||
parse amounts accurately
|
parse amounts accurately
|
||||||
Include other data files include
|
Include other data files include
|
||||||
@ -1659,6 +1654,14 @@ Journal
|
|||||||
rent file or end aliases. Command line equivalent: --alias
|
rent file or end aliases. Command line equivalent: --alias
|
||||||
com- Ignores part of the journal file, until end of current file or Y
|
com- Ignores part of the journal file, until end of current file or Y
|
||||||
ment end comment.
|
ment end comment.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
com- Declares up to four things: 1. a commodity symbol, for checking N,Y,N,N
|
com- Declares up to four things: 1. a commodity symbol, for checking N,Y,N,N
|
||||||
mod- all amounts in all files 2. the decimal mark for parsing
|
mod- all amounts in all files 2. the decimal mark for parsing
|
||||||
ity amounts of this commodity, in the following entries until end of
|
ity amounts of this commodity, in the following entries until end of
|
||||||
@ -1683,8 +1686,6 @@ Journal
|
|||||||
--budget.
|
--budget.
|
||||||
Other
|
Other
|
||||||
syntax:
|
syntax:
|
||||||
|
|
||||||
|
|
||||||
apply Prepends a common parent account to all account names, in fol- Y
|
apply Prepends a common parent account to all account names, in fol- Y
|
||||||
account lowing entries until end of current file or end apply account.
|
account lowing entries until end of current file or end apply account.
|
||||||
D Sets a default commodity to use for no-symbol amounts;and, if Y,Y,N,N
|
D Sets a default commodity to use for no-symbol amounts;and, if Y,Y,N,N
|
||||||
@ -2783,7 +2784,6 @@ CSV
|
|||||||
|
|
||||||
source optionally declare which file to read data
|
source optionally declare which file to read data
|
||||||
from
|
from
|
||||||
|
|
||||||
separator declare the field separator, instead of rely-
|
separator declare the field separator, instead of rely-
|
||||||
ing on file extension
|
ing on file extension
|
||||||
skip skip one or more header lines at start of file
|
skip skip one or more header lines at start of file
|
||||||
@ -4246,6 +4246,7 @@ Time periods
|
|||||||
row
|
row
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
last/this/next -1, 0, 1 periods from the current period
|
last/this/next -1, 0, 1 periods from the current period
|
||||||
day/week/month/quar-
|
day/week/month/quar-
|
||||||
ter/year
|
ter/year
|
||||||
@ -5600,7 +5601,6 @@ Valuation
|
|||||||
(-H) with port or posting was made port or
|
(-H) with port or posting was made port or
|
||||||
report journal journal
|
report journal journal
|
||||||
interval start start
|
interval start start
|
||||||
|
|
||||||
posting cost value at re- value at posting value at re- value at
|
posting cost value at re- value at posting value at re- value at
|
||||||
amounts port or date port or DATE/today
|
amounts port or date port or DATE/today
|
||||||
journal end journal end
|
journal end journal end
|
||||||
@ -5617,6 +5617,10 @@ Valuation
|
|||||||
balance
|
balance
|
||||||
(bs, bse,
|
(bs, bse,
|
||||||
cf, is)
|
cf, is)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
balance sums of value at re- value at posting value at re- value at
|
balance sums of value at re- value at posting value at re- value at
|
||||||
changes costs port end or date port or DATE/today of
|
changes costs port end or date port or DATE/today of
|
||||||
today of journal end sums of post-
|
today of journal end sums of post-
|
||||||
@ -6530,6 +6534,9 @@ PART 4: COMMANDS
|
|||||||
period end ues from report from report report start
|
period end ues from report from report report start
|
||||||
start to period start to period to period end
|
start to period start to period to period end
|
||||||
end end
|
end end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
--his- change from sum of posting- period-end DATE-value of
|
--his- change from sum of posting- period-end DATE-value of
|
||||||
torical journal start to date market val- value of change change from
|
torical journal start to date market val- value of change change from
|
||||||
/-H period end (his- ues from journal from journal journal start
|
/-H period end (his- ues from journal from journal journal start
|
||||||
@ -7301,6 +7308,9 @@ PART 4: COMMANDS
|
|||||||
o the accounts to be closed/opened can be changed with ACCTQUERY (ac-
|
o the accounts to be closed/opened can be changed with ACCTQUERY (ac-
|
||||||
count query arguments).
|
count query arguments).
|
||||||
|
|
||||||
|
o the closing/opening dates can be changed with -e DATE (a report end
|
||||||
|
date)
|
||||||
|
|
||||||
By default just one destination/source posting will be used, with its
|
By default just one destination/source posting will be used, with its
|
||||||
amount left implicit. With --x/--explicit, the amount will be shown
|
amount left implicit. With --x/--explicit, the amount will be shown
|
||||||
explicitly, and if it involves multiple commodities, a separate posting
|
explicitly, and if it involves multiple commodities, a separate posting
|
||||||
@ -7317,10 +7327,9 @@ PART 4: COMMANDS
|
|||||||
|
|
||||||
The default closing date is yesterday, or the journal's end date,
|
The default closing date is yesterday, or the journal's end date,
|
||||||
whichever is later. You can change this by specifying a report end
|
whichever is later. You can change this by specifying a report end
|
||||||
date; (The report start date does not matter.) The last day of the re-
|
date with -e. The last day of the report period will be the closing
|
||||||
port period will be the closing date; eg -e 2022 means "close on
|
date, eg -e 2024 means "close on 2023-12-31". The opening date is al-
|
||||||
2022-12-31". The opening date is always the day after the closing
|
ways the day after the closing date.
|
||||||
date.
|
|
||||||
|
|
||||||
close and balance assertions
|
close and balance assertions
|
||||||
Balance assertions will be generated, verifying that the accounts have
|
Balance assertions will be generated, verifying that the accounts have
|
||||||
@ -7480,19 +7489,21 @@ PART 4: COMMANDS
|
|||||||
|
|
||||||
Make your terminal window large enough to see the demo clearly.
|
Make your terminal window large enough to see the demo clearly.
|
||||||
|
|
||||||
|
Use the -s/--speed SPEED option to set your preferred playback speed,
|
||||||
|
eg -s4 to play at 4x original speed or -s.5 to play at half speed. The
|
||||||
|
default speed is 2x.
|
||||||
|
|
||||||
|
Other asciinema options can be added following a double dash, eg --
|
||||||
|
-i.1 to limit pauses or -- -h to list asciinema's other options.
|
||||||
|
|
||||||
During playback, several keys are available: SPACE to pause/unpause, .
|
During playback, several keys are available: SPACE to pause/unpause, .
|
||||||
to step forward (while paused), CTRL-c quit.
|
to step forward (while paused), CTRL-c quit.
|
||||||
|
|
||||||
asciinema options can be added following a double dash, such as -s N to
|
|
||||||
adjust speed and -i SECS to limit pauses. Run asciinema -h to list
|
|
||||||
these options.
|
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
$ hledger demo # list available demos
|
$ hledger demo # list available demos
|
||||||
$ hledger demo 1 # play the first demo
|
$ hledger demo 1 # play the first demo at default speed (2x)
|
||||||
$ hledger demo install -- -s5 -i.5 # play the install demo at 5x speed,
|
$ hledger demo install -s4 # play the "install" demo at 4x speed
|
||||||
# with pauses limited to half a second
|
|
||||||
|
|
||||||
descriptions
|
descriptions
|
||||||
List the unique descriptions that appear in transactions.
|
List the unique descriptions that appear in transactions.
|
||||||
@ -8866,4 +8877,4 @@ SEE ALSO
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
hledger-1.29.99 May 2023 HLEDGER(1)
|
hledger-1.30.99 June 2023 HLEDGER(1)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user