;doc: update command docs
This commit is contained in:
parent
4614300d6a
commit
31370bb65d
@ -28,9 +28,9 @@ Flags:
|
|||||||
--round=TYPE how much rounding or padding should be done when
|
--round=TYPE how much rounding or padding should be done when
|
||||||
displaying amounts ?
|
displaying amounts ?
|
||||||
none - show original decimal digits,
|
none - show original decimal digits,
|
||||||
as in journal
|
as in journal (default)
|
||||||
soft - just add or remove decimal zeros
|
soft - just add or remove decimal zeros
|
||||||
to match precision (default)
|
to match precision
|
||||||
hard - round posting amounts to precision
|
hard - round posting amounts to precision
|
||||||
(can unbalance transactions)
|
(can unbalance transactions)
|
||||||
all - also round cost amounts to precision
|
all - also round cost amounts to precision
|
||||||
|
|||||||
@ -28,9 +28,9 @@ Flags:
|
|||||||
--round=TYPE how much rounding or padding should be done when
|
--round=TYPE how much rounding or padding should be done when
|
||||||
displaying amounts ?
|
displaying amounts ?
|
||||||
none - show original decimal digits,
|
none - show original decimal digits,
|
||||||
as in journal
|
as in journal (default)
|
||||||
soft - just add or remove decimal zeros
|
soft - just add or remove decimal zeros
|
||||||
to match precision (default)
|
to match precision
|
||||||
hard - round posting amounts to precision
|
hard - round posting amounts to precision
|
||||||
(can unbalance transactions)
|
(can unbalance transactions)
|
||||||
all - also round cost amounts to precision
|
all - also round cost amounts to precision
|
||||||
@ -64,10 +64,9 @@ correct account balances in each case. The earliest opening balances
|
|||||||
transaction sets correct starting balances, and any later
|
transaction sets correct starting balances, and any later
|
||||||
closing/opening pairs will harmlessly cancel each other out.
|
closing/opening pairs will harmlessly cancel each other out.
|
||||||
|
|
||||||
The balances will be transferred to and from an equity account:
|
The balances will be transferred to and from
|
||||||
equity:opening/closing balances by default, You can override this by
|
equity:opening/closing balances by default. You can override this by
|
||||||
declaring an account with type V/Conversion, or by using --close-acct
|
using --close-acct and/or --open-acct.
|
||||||
and/or --open-acct.
|
|
||||||
|
|
||||||
You can select a different set of accounts to close/open by providing an
|
You can select a different set of accounts to close/open by providing an
|
||||||
account query. Eg to add Equity accounts, provide arguments like
|
account query. Eg to add Equity accounts, provide arguments like
|
||||||
@ -75,10 +74,13 @@ assets liabilities equity or type:ALE. When migrating to a new file,
|
|||||||
you'll usually want to bring along the AL or ALE accounts, but not the
|
you'll usually want to bring along the AL or ALE accounts, but not the
|
||||||
RX accounts (Revenue, Expense).
|
RX accounts (Revenue, Expense).
|
||||||
|
|
||||||
|
Assertions will be added indicating and checking the new balances of the
|
||||||
|
closed/opened accounts.
|
||||||
|
|
||||||
The generated transactions will have a clopen: tag. If the main
|
The generated transactions will have a clopen: tag. If the main
|
||||||
journal's file name contains a number (eg a year number), the tag's
|
journal's base file name contains a number (eg a year number), the tag's
|
||||||
value will be that file name with the number incremented. Or you can
|
value will be that base file name with the number incremented. Or you
|
||||||
choose the tag value yourself, by using --clopen=TAGVAL.
|
can choose the tag value yourself, by using --clopen=TAGVAL.
|
||||||
|
|
||||||
close --close
|
close --close
|
||||||
|
|
||||||
@ -116,19 +118,19 @@ recommended.
|
|||||||
|
|
||||||
close --retain
|
close --retain
|
||||||
|
|
||||||
This is like --close, but with different defaults: it prints a
|
This is like --close, but it closes Revenue and Expense account balances
|
||||||
transaction that transfers Revenue and Expense balances to
|
by default. They will be transferred to equity:retained earnings, or
|
||||||
equity:retained earnings (and adds a retain: tag).
|
another account specified with --close-acct.
|
||||||
|
|
||||||
This is called "retaining earnings", or "closing the books". Revenues
|
Revenues and expenses correspond to changes in equity. They are
|
||||||
and expenses correspond to changes in equity. They are initially kept
|
categorised separately for reporting purposes, but traditionally at the
|
||||||
separate for reporting purposes, but traditionally at the end of each
|
end of each accounting period, businesses consolidate them into equity,
|
||||||
accounting period, businesses consolidate them into equity,
|
This is called "retaining earnings", or "closing the books".
|
||||||
|
|
||||||
In personal accounting, there's not much reason to do this, and most
|
In personal accounting, there's not much reason to do this, and most
|
||||||
people don't. One reason to do it is to help the balancesheetequity
|
people don't. (One reason to do it is to help the balancesheetequity
|
||||||
report show a zero total, demonstrating that the accounting equation
|
report show a zero total, demonstrating that the accounting equation
|
||||||
(A-L=E) is satisfied.
|
(A-L=E) is satisfied.)
|
||||||
|
|
||||||
close customisation
|
close customisation
|
||||||
|
|
||||||
|
|||||||
@ -10,9 +10,9 @@ Flags:
|
|||||||
--round=TYPE how much rounding or padding should be done when
|
--round=TYPE how much rounding or padding should be done when
|
||||||
displaying amounts ?
|
displaying amounts ?
|
||||||
none - show original decimal digits,
|
none - show original decimal digits,
|
||||||
as in journal
|
as in journal (default)
|
||||||
soft - just add or remove decimal zeros
|
soft - just add or remove decimal zeros
|
||||||
to match precision (default)
|
to match precision
|
||||||
hard - round posting amounts to precision
|
hard - round posting amounts to precision
|
||||||
(can unbalance transactions)
|
(can unbalance transactions)
|
||||||
all - also round cost amounts to precision
|
all - also round cost amounts to precision
|
||||||
|
|||||||
@ -9,9 +9,9 @@ Flags:
|
|||||||
--round=TYPE how much rounding or padding should be done when
|
--round=TYPE how much rounding or padding should be done when
|
||||||
displaying amounts ?
|
displaying amounts ?
|
||||||
none - show original decimal digits,
|
none - show original decimal digits,
|
||||||
as in journal
|
as in journal (default)
|
||||||
soft - just add or remove decimal zeros
|
soft - just add or remove decimal zeros
|
||||||
to match precision (default)
|
to match precision
|
||||||
hard - round posting amounts to precision
|
hard - round posting amounts to precision
|
||||||
(can unbalance transactions)
|
(can unbalance transactions)
|
||||||
all - also round cost amounts to precision
|
all - also round cost amounts to precision
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user