;doc: update manuals
This commit is contained in:
parent
b17f6730d8
commit
944e27b342
@ -1000,6 +1000,12 @@ disabled automatically.
|
|||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
HTML output can be styled by an optional \f[CR]hledger.css\f[R] file in
|
HTML output can be styled by an optional \f[CR]hledger.css\f[R] file in
|
||||||
the same directory.
|
the same directory.
|
||||||
|
.IP \[bu] 2
|
||||||
|
HTML output will be UTF\-8 encoded.
|
||||||
|
If your web browser is showing junk characters, you may need to change
|
||||||
|
its text encoding to UTF\-8.
|
||||||
|
Eg in Safari, see View \-> Text Encoding and Settings \-> Advanced \->
|
||||||
|
Default Encoding.
|
||||||
.SS JSON output
|
.SS JSON output
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
This is not yet much used; real\-world feedback is welcome.
|
This is not yet much used; real\-world feedback is welcome.
|
||||||
@ -9948,17 +9954,6 @@ each commodity:
|
|||||||
$ hledger bal \-% cur:\[rs]\[rs]$
|
$ hledger bal \-% cur:\[rs]\[rs]$
|
||||||
$ hledger bal \-% cur:€
|
$ hledger bal \-% cur:€
|
||||||
.EE
|
.EE
|
||||||
.SS Hyperlinks
|
|
||||||
The HTML and FODS output formats can generate hyperlinks to a
|
|
||||||
\f[CR]hledger\-web\f[R] register view for each account and period.
|
|
||||||
E.g.
|
|
||||||
if your \f[CR]hledger\-web\f[R] server is reachable at
|
|
||||||
\f[CR]http://localhost:5000\f[R] then you might run the
|
|
||||||
\f[CR]balance\f[R] command with the extra option
|
|
||||||
\f[CR]\-\-base\-url=http://localhost:5000\f[R].
|
|
||||||
You can also produce relative links, like
|
|
||||||
\f[CR]\-\-base\-url=\[dq]some/path\[dq]\f[R] or
|
|
||||||
\f[CR]\-\-base\-url=\[dq]\[dq]\f[R].)
|
|
||||||
.SS Multi\-period balance report
|
.SS Multi\-period balance report
|
||||||
With a report interval (set by the \f[CR]\-D/\-\-daily\f[R],
|
With a report interval (set by the \f[CR]\-D/\-\-daily\f[R],
|
||||||
\f[CR]\-W/\-\-weekly\f[R], \f[CR]\-M/\-\-monthly\f[R],
|
\f[CR]\-W/\-\-weekly\f[R], \f[CR]\-M/\-\-monthly\f[R],
|
||||||
@ -10646,6 +10641,27 @@ $ hledger \-f examples/bcexample.hledger bal assets:us:etrade \-3 \-Y \-O csv \-
|
|||||||
\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014\-01\-01\[dq],\[dq]2014\-12\-31\[dq],\[dq]VEA\[dq],\[dq]14.00\[dq]
|
\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014\-01\-01\[dq],\[dq]2014\-12\-31\[dq],\[dq]VEA\[dq],\[dq]14.00\[dq]
|
||||||
\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014\-01\-01\[dq],\[dq]2014\-12\-31\[dq],\[dq]VHT\[dq],\[dq]170.00\[dq]
|
\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014\-01\-01\[dq],\[dq]2014\-12\-31\[dq],\[dq]VHT\[dq],\[dq]170.00\[dq]
|
||||||
.EE
|
.EE
|
||||||
|
.SS Balance report output
|
||||||
|
As noted in Output format, if you choose HTML output (by using
|
||||||
|
\f[CR]\-O html\f[R] or \f[CR]\-o somefile.html\f[R]), it will use the
|
||||||
|
UTF\-8 text encoding, And you can create a \f[CR]hledger.css\f[R] file
|
||||||
|
in the same directory to customise the report\[aq]s appearance.
|
||||||
|
.PP
|
||||||
|
The HTML and FODS output formats can generate hyperlinks to a
|
||||||
|
\f[CR]hledger\-web\f[R] register view for each account and period.
|
||||||
|
E.g.
|
||||||
|
if your \f[CR]hledger\-web\f[R] server is reachable at
|
||||||
|
\f[CR]http://localhost:5000\f[R] then you might run the
|
||||||
|
\f[CR]balance\f[R] command with the extra option
|
||||||
|
\f[CR]\-\-base\-url=http://localhost:5000\f[R].
|
||||||
|
You can also produce relative links, like
|
||||||
|
\f[CR]\-\-base\-url=\[dq]some/path\[dq]\f[R] or
|
||||||
|
\f[CR]\-\-base\-url=\[dq]\[dq]\f[R].)
|
||||||
|
.PP
|
||||||
|
The balance reports\[aq] HTML output currently does not display tree
|
||||||
|
mode reports properly (#1846).
|
||||||
|
For now, if generating HTML you should probabBly use the default
|
||||||
|
\f[CR]\-\-flat\f[R] mode.
|
||||||
.SS Some useful balance reports
|
.SS Some useful balance reports
|
||||||
Some frequently used \f[CR]balance\f[R] options/reports are:
|
Some frequently used \f[CR]balance\f[R] options/reports are:
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
|
|||||||
1356
hledger/hledger.info
1356
hledger/hledger.info
File diff suppressed because it is too large
Load Diff
@ -699,6 +699,11 @@ Output
|
|||||||
o HTML output can be styled by an optional hledger.css file in the same
|
o HTML output can be styled by an optional hledger.css file in the same
|
||||||
directory.
|
directory.
|
||||||
|
|
||||||
|
o HTML output will be UTF-8 encoded. If your web browser is showing
|
||||||
|
junk characters, you may need to change its text encoding to UTF-8.
|
||||||
|
Eg in Safari, see View -> Text Encoding and Settings -> Advanced ->
|
||||||
|
Default Encoding.
|
||||||
|
|
||||||
JSON output
|
JSON output
|
||||||
o This is not yet much used; real-world feedback is welcome.
|
o This is not yet much used; real-world feedback is welcome.
|
||||||
|
|
||||||
@ -7931,14 +7936,6 @@ Advanced report commands
|
|||||||
$ hledger bal -% cur:\\$
|
$ hledger bal -% cur:\\$
|
||||||
$ hledger bal -% cur:
|
$ hledger bal -% cur:
|
||||||
|
|
||||||
Hyperlinks
|
|
||||||
The HTML and FODS output formats can generate hyperlinks to a
|
|
||||||
hledger-web register view for each account and period. E.g. if your
|
|
||||||
hledger-web server is reachable at http://localhost:5000 then you might
|
|
||||||
run the balance command with the extra option --base-url=http://local-
|
|
||||||
host:5000. You can also produce relative links, like
|
|
||||||
--base-url="some/path" or --base-url="".)
|
|
||||||
|
|
||||||
Multi-period balance report
|
Multi-period balance report
|
||||||
With a report interval (set by the -D/--daily, -W/--weekly,
|
With a report interval (set by the -D/--daily, -W/--weekly,
|
||||||
-M/--monthly, -Q/--quarterly, -Y/--yearly, or -p/--period flag), bal-
|
-M/--monthly, -Q/--quarterly, -Y/--yearly, or -p/--period flag), bal-
|
||||||
@ -8478,6 +8475,23 @@ Advanced report commands
|
|||||||
"Assets:US:ETrade","2014","2014-01-01","2014-12-31","VEA","14.00"
|
"Assets:US:ETrade","2014","2014-01-01","2014-12-31","VEA","14.00"
|
||||||
"Assets:US:ETrade","2014","2014-01-01","2014-12-31","VHT","170.00"
|
"Assets:US:ETrade","2014","2014-01-01","2014-12-31","VHT","170.00"
|
||||||
|
|
||||||
|
Balance report output
|
||||||
|
As noted in Output format, if you choose HTML output (by using -O html
|
||||||
|
or -o somefile.html), it will use the UTF-8 text encoding, And you can
|
||||||
|
create a hledger.css file in the same directory to customise the re-
|
||||||
|
port's appearance.
|
||||||
|
|
||||||
|
The HTML and FODS output formats can generate hyperlinks to a
|
||||||
|
hledger-web register view for each account and period. E.g. if your
|
||||||
|
hledger-web server is reachable at http://localhost:5000 then you might
|
||||||
|
run the balance command with the extra option --base-url=http://local-
|
||||||
|
host:5000. You can also produce relative links, like
|
||||||
|
--base-url="some/path" or --base-url="".)
|
||||||
|
|
||||||
|
The balance reports' HTML output currently does not display tree mode
|
||||||
|
reports properly (#1846). For now, if generating HTML you should prob-
|
||||||
|
abBly use the default --flat mode.
|
||||||
|
|
||||||
Some useful balance reports
|
Some useful balance reports
|
||||||
Some frequently used balance options/reports are:
|
Some frequently used balance options/reports are:
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user