mirror of
https://github.com/simonmichael/hledger.git
synced 2024-12-26 20:02:27 +03:00
;doc: regen manuals
Wrapping and hyphenation has changed again, which I thought would be more stable now with same tool versions on laptop and server. Who knows.
This commit is contained in:
parent
edaf92db5e
commit
af21ae6eb6
@ -358,7 +358,7 @@ Simon Michael <simon@joyful.com> and contributors
|
||||
|
||||
.SH COPYRIGHT
|
||||
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
.br
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
@ -24,9 +24,9 @@ DESCRIPTION
|
||||
|
||||
When reading a CSV file named FILE.csv, hledger looks for a conversion
|
||||
rules file named FILE.csv.rules in the same directory. You can over-
|
||||
ride this with the --rules-file option. If the rules file does not
|
||||
exist, hledger will auto-create one with some example rules, which
|
||||
you'll need to adjust.
|
||||
ride this with the --rules-file option. If the rules file does not ex-
|
||||
ist, hledger will auto-create one with some example rules, which you'll
|
||||
need to adjust.
|
||||
|
||||
At minimum, the rules file must identify the date and amount fields.
|
||||
It's often necessary to specify the date format, and the number of
|
||||
@ -192,8 +192,8 @@ CSV TIPS
|
||||
you might need newest-first, see above).
|
||||
|
||||
CSV accounts
|
||||
Each journal entry will have two postings, to account1 and account2
|
||||
respectively. It's not yet possible to generate entries with more than
|
||||
Each journal entry will have two postings, to account1 and account2 re-
|
||||
spectively. It's not yet possible to generate entries with more than
|
||||
two postings. It's conventional and recommended to use account1 for
|
||||
the account whose CSV we are reading.
|
||||
|
||||
@ -229,9 +229,9 @@ CSV TIPS
|
||||
CSV balance assertions/assignments
|
||||
If the CSV includes a running balance, you can assign that to one of
|
||||
the pseudo fields balance (or balance1) or balance2. This will gener-
|
||||
ate a balance assertion (or if the amount is left empty, a balance
|
||||
assignment), on the first or second posting, whenever the running bal-
|
||||
ance field is non-empty. (TODO: #1000)
|
||||
ate a balance assertion (or if the amount is left empty, a balance as-
|
||||
signment), on the first or second posting, whenever the running balance
|
||||
field is non-empty. (TODO: #1000)
|
||||
|
||||
Reading multiple CSV files
|
||||
You can read multiple CSV files at once using multiple -f arguments on
|
||||
@ -263,7 +263,7 @@ AUTHORS
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
||||
|
@ -1871,7 +1871,7 @@ Simon Michael <simon@joyful.com> and contributors
|
||||
|
||||
.SH COPYRIGHT
|
||||
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
.br
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
@ -7,9 +7,9 @@ NAME
|
||||
Journal - hledger's default file format, representing a General Journal
|
||||
|
||||
DESCRIPTION
|
||||
hledger's usual data source is a plain text file containing journal
|
||||
entries in hledger journal format. This file represents a standard
|
||||
accounting general journal. I use file names ending in .journal, but
|
||||
hledger's usual data source is a plain text file containing journal en-
|
||||
tries in hledger journal format. This file represents a standard ac-
|
||||
counting general journal. I use file names ending in .journal, but
|
||||
that's not required. The journal file contains a number of transaction
|
||||
entries, each describing a transfer of money (or any commodity) between
|
||||
two or more named accounts, in a simple format readable by both hledger
|
||||
@ -23,8 +23,8 @@ DESCRIPTION
|
||||
|
||||
You can use hledger without learning any more about this file; just use
|
||||
the add or web commands to create and update it. Many users, though,
|
||||
also edit the journal file directly with a text editor, perhaps
|
||||
assisted by the helper modes for emacs or vim.
|
||||
also edit the journal file directly with a text editor, perhaps as-
|
||||
sisted by the helper modes for emacs or vim.
|
||||
|
||||
Here's an example:
|
||||
|
||||
@ -58,9 +58,9 @@ DESCRIPTION
|
||||
FILE FORMAT
|
||||
Transactions
|
||||
Transactions are movements of some quantity of commodities between
|
||||
named accounts. Each transaction is represented by a journal entry
|
||||
beginning with a simple date in column 0. This can be followed by any
|
||||
of the following, separated by spaces:
|
||||
named accounts. Each transaction is represented by a journal entry be-
|
||||
ginning with a simple date in column 0. This can be followed by any of
|
||||
the following, separated by spaces:
|
||||
|
||||
o (optional) a status character (empty, !, or *)
|
||||
|
||||
@ -104,16 +104,16 @@ FILE FORMAT
|
||||
Simple dates
|
||||
Within a journal file, transaction dates use Y/M/D (or Y-M-D or Y.M.D)
|
||||
Leading zeros are optional. The year may be omitted, in which case it
|
||||
will be inferred from the context - the current transaction, the
|
||||
default year set with a default year directive, or the current date
|
||||
when the command is run. Some examples: 2010/01/31, 1/31, 2010-01-31,
|
||||
will be inferred from the context - the current transaction, the de-
|
||||
fault year set with a default year directive, or the current date when
|
||||
the command is run. Some examples: 2010/01/31, 1/31, 2010-01-31,
|
||||
2010.1.31.
|
||||
|
||||
Secondary dates
|
||||
Real-life transactions sometimes involve more than one date - eg the
|
||||
date you write a cheque, and the date it clears in your bank. When you
|
||||
want to model this, eg for more accurate balances, you can specify
|
||||
individual posting dates, which I recommend. Or, you can use the sec-
|
||||
want to model this, eg for more accurate balances, you can specify in-
|
||||
dividual posting dates, which I recommend. Or, you can use the sec-
|
||||
ondary dates (aka auxiliary/effective dates) feature, supported for
|
||||
compatibility with Ledger.
|
||||
|
||||
@ -142,15 +142,15 @@ FILE FORMAT
|
||||
Secondary dates require some effort; you must use them consistently in
|
||||
your journal entries and remember whether to use or not use the --date2
|
||||
flag for your reports. They are included in hledger for Ledger compat-
|
||||
ibility, but posting dates are a more powerful and less confusing
|
||||
alternative.
|
||||
ibility, but posting dates are a more powerful and less confusing al-
|
||||
ternative.
|
||||
|
||||
Posting dates
|
||||
You can give individual postings a different date from their parent
|
||||
transaction, by adding a posting comment containing a tag (see below)
|
||||
like date:DATE. This is probably the best way to control posting dates
|
||||
precisely. Eg in this example the expense should appear in May
|
||||
reports, and the deduction from checking should be reported on 6/1 for
|
||||
precisely. Eg in this example the expense should appear in May re-
|
||||
ports, and the deduction from checking should be reported on 6/1 for
|
||||
easy bank reconciliation:
|
||||
|
||||
2015/5/30
|
||||
@ -177,9 +177,9 @@ FILE FORMAT
|
||||
|
||||
Status
|
||||
Transactions, or individual postings within a transaction, can have a
|
||||
status mark, which is a single character before the transaction
|
||||
description or posting account name, separated from it by a space,
|
||||
indicating one of three statuses:
|
||||
status mark, which is a single character before the transaction de-
|
||||
scription or posting account name, separated from it by a space, indi-
|
||||
cating one of three statuses:
|
||||
|
||||
mark status
|
||||
------------------
|
||||
@ -192,8 +192,8 @@ FILE FORMAT
|
||||
status:* queries; or the U, P, C keys in hledger-ui.
|
||||
|
||||
Note, in Ledger and in older versions of hledger, the "unmarked" state
|
||||
is called "uncleared". As of hledger 1.3 we have renamed it to
|
||||
unmarked for clarity.
|
||||
is called "uncleared". As of hledger 1.3 we have renamed it to un-
|
||||
marked for clarity.
|
||||
|
||||
To replicate Ledger and old hledger's behaviour of also matching pend-
|
||||
ing, combine -U and -P.
|
||||
@ -215,8 +215,8 @@ FILE FORMAT
|
||||
rect
|
||||
|
||||
With this scheme, you would use -PC to see the current balance at your
|
||||
bank, -U to see things which will probably hit your bank soon (like
|
||||
uncashed checks), and no flags to see the most up-to-date state of your
|
||||
bank, -U to see things which will probably hit your bank soon (like un-
|
||||
cashed checks), and no flags to see the most up-to-date state of your
|
||||
finances.
|
||||
|
||||
Description
|
||||
@ -229,9 +229,9 @@ FILE FORMAT
|
||||
Payee and note
|
||||
You can optionally include a | (pipe) character in descriptions to sub-
|
||||
divide the description into separate fields for payee/payer name on the
|
||||
left (up to the first |) and an additional note field on the right
|
||||
(after the first |). This may be worthwhile if you need to do more
|
||||
precise querying and pivoting by payee or by note.
|
||||
left (up to the first |) and an additional note field on the right (af-
|
||||
ter the first |). This may be worthwhile if you need to do more pre-
|
||||
cise querying and pivoting by payee or by note.
|
||||
|
||||
Account names
|
||||
Account names typically have several parts separated by a full colon,
|
||||
@ -580,11 +580,11 @@ FILE FORMAT
|
||||
nodes to be ignored, allowing emacs users to fold and navigate their
|
||||
journals with org-mode or orgstruct-mode.)
|
||||
|
||||
You can attach comments to a transaction by writing them after the
|
||||
description and/or indented on the following lines (before the post-
|
||||
ings). Similarly, you can attach comments to an individual posting by
|
||||
writing them after the amount and/or indented on the following lines.
|
||||
Transaction and posting comments must begin with a semicolon (;).
|
||||
You can attach comments to a transaction by writing them after the de-
|
||||
scription and/or indented on the following lines (before the postings).
|
||||
Similarly, you can attach comments to an individual posting by writing
|
||||
them after the amount and/or indented on the following lines. Transac-
|
||||
tion and posting comments must begin with a semicolon (;).
|
||||
|
||||
Some examples:
|
||||
|
||||
@ -660,33 +660,33 @@ FILE FORMAT
|
||||
here is a table summarising the directives and their effects, with
|
||||
links to more detailed docs.
|
||||
|
||||
direc- end subdi- purpose can affect (as of
|
||||
tive directive rec- 2018/06)
|
||||
direc- end di- subdi- purpose can affect (as of
|
||||
tive rective rec- 2018/06)
|
||||
tives
|
||||
------------------------------------------------------------------------------------
|
||||
account any document account names, all entries in all
|
||||
text declare account types & dis- files, before or
|
||||
account any document account names, de- all entries in all
|
||||
text clare account types & dis- files, before or
|
||||
play order after
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
alias end rewrite account names following
|
||||
aliases inline/included
|
||||
entries until end
|
||||
of current file or
|
||||
end directive
|
||||
apply end apply prepend a common parent to following
|
||||
account account account names inline/included
|
||||
entries until end
|
||||
of current file or
|
||||
end directive
|
||||
comment end com- ignore part of journal following
|
||||
ment inline/included
|
||||
entries until end
|
||||
of current file or
|
||||
end directive
|
||||
alias end rewrite account names following in-
|
||||
aliases line/included en-
|
||||
tries until end of
|
||||
current file or end
|
||||
directive
|
||||
apply end apply prepend a common parent to following in-
|
||||
account account account names line/included en-
|
||||
tries until end of
|
||||
current file or end
|
||||
directive
|
||||
comment end com- ignore part of journal following in-
|
||||
ment line/included en-
|
||||
tries until end of
|
||||
current file or end
|
||||
directive
|
||||
commod- format declare a commodity and its number notation:
|
||||
ity number notation & display following entries
|
||||
style in that commodity
|
||||
@ -709,13 +709,13 @@ FILE FORMAT
|
||||
include include entries/directives what the included
|
||||
from another file directives affect
|
||||
P declare a market price for a amounts of that
|
||||
commodity commodity in
|
||||
reports, when -V is
|
||||
commodity commodity in re-
|
||||
ports, when -V is
|
||||
used
|
||||
Y declare a year for yearless following
|
||||
dates inline/included
|
||||
entries until end
|
||||
of current file
|
||||
Y declare a year for yearless following in-
|
||||
dates line/included en-
|
||||
tries until end of
|
||||
current file
|
||||
|
||||
And some definitions:
|
||||
|
||||
@ -731,8 +731,8 @@ FILE FORMAT
|
||||
scope are affected by a directive
|
||||
|
||||
As you can see, directives vary in which journal entries and files they
|
||||
affect, and whether they are focussed on input (parsing) or output
|
||||
(reports). Some directives have multiple effects.
|
||||
affect, and whether they are focussed on input (parsing) or output (re-
|
||||
ports). Some directives have multiple effects.
|
||||
|
||||
If you have a journal made up of multiple files, or pass multiple -f
|
||||
options on the command line, note that directives which affect input
|
||||
@ -756,8 +756,8 @@ FILE FORMAT
|
||||
file. The include file path may contain common glob patterns (e.g.
|
||||
*).
|
||||
|
||||
The include directive can only be used in journal files. It can
|
||||
include journal, timeclock or timedot files, but not CSV files.
|
||||
The include directive can only be used in journal files. It can in-
|
||||
clude journal, timeclock or timedot files, but not CSV files.
|
||||
|
||||
Default year
|
||||
You can set a default year to be used for subsequent dates which don't
|
||||
@ -813,8 +813,8 @@ FILE FORMAT
|
||||
|
||||
Normally the display format is inferred from journal entries, but this
|
||||
can be unpredictable; declaring it with a commodity directive overrides
|
||||
this and removes ambiguity. Towards this end, amounts in commodity
|
||||
directives must always be written with a decimal point (a period or
|
||||
this and removes ambiguity. Towards this end, amounts in commodity di-
|
||||
rectives must always be written with a decimal point (a period or
|
||||
comma, followed by 0 or more decimal digits).
|
||||
|
||||
Commodity directives do not affect how amounts are parsed; the parser
|
||||
@ -839,8 +839,8 @@ FILE FORMAT
|
||||
a decimal point.
|
||||
|
||||
Market prices
|
||||
The P directive declares a market price, which is an exchange rate
|
||||
between two commodities on a certain date. (In Ledger, they are called
|
||||
The P directive declares a market price, which is an exchange rate be-
|
||||
tween two commodities on a certain date. (In Ledger, they are called
|
||||
"historical prices".) These are often obtained from a stock exchange,
|
||||
cryptocurrency exchange, or the foreign exchange market.
|
||||
|
||||
@ -865,8 +865,8 @@ FILE FORMAT
|
||||
commodity using these prices.
|
||||
|
||||
Declaring accounts
|
||||
account directives can be used to pre-declare accounts. Though not
|
||||
required, they can provide several benefits:
|
||||
account directives can be used to pre-declare accounts. Though not re-
|
||||
quired, they can provide several benefits:
|
||||
|
||||
o They can document your intended chart of accounts, providing a refer-
|
||||
ence.
|
||||
@ -925,8 +925,8 @@ FILE FORMAT
|
||||
detected automatically.
|
||||
|
||||
Account types declared with tags
|
||||
More generally, you can declare an account's type with an account
|
||||
directive, by writing a type: tag in a comment, followed by one of the
|
||||
More generally, you can declare an account's type with an account di-
|
||||
rective, by writing a type: tag in a comment, followed by one of the
|
||||
words Asset, Liability, Equity, Revenue, Expense, or one of the letters
|
||||
ALERX (case insensitive):
|
||||
|
||||
@ -1025,9 +1025,9 @@ FILE FORMAT
|
||||
Or, you can use the --alias 'OLD=NEW' option on the command line. This
|
||||
affects all entries. It's useful for trying out aliases interactively.
|
||||
|
||||
OLD and NEW are case sensitive full account names. hledger will
|
||||
replace any occurrence of the old account name with the new one. Sub-
|
||||
accounts are also affected. Eg:
|
||||
OLD and NEW are case sensitive full account names. hledger will re-
|
||||
place any occurrence of the old account name with the new one. Subac-
|
||||
counts are also affected. Eg:
|
||||
|
||||
alias checking = assets:bank:wells fargo:checking
|
||||
; rewrites "checking" to "assets:bank:wells fargo:checking", or "checking:a" to "assets:bank:wells fargo:checking:a"
|
||||
@ -1092,9 +1092,9 @@ FILE FORMAT
|
||||
end aliases
|
||||
|
||||
Default parent account
|
||||
You can specify a parent account which will be prepended to all
|
||||
accounts within a section of the journal. Use the apply account and
|
||||
end apply account directives like so:
|
||||
You can specify a parent account which will be prepended to all ac-
|
||||
counts within a section of the journal. Use the apply account and end
|
||||
apply account directives like so:
|
||||
|
||||
apply account home
|
||||
|
||||
@ -1128,8 +1128,8 @@ FILE FORMAT
|
||||
account.
|
||||
|
||||
Periodic transactions
|
||||
Periodic transaction rules describe transactions that recur. They
|
||||
allow hledger to generate temporary future transactions to help with
|
||||
Periodic transaction rules describe transactions that recur. They al-
|
||||
low hledger to generate temporary future transactions to help with
|
||||
forecasting, so you don't have to write out each one in the journal,
|
||||
and it's easy to try out different forecasts. Secondly, they are also
|
||||
used to define the budgets shown in budget reports.
|
||||
@ -1150,8 +1150,8 @@ FILE FORMAT
|
||||
4. Forecasted transactions will end 6 months from today, by default.
|
||||
See below for the exact start/end rules.
|
||||
|
||||
5. period expressions can be tricky. Their documentation needs
|
||||
improvement, but is worth studying.
|
||||
5. period expressions can be tricky. Their documentation needs im-
|
||||
provement, but is worth studying.
|
||||
|
||||
6. Some period expressions with a repeating interval must begin on a
|
||||
natural boundary of that interval. Eg in weekly from DATE, DATE
|
||||
@ -1201,12 +1201,12 @@ FILE FORMAT
|
||||
o Do write two spaces between your period expression and your transac-
|
||||
tion description, if any.
|
||||
|
||||
o Don't accidentally write two spaces in the middle of your period
|
||||
expression.
|
||||
o Don't accidentally write two spaces in the middle of your period ex-
|
||||
pression.
|
||||
|
||||
Forecasting with periodic transactions
|
||||
With the --forecast flag, each periodic transaction rule generates
|
||||
future transactions recurring at the specified interval. These are not
|
||||
With the --forecast flag, each periodic transaction rule generates fu-
|
||||
ture transactions recurring at the specified interval. These are not
|
||||
saved in the journal, but appear in all reports. They will look like
|
||||
normal transactions, but with an extra tag:
|
||||
|
||||
@ -1390,7 +1390,7 @@ AUTHORS
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
||||
|
@ -80,7 +80,7 @@ Simon Michael <simon@joyful.com> and contributors
|
||||
|
||||
.SH COPYRIGHT
|
||||
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
.br
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
@ -65,7 +65,7 @@ AUTHORS
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
||||
|
@ -142,7 +142,7 @@ Simon Michael <simon@joyful.com> and contributors
|
||||
|
||||
.SH COPYRIGHT
|
||||
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
.br
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
@ -28,8 +28,8 @@ FILE FORMAT
|
||||
|
||||
Quantities can be written as:
|
||||
|
||||
o a sequence of dots (.) representing quarter hours. Spaces may
|
||||
optionally be used for grouping and readability. Eg: .... ..
|
||||
o a sequence of dots (.) representing quarter hours. Spaces may op-
|
||||
tionally be used for grouping and readability. Eg: .... ..
|
||||
|
||||
o an integral or decimal number, representing hours. Eg: 1.5
|
||||
|
||||
@ -111,7 +111,7 @@ AUTHORS
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
||||
|
@ -5,7 +5,7 @@
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
hledger-ui - curses-style interface for the hledger accounting tool
|
||||
hledger-ui - terminal interface for the hledger accounting tool
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R]
|
||||
@ -20,9 +20,9 @@ other commodity, using double-entry accounting and a simple, editable
|
||||
file format.
|
||||
hledger is inspired by and largely compatible with ledger(1).
|
||||
.PP
|
||||
hledger-ui is hledger\[aq]s curses-style interface, providing an
|
||||
efficient full-window text UI for viewing accounts and transactions, and
|
||||
some limited data entry capability.
|
||||
hledger-ui is hledger\[aq]s terminal interface, providing an efficient
|
||||
full-window text UI for viewing accounts and transactions, and some
|
||||
limited data entry capability.
|
||||
It is easier than hledger\[aq]s command-line interface, and sometimes
|
||||
quicker and more convenient than the web interface.
|
||||
.PP
|
||||
@ -245,7 +245,7 @@ updated file.
|
||||
This allows some basic data entry.
|
||||
.PP
|
||||
\f[C]A\f[R] is like \f[C]a\f[R], but runs the hledger-iadd tool, which
|
||||
provides a curses-style interface.
|
||||
provides a terminal interface.
|
||||
This key will be available if \f[C]hledger-iadd\f[R] is installed in
|
||||
$PATH.
|
||||
.PP
|
||||
@ -440,7 +440,7 @@ Simon Michael <simon@joyful.com> and contributors
|
||||
|
||||
.SH COPYRIGHT
|
||||
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
.br
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
@ -6,7 +6,7 @@ File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir)
|
||||
hledger-ui(1) hledger-ui 1.15
|
||||
*****************************
|
||||
|
||||
hledger-ui is hledger's curses-style interface, providing an efficient
|
||||
hledger-ui is hledger's terminal interface, providing an efficient
|
||||
full-window text UI for viewing accounts and transactions, and some
|
||||
limited data entry capability. It is easier than hledger's command-line
|
||||
interface, and sometimes quicker and more convenient than the web
|
||||
@ -239,7 +239,7 @@ temporarily can be useful for troubleshooting.
|
||||
file. This allows some basic data entry.
|
||||
|
||||
'A' is like 'a', but runs the hledger-iadd tool, which provides a
|
||||
curses-style interface. This key will be available if 'hledger-iadd' is
|
||||
terminal interface. This key will be available if 'hledger-iadd' is
|
||||
installed in $PATH.
|
||||
|
||||
'E' runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default ('emacsclient
|
||||
@ -399,19 +399,19 @@ to cancel the reload attempt.)
|
||||
|
||||
Tag Table:
|
||||
Node: Top71
|
||||
Node: OPTIONS1101
|
||||
Ref: #options1198
|
||||
Node: KEYS4589
|
||||
Ref: #keys4684
|
||||
Node: SCREENS7940
|
||||
Ref: #screens8025
|
||||
Node: Accounts screen8115
|
||||
Ref: #accounts-screen8243
|
||||
Node: Register screen10459
|
||||
Ref: #register-screen10614
|
||||
Node: Transaction screen12610
|
||||
Ref: #transaction-screen12768
|
||||
Node: Error screen13638
|
||||
Ref: #error-screen13760
|
||||
Node: OPTIONS1097
|
||||
Ref: #options1194
|
||||
Node: KEYS4585
|
||||
Ref: #keys4680
|
||||
Node: SCREENS7932
|
||||
Ref: #screens8017
|
||||
Node: Accounts screen8107
|
||||
Ref: #accounts-screen8235
|
||||
Node: Register screen10451
|
||||
Ref: #register-screen10606
|
||||
Node: Transaction screen12602
|
||||
Ref: #transaction-screen12760
|
||||
Node: Error screen13630
|
||||
Ref: #error-screen13752
|
||||
|
||||
End Tag Table
|
||||
|
@ -4,7 +4,7 @@ hledger-ui(1) hledger User Manuals hledger-ui(1)
|
||||
|
||||
|
||||
NAME
|
||||
hledger-ui - curses-style interface for the hledger accounting tool
|
||||
hledger-ui - terminal interface for the hledger accounting tool
|
||||
|
||||
SYNOPSIS
|
||||
hledger-ui [OPTIONS] [QUERYARGS]
|
||||
@ -16,7 +16,7 @@ DESCRIPTION
|
||||
file format. hledger is inspired by and largely compatible with
|
||||
ledger(1).
|
||||
|
||||
hledger-ui is hledger's curses-style interface, providing an efficient
|
||||
hledger-ui is hledger's terminal interface, providing an efficient
|
||||
full-window text UI for viewing accounts and transactions, and some
|
||||
limited data entry capability. It is easier than hledger's command-
|
||||
line interface, and sometimes quicker and more convenient than the web
|
||||
@ -117,8 +117,8 @@ OPTIONS
|
||||
using period expressions syntax
|
||||
|
||||
--date2
|
||||
match the secondary date instead (see command help for other
|
||||
effects)
|
||||
match the secondary date instead (see command help for other ef-
|
||||
fects)
|
||||
|
||||
-U --unmarked
|
||||
include only unmarked postings/txns (can combine with -P or -C)
|
||||
@ -204,8 +204,8 @@ KEYS
|
||||
BACKSPACE or DELETE removes all filters, showing all transactions.
|
||||
|
||||
As mentioned above, hledger-ui shows auto-generated periodic transac-
|
||||
tions, and hides future transactions (auto-generated or not) by
|
||||
default. F toggles showing and hiding these future transactions. This
|
||||
tions, and hides future transactions (auto-generated or not) by de-
|
||||
fault. F toggles showing and hiding these future transactions. This
|
||||
is similar to using a query like date:-tomorrow, but more convenient.
|
||||
(experimental)
|
||||
|
||||
@ -226,9 +226,9 @@ KEYS
|
||||
a runs command-line hledger's add command, and reloads the updated
|
||||
file. This allows some basic data entry.
|
||||
|
||||
A is like a, but runs the hledger-iadd tool, which provides a curses-
|
||||
style interface. This key will be available if hledger-iadd is
|
||||
installed in $PATH.
|
||||
A is like a, but runs the hledger-iadd tool, which provides a terminal
|
||||
interface. This key will be available if hledger-iadd is installed in
|
||||
$PATH.
|
||||
|
||||
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a ""
|
||||
-nw) on the journal file. With some editors (emacs, vi), the cursor
|
||||
@ -250,36 +250,35 @@ SCREENS
|
||||
|
||||
Account names are shown as a flat list by default. Press T to toggle
|
||||
tree mode. In flat mode, account balances are exclusive of subac-
|
||||
counts, except where subaccounts are hidden by a depth limit (see
|
||||
below). In tree mode, all account balances are inclusive of subac-
|
||||
counts.
|
||||
counts, except where subaccounts are hidden by a depth limit (see be-
|
||||
low). In tree mode, all account balances are inclusive of subaccounts.
|
||||
|
||||
To see less detail, press a number key, 1 to 9, to set a depth limit.
|
||||
To see less detail, press a number key, 1 to 9, to set a depth limit.
|
||||
Or use - to decrease and +/= to increase the depth limit. 0 shows even
|
||||
less detail, collapsing all accounts to a single total. To remove the
|
||||
depth limit, set it higher than the maximum account depth, or press
|
||||
ESCAPE.
|
||||
less detail, collapsing all accounts to a single total. To remove the
|
||||
depth limit, set it higher than the maximum account depth, or press ES-
|
||||
CAPE.
|
||||
|
||||
H toggles between showing historical balances or period balances. His-
|
||||
torical balances (the default) are ending balances at the end of the
|
||||
report period, taking into account all transactions before that date
|
||||
(filtered by the filter query if any), including transactions before
|
||||
the start of the report period. In other words, historical balances
|
||||
are what you would see on a bank statement for that account (unless
|
||||
disturbed by a filter query). Period balances ignore transactions
|
||||
before the report start date, so they show the change in balance during
|
||||
torical balances (the default) are ending balances at the end of the
|
||||
report period, taking into account all transactions before that date
|
||||
(filtered by the filter query if any), including transactions before
|
||||
the start of the report period. In other words, historical balances
|
||||
are what you would see on a bank statement for that account (unless
|
||||
disturbed by a filter query). Period balances ignore transactions be-
|
||||
fore the report start date, so they show the change in balance during
|
||||
the report period. They are more useful eg when viewing a time log.
|
||||
|
||||
U toggles filtering by unmarked status, including or excluding unmarked
|
||||
postings in the balances. Similarly, P toggles pending postings, and C
|
||||
toggles cleared postings. (By default, balances include all postings;
|
||||
if you activate one or two status filters, only those postings are
|
||||
included; and if you activate all three, the filter is removed.)
|
||||
toggles cleared postings. (By default, balances include all postings;
|
||||
if you activate one or two status filters, only those postings are in-
|
||||
cluded; and if you activate all three, the filter is removed.)
|
||||
|
||||
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.
|
||||
@ -288,63 +287,63 @@ 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 running historical total or period total for the current account,
|
||||
after the transaction. This can be toggled with H. Similar to the
|
||||
accounts screen, the historical total is affected by transactions
|
||||
(filtered by the filter query) before the report start date, while
|
||||
after the transaction. This can be toggled with H. Similar to the
|
||||
accounts screen, the historical total is affected by transactions
|
||||
(filtered by the filter query) before the report start date, while
|
||||
the period total is not. If the historical total is not disturbed by
|
||||
a filter query, it will be the running historical balance you would
|
||||
a filter query, it will be the running historical balance you would
|
||||
see on a bank register for the current account.
|
||||
|
||||
Transactions affecting this account's subaccounts will be included in
|
||||
Transactions affecting this account's subaccounts will be included in
|
||||
the register if the accounts screen is in tree mode, or if it's in flat
|
||||
mode but this account has subaccounts which are not shown due to a
|
||||
depth limit. In other words, the register always shows the transac-
|
||||
mode but this account has subaccounts which are not shown due to a
|
||||
depth limit. In other words, the register always shows the transac-
|
||||
tions contributing to the balance shown on the accounts screen.
|
||||
Tree mode/flat mode can be toggled with T here also.
|
||||
|
||||
U toggles filtering by unmarked status, showing or hiding unmarked
|
||||
U toggles filtering by unmarked status, showing or hiding unmarked
|
||||
transactions. Similarly, P toggles pending transactions, and C toggles
|
||||
cleared transactions. (By default, transactions with all statuses are
|
||||
shown; if you activate one or two status filters, only those transac-
|
||||
cleared transactions. (By default, transactions with all statuses are
|
||||
shown; if you activate one or two status filters, only those transac-
|
||||
tions are shown; and if you activate all three, the filter is removed.)
|
||||
|
||||
R toggles real mode, in which virtual postings are ignored.
|
||||
|
||||
Z toggles nonzero mode, in which only transactions posting a nonzero
|
||||
change are shown (hledger-ui shows zero items by default, unlike com-
|
||||
Z toggles nonzero mode, in which only transactions posting a nonzero
|
||||
change are shown (hledger-ui shows zero items by default, unlike com-
|
||||
mand-line hledger).
|
||||
|
||||
Press right (or enter) to view the selected transaction in detail.
|
||||
|
||||
Transaction screen
|
||||
This screen shows a single transaction, as a general journal entry,
|
||||
similar to hledger's print command and journal format (hledger_jour-
|
||||
This screen shows a single transaction, as a general journal entry,
|
||||
similar to hledger's print command and journal format (hledger_jour-
|
||||
nal(5)).
|
||||
|
||||
The transaction's date(s) and any cleared flag, transaction code,
|
||||
description, comments, along with all of its account postings are
|
||||
shown. Simple transactions have two postings, but there can be more
|
||||
(or in certain cases, fewer).
|
||||
The transaction's date(s) and any cleared flag, transaction code, de-
|
||||
scription, comments, along with all of its account postings are shown.
|
||||
Simple transactions have two postings, but there can be more (or in
|
||||
certain cases, fewer).
|
||||
|
||||
up and down will step through all transactions listed in the previous
|
||||
account register screen. In the title bar, the numbers in parentheses
|
||||
show your position within that account register. They will vary
|
||||
depending on which account register you came from (remember most trans-
|
||||
actions appear in multiple account registers). The #N number preceding
|
||||
up and down will step through all transactions listed in the previous
|
||||
account register screen. In the title bar, the numbers in parentheses
|
||||
show your position within that account register. They will vary de-
|
||||
pending on which account register you came from (remember most transac-
|
||||
tions appear in multiple account registers). The #N number preceding
|
||||
them is the transaction's position within the complete unfiltered jour-
|
||||
nal, which is a more stable id (at least until the next reload).
|
||||
|
||||
Error screen
|
||||
This screen will appear if there is a problem, such as a parse error,
|
||||
when you press g to reload. Once you have fixed the problem, press g
|
||||
This screen will appear if there is a problem, such as a parse error,
|
||||
when you press g to reload. Once you have fixed the problem, press g
|
||||
again to reload and resume normal operation. (Or, you can press escape
|
||||
to cancel the reload attempt.)
|
||||
|
||||
@ -352,17 +351,17 @@ ENVIRONMENT
|
||||
COLUMNS The screen width to use. Default: the full terminal width.
|
||||
|
||||
LEDGER_FILE The journal file path when not specified with -f. Default:
|
||||
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
|
||||
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
|
||||
nal).
|
||||
|
||||
FILES
|
||||
Reads data from one or more files in hledger journal, timeclock, time-
|
||||
dot, or CSV format specified with -f, or $LEDGER_FILE, or
|
||||
$HOME/.hledger.journal (on windows, perhaps
|
||||
Reads data from one or more files in hledger journal, timeclock, time-
|
||||
dot, or CSV format specified with -f, or $LEDGER_FILE, or
|
||||
$HOME/.hledger.journal (on windows, perhaps
|
||||
C:/Users/USER/.hledger.journal).
|
||||
|
||||
BUGS
|
||||
The need to precede options with -- when invoked from hledger is awk-
|
||||
The need to precede options with -- when invoked from hledger is awk-
|
||||
ward.
|
||||
|
||||
-f- doesn't work (hledger-ui can't read from stdin).
|
||||
@ -370,24 +369,24 @@ BUGS
|
||||
-V affects only the accounts screen.
|
||||
|
||||
When you press g, the current and all previous screens are regenerated,
|
||||
which may cause a noticeable pause with large files. Also there is no
|
||||
which may cause a noticeable pause with large files. Also there is no
|
||||
visual indication that this is in progress.
|
||||
|
||||
--watch is not yet fully robust. It works well for normal usage, but
|
||||
many file changes in a short time (eg saving the file thousands of
|
||||
times with an editor macro) can cause problems at least on OSX. Symp-
|
||||
toms include: unresponsive UI, periodic resetting of the cursor posi-
|
||||
--watch is not yet fully robust. It works well for normal usage, but
|
||||
many file changes in a short time (eg saving the file thousands of
|
||||
times with an editor macro) can cause problems at least on OSX. Symp-
|
||||
toms include: unresponsive UI, periodic resetting of the cursor posi-
|
||||
tion, momentary display of parse errors, high CPU usage eventually sub-
|
||||
siding, and possibly a small but persistent build-up of CPU usage until
|
||||
the program is restarted.
|
||||
|
||||
Also, if you are viewing files mounted from another machine, --watch
|
||||
Also, if you are viewing files mounted from another machine, --watch
|
||||
requires that both machine clocks are roughly in step.
|
||||
|
||||
|
||||
|
||||
REPORTING BUGS
|
||||
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
|
||||
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
|
||||
or hledger mail list)
|
||||
|
||||
|
||||
@ -396,12 +395,12 @@ AUTHORS
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
|
||||
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
|
||||
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
|
||||
dot(5), ledger(1)
|
||||
|
||||
|
@ -289,9 +289,8 @@ that both machine clocks are roughly in step.)
|
||||
.PP
|
||||
In addition to the web UI, hledger-web provides some API routes that
|
||||
serve JSON in response to GET requests.
|
||||
Currently these are same ones provided by the hledger-api tool, but
|
||||
hledger-web will likely receive more attention than hledger-api in
|
||||
future:
|
||||
(And when started with \f[C]--serve-api\f[R], it provides only these
|
||||
routes.):
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
@ -377,7 +376,7 @@ Simon Michael <simon@joyful.com> and contributors
|
||||
|
||||
.SH COPYRIGHT
|
||||
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
.br
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
@ -298,9 +298,8 @@ File: hledger-web.info, Node: JSON API, Prev: RELOADING, Up: Top
|
||||
**********
|
||||
|
||||
In addition to the web UI, hledger-web provides some API routes that
|
||||
serve JSON in response to GET requests. Currently these are same ones
|
||||
provided by the hledger-api tool, but hledger-web will likely receive
|
||||
more attention than hledger-api in future:
|
||||
serve JSON in response to GET requests. (And when started with
|
||||
'--serve-api', it provides only these routes.):
|
||||
|
||||
/accountnames
|
||||
/transactions
|
||||
|
@ -19,9 +19,9 @@ DESCRIPTION
|
||||
hledger-web is hledger's web interface. It starts a simple web appli-
|
||||
cation for browsing and adding transactions, and optionally opens it in
|
||||
a web browser window if possible. It provides a more user-friendly UI
|
||||
than the hledger CLI or hledger-ui interface, showing more at once
|
||||
(accounts, the current account register, balance charts) and allowing
|
||||
history-aware data entry, interactive searching, and bookmarking.
|
||||
than the hledger CLI or hledger-ui interface, showing more at once (ac-
|
||||
counts, the current account register, balance charts) and allowing his-
|
||||
tory-aware data entry, interactive searching, and bookmarking.
|
||||
|
||||
hledger-web also lets you share a ledger with multiple users, or even
|
||||
the public web. There is no access control, so if you need that you
|
||||
@ -127,8 +127,8 @@ OPTIONS
|
||||
using period expressions syntax
|
||||
|
||||
--date2
|
||||
match the secondary date instead (see command help for other
|
||||
effects)
|
||||
match the secondary date instead (see command help for other ef-
|
||||
fects)
|
||||
|
||||
-U --unmarked
|
||||
include only unmarked postings/txns (can combine with -P or -C)
|
||||
@ -214,8 +214,8 @@ PERMISSIONS
|
||||
You can restrict who can reach it by
|
||||
|
||||
o setting the IP address it listens on (see --host above). By default
|
||||
it listens on 127.0.0.1, accessible to all users on the local
|
||||
machine.
|
||||
it listens on 127.0.0.1, accessible to all users on the local ma-
|
||||
chine.
|
||||
|
||||
o putting it behind an authenticating proxy, using eg apache or nginx
|
||||
|
||||
@ -231,8 +231,8 @@ PERMISSIONS
|
||||
|
||||
o add - allows adding new transactions to the main journal file
|
||||
|
||||
o manage - allows editing, uploading or downloading the main or
|
||||
included files
|
||||
o manage - allows editing, uploading or downloading the main or in-
|
||||
cluded files
|
||||
|
||||
o using the --capabilities-header=HTTPHEADER flag to specify a HTTP
|
||||
header from which it will read capabilities to enable. hledger-web
|
||||
@ -242,8 +242,8 @@ PERMISSIONS
|
||||
EDITING, UPLOADING, DOWNLOADING
|
||||
If you enable the manage capability mentioned above, you'll see a new
|
||||
"spanner" button to the right of the search form. Clicking this will
|
||||
let you edit, upload, or download the journal file or any files it
|
||||
includes.
|
||||
let you edit, upload, or download the journal file or any files it in-
|
||||
cludes.
|
||||
|
||||
Note, unlike any other hledger command, in this mode you (or any visi-
|
||||
tor) can alter or wipe the data files.
|
||||
@ -262,17 +262,16 @@ RELOADING
|
||||
hledger-web detects changes made to the files by other means (eg if you
|
||||
edit it directly, outside of hledger-web), and it will show the new
|
||||
data when you reload the page or navigate to a new page. If a change
|
||||
makes a file unparseable, hledger-web will display an error message
|
||||
until the file has been fixed.
|
||||
makes a file unparseable, hledger-web will display an error message un-
|
||||
til the file has been fixed.
|
||||
|
||||
(Note: if you are viewing files mounted from another machine, make sure
|
||||
that both machine clocks are roughly in step.)
|
||||
|
||||
JSON API
|
||||
In addition to the web UI, hledger-web provides some API routes that
|
||||
serve JSON in response to GET requests. Currently these are same ones
|
||||
provided by the hledger-api tool, but hledger-web will likely receive
|
||||
more attention than hledger-api in future:
|
||||
serve JSON in response to GET requests. (And when started with
|
||||
--serve-api, it provides only these routes.):
|
||||
|
||||
/accountnames
|
||||
/transactions
|
||||
@ -281,17 +280,17 @@ JSON API
|
||||
/accounts
|
||||
/accounttransactions/#AccountName
|
||||
|
||||
Also, you can append a new transaction to the journal by sending a PUT
|
||||
request to /add (hledger-web only). As with the web UI's add form,
|
||||
hledger-web must be started with the add capability for this (enabled
|
||||
Also, you can append a new transaction to the journal by sending a PUT
|
||||
request to /add (hledger-web only). As with the web UI's add form,
|
||||
hledger-web must be started with the add capability for this (enabled
|
||||
by default).
|
||||
|
||||
The payload should be a valid hledger transaction as JSON, similar to
|
||||
The payload should be a valid hledger transaction as JSON, similar to
|
||||
what you get from /transactions or /accounttransactions.
|
||||
|
||||
Another way to generate test data is with the readJsonFile/writeJson-
|
||||
File helpers in Hledger.Web.Json, which read or write any of hledger's
|
||||
JSON-capable types from or to a file. Eg here we write the first
|
||||
Another way to generate test data is with the readJsonFile/writeJson-
|
||||
File helpers in Hledger.Web.Json, which read or write any of hledger's
|
||||
JSON-capable types from or to a file. Eg here we write the first
|
||||
transaction of a sample journal:
|
||||
|
||||
$ make ghci-web
|
||||
@ -306,23 +305,23 @@ JSON API
|
||||
|
||||
$ curl -s http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.pretty.json; echo
|
||||
|
||||
By default, both the server-side HTML UI and the JSON API are served.
|
||||
Running with --serve-api disables the former, useful if you only want
|
||||
By default, both the server-side HTML UI and the JSON API are served.
|
||||
Running with --serve-api disables the former, useful if you only want
|
||||
to serve the API.
|
||||
|
||||
ENVIRONMENT
|
||||
LEDGER_FILE The journal file path when not specified with -f. Default:
|
||||
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
|
||||
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
|
||||
nal).
|
||||
|
||||
FILES
|
||||
Reads data from one or more files in hledger journal, timeclock, time-
|
||||
dot, or CSV format specified with -f, or $LEDGER_FILE, or
|
||||
$HOME/.hledger.journal (on windows, perhaps
|
||||
Reads data from one or more files in hledger journal, timeclock, time-
|
||||
dot, or CSV format specified with -f, or $LEDGER_FILE, or
|
||||
$HOME/.hledger.journal (on windows, perhaps
|
||||
C:/Users/USER/.hledger.journal).
|
||||
|
||||
BUGS
|
||||
The need to precede options with -- when invoked from hledger is awk-
|
||||
The need to precede options with -- when invoked from hledger is awk-
|
||||
ward.
|
||||
|
||||
-f- doesn't work (hledger-web can't read from stdin).
|
||||
@ -336,7 +335,7 @@ BUGS
|
||||
|
||||
|
||||
REPORTING BUGS
|
||||
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
|
||||
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
|
||||
or hledger mail list)
|
||||
|
||||
|
||||
@ -345,12 +344,12 @@ AUTHORS
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
|
||||
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
|
||||
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
|
||||
dot(5), ledger(1)
|
||||
|
||||
|
@ -30,8 +30,8 @@ hledger is inspired by and largely compatible with ledger(1).
|
||||
Tested on unix, mac, windows, hledger aims to be a reliable, practical
|
||||
tool for daily use.
|
||||
.PP
|
||||
This is hledger\[cq]s command-line interface (there are also curses and
|
||||
web interfaces).
|
||||
This is hledger\[cq]s command-line interface (there are also terminal
|
||||
and web interfaces).
|
||||
Its basic function is to read a plain text file describing financial
|
||||
transactions (in accounting terms, a general journal) and print useful
|
||||
reports on standard output, or export them as CSV.
|
||||
@ -2820,7 +2820,7 @@ Examples:
|
||||
\f[C]
|
||||
$ hledger help
|
||||
Please choose a manual by typing \[dq]hledger help MANUAL\[dq] (a substring is ok).
|
||||
Manuals: hledger hledger-ui hledger-web hledger-api journal csv timeclock timedot
|
||||
Manuals: hledger hledger-ui hledger-web journal csv timeclock timedot
|
||||
\f[R]
|
||||
.fi
|
||||
.IP
|
||||
@ -2852,6 +2852,8 @@ import
|
||||
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 transactions that would be added.
|
||||
Or with --catchup, just mark all of the FILEs\[aq] transactions as
|
||||
imported, without actually importing any.
|
||||
.PP
|
||||
The input files are specified as arguments - no need to write -f before
|
||||
each one.
|
||||
@ -3602,12 +3604,9 @@ Here are some hledger add-ons available:
|
||||
.SS Official add-ons
|
||||
.PP
|
||||
These are maintained and released along with hledger.
|
||||
.SS api
|
||||
.PP
|
||||
hledger-api serves hledger data as a JSON web API.
|
||||
.SS ui
|
||||
.PP
|
||||
hledger-ui provides an efficient curses-style interface.
|
||||
hledger-ui provides an efficient terminal interface.
|
||||
.SS web
|
||||
.PP
|
||||
hledger-web provides a simple web interface.
|
||||
@ -3621,7 +3620,7 @@ hledger-diff shows differences in an account\[aq]s transactions between
|
||||
one journal file and another.
|
||||
.SS iadd
|
||||
.PP
|
||||
hledger-iadd is a curses-style, more interactive replacement for the add
|
||||
hledger-iadd is a more interactive, terminal UI replacement for the add
|
||||
command.
|
||||
.SS interest
|
||||
.PP
|
||||
@ -3784,7 +3783,7 @@ Simon Michael <simon@joyful.com> and contributors
|
||||
|
||||
.SH COPYRIGHT
|
||||
|
||||
Copyright (C) 2007-2016 Simon Michael.
|
||||
Copyright (C) 2007-2019 Simon Michael.
|
||||
.br
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
@ -6,13 +6,13 @@ File: hledger.info, Node: Top, Next: EXAMPLES, Up: (dir)
|
||||
hledger(1) hledger 1.15.2
|
||||
*************************
|
||||
|
||||
This is hledger's command-line interface (there are also curses and web
|
||||
interfaces). Its basic function is to read a plain text file describing
|
||||
financial transactions (in accounting terms, a general journal) and
|
||||
print useful reports on standard output, or export them as CSV. hledger
|
||||
can also read some other file formats such as CSV files, translating
|
||||
them to journal format. Additionally, hledger lists other hledger-*
|
||||
executables found in the user's $PATH and can invoke them as
|
||||
This is hledger's command-line interface (there are also terminal and
|
||||
web interfaces). Its basic function is to read a plain text file
|
||||
describing financial transactions (in accounting terms, a general
|
||||
journal) and print useful reports on standard output, or export them as
|
||||
CSV. hledger can also read some other file formats such as CSV files,
|
||||
translating them to journal format. Additionally, hledger lists other
|
||||
hledger-* executables found in the user's $PATH and can invoke them as
|
||||
subcommands.
|
||||
|
||||
hledger reads data from one or more files in hledger journal,
|
||||
@ -2320,7 +2320,7 @@ particular viewer with the '--info', '--man', '--pager', '--cat' flags.
|
||||
|
||||
$ hledger help
|
||||
Please choose a manual by typing "hledger help MANUAL" (a substring is ok).
|
||||
Manuals: hledger hledger-ui hledger-web hledger-api journal csv timeclock timedot
|
||||
Manuals: hledger hledger-ui hledger-web journal csv timeclock timedot
|
||||
|
||||
$ hledger help h --man
|
||||
|
||||
@ -2347,7 +2347,8 @@ File: hledger.info, Node: import, Next: incomestatement, Prev: help, Up: COM
|
||||
import
|
||||
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 transactions
|
||||
that would be added.
|
||||
that would be added. Or with -catchup, just mark all of the FILEs'
|
||||
transactions as imported, without actually importing any.
|
||||
|
||||
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
|
||||
@ -3036,30 +3037,21 @@ These are maintained and released along with hledger.
|
||||
|
||||
* Menu:
|
||||
|
||||
* api::
|
||||
* ui::
|
||||
* web::
|
||||
|
||||
|
||||
File: hledger.info, Node: api, Next: ui, Up: Official add-ons
|
||||
File: hledger.info, Node: ui, Next: web, Up: Official add-ons
|
||||
|
||||
5.1.1 api
|
||||
---------
|
||||
|
||||
hledger-api serves hledger data as a JSON web API.
|
||||
|
||||
|
||||
File: hledger.info, Node: ui, Next: web, Prev: api, Up: Official add-ons
|
||||
|
||||
5.1.2 ui
|
||||
5.1.1 ui
|
||||
--------
|
||||
|
||||
hledger-ui provides an efficient curses-style interface.
|
||||
hledger-ui provides an efficient terminal interface.
|
||||
|
||||
|
||||
File: hledger.info, Node: web, Prev: ui, Up: Official add-ons
|
||||
|
||||
5.1.3 web
|
||||
5.1.2 web
|
||||
---------
|
||||
|
||||
hledger-web provides a simple web interface.
|
||||
@ -3092,7 +3084,7 @@ File: hledger.info, Node: iadd, Next: interest, Prev: , Up: Third party add-
|
||||
5.2.2 iadd
|
||||
----------
|
||||
|
||||
hledger-iadd is a curses-style, more interactive replacement for the add
|
||||
hledger-iadd is a more interactive, terminal UI replacement for the add
|
||||
command.
|
||||
|
||||
|
||||
@ -3159,179 +3151,177 @@ hledger-check.hs checks more powerful account balance assertions.
|
||||
|
||||
Tag Table:
|
||||
Node: Top68
|
||||
Node: EXAMPLES1889
|
||||
Ref: #examples1989
|
||||
Node: OPTIONS3635
|
||||
Ref: #options3737
|
||||
Node: General options4136
|
||||
Ref: #general-options4261
|
||||
Node: Command options6915
|
||||
Ref: #command-options7066
|
||||
Node: Command arguments7464
|
||||
Ref: #command-arguments7618
|
||||
Node: Argument files7739
|
||||
Ref: #argument-files7915
|
||||
Node: Special characters in arguments and queries8181
|
||||
Ref: #special-characters-in-arguments-and-queries8415
|
||||
Node: More escaping8866
|
||||
Ref: #more-escaping9028
|
||||
Node: Even more escaping9324
|
||||
Ref: #even-more-escaping9518
|
||||
Node: Less escaping10189
|
||||
Ref: #less-escaping10351
|
||||
Node: Command line tips10596
|
||||
Ref: #command-line-tips10782
|
||||
Node: Unicode characters11159
|
||||
Ref: #unicode-characters11315
|
||||
Node: Input files12727
|
||||
Ref: #input-files12863
|
||||
Node: Smart dates14792
|
||||
Ref: #smart-dates14933
|
||||
Node: Report start & end date16339
|
||||
Ref: #report-start-end-date16511
|
||||
Node: Report intervals17935
|
||||
Ref: #report-intervals18100
|
||||
Node: Period expressions18490
|
||||
Ref: #period-expressions18650
|
||||
Node: Depth limiting22607
|
||||
Ref: #depth-limiting22751
|
||||
Node: Pivoting23093
|
||||
Ref: #pivoting23216
|
||||
Node: Valuation24892
|
||||
Ref: #valuation25021
|
||||
Node: -B Cost25201
|
||||
Ref: #b-cost25312
|
||||
Node: -V Market value25510
|
||||
Ref: #v-market-value25684
|
||||
Node: -X Market value in specified commodity27116
|
||||
Ref: #x-market-value-in-specified-commodity27355
|
||||
Node: --value Flexible valuation27531
|
||||
Ref: #value-flexible-valuation27757
|
||||
Node: Effect of --value on reports31947
|
||||
Ref: #effect-of---value-on-reports32163
|
||||
Node: Combining -B -V -X --value37094
|
||||
Ref: #combining--b--v--x---value37277
|
||||
Node: Output destination37313
|
||||
Ref: #output-destination37465
|
||||
Node: Output format37748
|
||||
Ref: #output-format37900
|
||||
Node: Regular expressions38285
|
||||
Ref: #regular-expressions38422
|
||||
Node: QUERIES39783
|
||||
Ref: #queries39885
|
||||
Node: COMMANDS43847
|
||||
Ref: #commands43959
|
||||
Node: accounts45023
|
||||
Ref: #accounts45121
|
||||
Node: activity45820
|
||||
Ref: #activity45930
|
||||
Node: add46313
|
||||
Ref: #add46412
|
||||
Node: balance49157
|
||||
Ref: #balance49268
|
||||
Node: Classic balance report50710
|
||||
Ref: #classic-balance-report50883
|
||||
Node: Customising the classic balance report52252
|
||||
Ref: #customising-the-classic-balance-report52480
|
||||
Node: Colour support54556
|
||||
Ref: #colour-support54723
|
||||
Node: Flat mode54896
|
||||
Ref: #flat-mode55044
|
||||
Node: Depth limited balance reports55457
|
||||
Ref: #depth-limited-balance-reports55657
|
||||
Node: Multicolumn balance report56113
|
||||
Ref: #multicolumn-balance-report56311
|
||||
Node: Budget report61625
|
||||
Ref: #budget-report61768
|
||||
Node: Nested budgets66970
|
||||
Ref: #nested-budgets67082
|
||||
Ref: #output-format-170562
|
||||
Node: balancesheet70640
|
||||
Ref: #balancesheet70776
|
||||
Node: balancesheetequity72091
|
||||
Ref: #balancesheetequity72240
|
||||
Node: cashflow72801
|
||||
Ref: #cashflow72929
|
||||
Node: check-dates73957
|
||||
Ref: #check-dates74084
|
||||
Node: check-dupes74363
|
||||
Ref: #check-dupes74487
|
||||
Node: close74780
|
||||
Ref: #close74894
|
||||
Node: commodities78481
|
||||
Ref: #commodities78608
|
||||
Node: descriptions78690
|
||||
Ref: #descriptions78818
|
||||
Node: diff78999
|
||||
Ref: #diff79105
|
||||
Node: files80152
|
||||
Ref: #files80252
|
||||
Node: help80399
|
||||
Ref: #help80499
|
||||
Node: import81592
|
||||
Ref: #import81706
|
||||
Node: Importing balance assignments82494
|
||||
Ref: #importing-balance-assignments82642
|
||||
Node: incomestatement83291
|
||||
Ref: #incomestatement83424
|
||||
Node: notes84760
|
||||
Ref: #notes84873
|
||||
Node: payees84999
|
||||
Ref: #payees85105
|
||||
Node: prices85263
|
||||
Ref: #prices85369
|
||||
Node: print85648
|
||||
Ref: #print85758
|
||||
Node: print-unique90251
|
||||
Ref: #print-unique90377
|
||||
Node: register90662
|
||||
Ref: #register90789
|
||||
Node: Custom register output94961
|
||||
Ref: #custom-register-output95090
|
||||
Node: register-match96352
|
||||
Ref: #register-match96486
|
||||
Node: rewrite96837
|
||||
Ref: #rewrite96952
|
||||
Node: Re-write rules in a file98807
|
||||
Ref: #re-write-rules-in-a-file98941
|
||||
Node: Diff output format100151
|
||||
Ref: #diff-output-format100320
|
||||
Node: rewrite vs print --auto101412
|
||||
Ref: #rewrite-vs.-print---auto101591
|
||||
Node: roi102147
|
||||
Ref: #roi102245
|
||||
Node: stats103257
|
||||
Ref: #stats103356
|
||||
Node: tags104144
|
||||
Ref: #tags104242
|
||||
Node: test104536
|
||||
Ref: #test104620
|
||||
Node: ADD-ON COMMANDS105381
|
||||
Ref: #add-on-commands105491
|
||||
Node: Official add-ons106779
|
||||
Ref: #official-add-ons106919
|
||||
Node: api107007
|
||||
Ref: #api107096
|
||||
Node: ui107148
|
||||
Ref: #ui107247
|
||||
Node: web107305
|
||||
Ref: #web107394
|
||||
Node: Third party add-ons107440
|
||||
Ref: #third-party-add-ons107615
|
||||
Ref: #diff-1107774
|
||||
Node: iadd107873
|
||||
Ref: #iadd107983
|
||||
Node: interest108066
|
||||
Ref: #interest108187
|
||||
Node: irr108282
|
||||
Ref: #irr108380
|
||||
Node: Experimental add-ons108511
|
||||
Ref: #experimental-add-ons108663
|
||||
Node: autosync108911
|
||||
Ref: #autosync109022
|
||||
Node: chart109261
|
||||
Ref: #chart109380
|
||||
Node: check109451
|
||||
Ref: #check109553
|
||||
Node: EXAMPLES1891
|
||||
Ref: #examples1991
|
||||
Node: OPTIONS3637
|
||||
Ref: #options3739
|
||||
Node: General options4138
|
||||
Ref: #general-options4263
|
||||
Node: Command options6917
|
||||
Ref: #command-options7068
|
||||
Node: Command arguments7466
|
||||
Ref: #command-arguments7620
|
||||
Node: Argument files7741
|
||||
Ref: #argument-files7917
|
||||
Node: Special characters in arguments and queries8183
|
||||
Ref: #special-characters-in-arguments-and-queries8417
|
||||
Node: More escaping8868
|
||||
Ref: #more-escaping9030
|
||||
Node: Even more escaping9326
|
||||
Ref: #even-more-escaping9520
|
||||
Node: Less escaping10191
|
||||
Ref: #less-escaping10353
|
||||
Node: Command line tips10598
|
||||
Ref: #command-line-tips10784
|
||||
Node: Unicode characters11161
|
||||
Ref: #unicode-characters11317
|
||||
Node: Input files12729
|
||||
Ref: #input-files12865
|
||||
Node: Smart dates14794
|
||||
Ref: #smart-dates14935
|
||||
Node: Report start & end date16341
|
||||
Ref: #report-start-end-date16513
|
||||
Node: Report intervals17937
|
||||
Ref: #report-intervals18102
|
||||
Node: Period expressions18492
|
||||
Ref: #period-expressions18652
|
||||
Node: Depth limiting22609
|
||||
Ref: #depth-limiting22753
|
||||
Node: Pivoting23095
|
||||
Ref: #pivoting23218
|
||||
Node: Valuation24894
|
||||
Ref: #valuation25023
|
||||
Node: -B Cost25203
|
||||
Ref: #b-cost25314
|
||||
Node: -V Market value25512
|
||||
Ref: #v-market-value25686
|
||||
Node: -X Market value in specified commodity27118
|
||||
Ref: #x-market-value-in-specified-commodity27357
|
||||
Node: --value Flexible valuation27533
|
||||
Ref: #value-flexible-valuation27759
|
||||
Node: Effect of --value on reports31949
|
||||
Ref: #effect-of---value-on-reports32165
|
||||
Node: Combining -B -V -X --value37096
|
||||
Ref: #combining--b--v--x---value37279
|
||||
Node: Output destination37315
|
||||
Ref: #output-destination37467
|
||||
Node: Output format37750
|
||||
Ref: #output-format37902
|
||||
Node: Regular expressions38287
|
||||
Ref: #regular-expressions38424
|
||||
Node: QUERIES39785
|
||||
Ref: #queries39887
|
||||
Node: COMMANDS43849
|
||||
Ref: #commands43961
|
||||
Node: accounts45025
|
||||
Ref: #accounts45123
|
||||
Node: activity45822
|
||||
Ref: #activity45932
|
||||
Node: add46315
|
||||
Ref: #add46414
|
||||
Node: balance49159
|
||||
Ref: #balance49270
|
||||
Node: Classic balance report50712
|
||||
Ref: #classic-balance-report50885
|
||||
Node: Customising the classic balance report52254
|
||||
Ref: #customising-the-classic-balance-report52482
|
||||
Node: Colour support54558
|
||||
Ref: #colour-support54725
|
||||
Node: Flat mode54898
|
||||
Ref: #flat-mode55046
|
||||
Node: Depth limited balance reports55459
|
||||
Ref: #depth-limited-balance-reports55659
|
||||
Node: Multicolumn balance report56115
|
||||
Ref: #multicolumn-balance-report56313
|
||||
Node: Budget report61627
|
||||
Ref: #budget-report61770
|
||||
Node: Nested budgets66972
|
||||
Ref: #nested-budgets67084
|
||||
Ref: #output-format-170564
|
||||
Node: balancesheet70642
|
||||
Ref: #balancesheet70778
|
||||
Node: balancesheetequity72093
|
||||
Ref: #balancesheetequity72242
|
||||
Node: cashflow72803
|
||||
Ref: #cashflow72931
|
||||
Node: check-dates73959
|
||||
Ref: #check-dates74086
|
||||
Node: check-dupes74365
|
||||
Ref: #check-dupes74489
|
||||
Node: close74782
|
||||
Ref: #close74896
|
||||
Node: commodities78483
|
||||
Ref: #commodities78610
|
||||
Node: descriptions78692
|
||||
Ref: #descriptions78820
|
||||
Node: diff79001
|
||||
Ref: #diff79107
|
||||
Node: files80154
|
||||
Ref: #files80254
|
||||
Node: help80401
|
||||
Ref: #help80501
|
||||
Node: import81582
|
||||
Ref: #import81696
|
||||
Node: Importing balance assignments82589
|
||||
Ref: #importing-balance-assignments82737
|
||||
Node: incomestatement83386
|
||||
Ref: #incomestatement83519
|
||||
Node: notes84855
|
||||
Ref: #notes84968
|
||||
Node: payees85094
|
||||
Ref: #payees85200
|
||||
Node: prices85358
|
||||
Ref: #prices85464
|
||||
Node: print85743
|
||||
Ref: #print85853
|
||||
Node: print-unique90346
|
||||
Ref: #print-unique90472
|
||||
Node: register90757
|
||||
Ref: #register90884
|
||||
Node: Custom register output95056
|
||||
Ref: #custom-register-output95185
|
||||
Node: register-match96447
|
||||
Ref: #register-match96581
|
||||
Node: rewrite96932
|
||||
Ref: #rewrite97047
|
||||
Node: Re-write rules in a file98902
|
||||
Ref: #re-write-rules-in-a-file99036
|
||||
Node: Diff output format100246
|
||||
Ref: #diff-output-format100415
|
||||
Node: rewrite vs print --auto101507
|
||||
Ref: #rewrite-vs.-print---auto101686
|
||||
Node: roi102242
|
||||
Ref: #roi102340
|
||||
Node: stats103352
|
||||
Ref: #stats103451
|
||||
Node: tags104239
|
||||
Ref: #tags104337
|
||||
Node: test104631
|
||||
Ref: #test104715
|
||||
Node: ADD-ON COMMANDS105476
|
||||
Ref: #add-on-commands105586
|
||||
Node: Official add-ons106874
|
||||
Ref: #official-add-ons107014
|
||||
Node: ui107094
|
||||
Ref: #ui107181
|
||||
Node: web107235
|
||||
Ref: #web107324
|
||||
Node: Third party add-ons107370
|
||||
Ref: #third-party-add-ons107545
|
||||
Ref: #diff-1107704
|
||||
Node: iadd107803
|
||||
Ref: #iadd107913
|
||||
Node: interest107995
|
||||
Ref: #interest108116
|
||||
Node: irr108211
|
||||
Ref: #irr108309
|
||||
Node: Experimental add-ons108440
|
||||
Ref: #experimental-add-ons108592
|
||||
Node: autosync108840
|
||||
Ref: #autosync108951
|
||||
Node: chart109190
|
||||
Ref: #chart109309
|
||||
Node: check109380
|
||||
Ref: #check109482
|
||||
|
||||
End Tag Table
|
||||
|
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user