;doc: update manuals
This commit is contained in:
Simon Michael
parent
cf607adfcf
commit
36a20b7dfd
@ -5,9 +5,7 @@
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
hledger-ui is a terminal interface (TUI) for the hledger accounting
|
||||
tool.
|
||||
This manual is for hledger-ui 1.28.99.
|
||||
hledger-ui - robust, friendly plain text accounting (TUI version)
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[V]hledger-ui [OPTIONS] [QUERYARGS]\f[R]
|
||||
@ -17,6 +15,9 @@ This manual is for hledger-ui 1.28.99.
|
||||
\f[V]hledger ui -- [OPTIONS] [QUERYARGS]\f[R]
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This manual is for hledger\[aq]s terminal interface, version 1.28.99.
|
||||
See also the hledger manual for common concepts and file formats.
|
||||
.PP
|
||||
hledger is a reliable, cross-platform set of programs for tracking
|
||||
money, time, or any other commodity, using double-entry accounting and a
|
||||
simple, editable file format.
|
||||
@ -323,8 +324,8 @@ current transaction when invoked from the register and transaction
|
||||
screens, and at the error location (if possible) when invoked from the
|
||||
error screen.
|
||||
.PP
|
||||
\f[V]B\f[R] toggles cost mode, showing amounts in their transaction
|
||||
price\[aq]s commodity (like toggling the \f[V]-B/--cost\f[R] flag).
|
||||
\f[V]B\f[R] toggles cost mode, showing amounts in their cost\[aq]s
|
||||
commodity (like toggling the \f[V]-B/--cost\f[R] flag).
|
||||
.PP
|
||||
\f[V]V\f[R] toggles value mode, showing amounts\[aq] current market
|
||||
value in their default valuation commodity (like toggling the
|
||||
@ -623,9 +624,6 @@ timedot, or CSV format specified with \f[V]-f\f[R], or
|
||||
perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]).
|
||||
.SH BUGS
|
||||
.PP
|
||||
The need to precede options with \f[V]--\f[R] when invoked from hledger
|
||||
is awkward.
|
||||
.PP
|
||||
\f[V]-f-\f[R] doesn\[aq]t work (hledger-ui can\[aq]t read from stdin).
|
||||
.PP
|
||||
\f[V]-V\f[R] affects only the accounts screen.
|
||||
@ -650,15 +648,17 @@ step.
|
||||
|
||||
.SH "REPORTING BUGS"
|
||||
Report bugs at http://bugs.hledger.org
|
||||
(or on the #hledger IRC channel or hledger mail list)
|
||||
(or on the #hledger chat or hledger mail list)
|
||||
|
||||
.SH AUTHORS
|
||||
Simon Michael <simon@joyful.com> and contributors
|
||||
Simon Michael <simon@joyful.com> and contributors.
|
||||
.br
|
||||
See http://hledger.org/CREDITS.html
|
||||
|
||||
.SH COPYRIGHT
|
||||
Copyright 2007-2023 Simon Michael and contributors.
|
||||
|
||||
Copyright (C) 2007-2020 Simon Michael.
|
||||
.br
|
||||
.SH LICENSE
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
@ -11,12 +11,14 @@ File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir)
|
||||
hledger-ui(1)
|
||||
*************
|
||||
|
||||
hledger-ui is a terminal interface (TUI) for the hledger accounting
|
||||
tool. This manual is for hledger-ui 1.28.99.
|
||||
hledger-ui - robust, friendly plain text accounting (TUI version)
|
||||
|
||||
'hledger-ui [OPTIONS] [QUERYARGS]'
|
||||
'hledger ui -- [OPTIONS] [QUERYARGS]'
|
||||
|
||||
This manual is for hledger's terminal interface, version 1.28.99.
|
||||
See also the hledger manual for common concepts and file formats.
|
||||
|
||||
hledger is a reliable, cross-platform set of programs for tracking
|
||||
money, time, or any other commodity, using double-entry accounting and a
|
||||
simple, editable file format. hledger is inspired by and largely
|
||||
@ -336,8 +338,8 @@ cursor will be positioned at the current transaction when invoked from
|
||||
the register and transaction screens, and at the error location (if
|
||||
possible) when invoked from the error screen.
|
||||
|
||||
'B' toggles cost mode, showing amounts in their transaction price's
|
||||
commodity (like toggling the '-B/--cost' flag).
|
||||
'B' toggles cost mode, showing amounts in their cost's commodity
|
||||
(like toggling the '-B/--cost' flag).
|
||||
|
||||
'V' toggles value mode, showing amounts' current market value in
|
||||
their default valuation commodity (like toggling the '-V/--market'
|
||||
@ -673,10 +675,7 @@ File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top
|
||||
8 BUGS
|
||||
******
|
||||
|
||||
The need to precede options with '--' when invoked from hledger is
|
||||
awkward.
|
||||
|
||||
'-f-' doesn't work (hledger-ui can't read from stdin).
|
||||
'-f-' doesn't work (hledger-ui can't read from stdin).
|
||||
|
||||
'-V' affects only the accounts screen.
|
||||
|
||||
@ -698,40 +697,40 @@ program is restarted.
|
||||
|
||||
Tag Table:
|
||||
Node: Top221
|
||||
Node: OPTIONS1657
|
||||
Ref: #options1755
|
||||
Node: MOUSE6839
|
||||
Ref: #mouse6934
|
||||
Node: KEYS7171
|
||||
Ref: #keys7264
|
||||
Node: SCREENS11339
|
||||
Ref: #screens11437
|
||||
Node: Menu12123
|
||||
Ref: #menu12215
|
||||
Node: All accounts12292
|
||||
Ref: #all-accounts12431
|
||||
Node: Balance sheet accounts12682
|
||||
Ref: #balance-sheet-accounts12862
|
||||
Node: Income statement accounts13050
|
||||
Ref: #income-statement-accounts13232
|
||||
Node: Register15652
|
||||
Ref: #register15789
|
||||
Node: Transaction17773
|
||||
Ref: #transaction17896
|
||||
Node: Error18766
|
||||
Ref: #error18860
|
||||
Node: TIPS19104
|
||||
Ref: #tips19203
|
||||
Node: Watch mode19245
|
||||
Ref: #watch-mode19352
|
||||
Node: Debug output20808
|
||||
Ref: #debug-output20919
|
||||
Node: ENVIRONMENT21131
|
||||
Ref: #environment21242
|
||||
Node: FILES22627
|
||||
Ref: #files22726
|
||||
Node: BUGS22939
|
||||
Ref: #bugs23016
|
||||
Node: OPTIONS1745
|
||||
Ref: #options1843
|
||||
Node: MOUSE6927
|
||||
Ref: #mouse7022
|
||||
Node: KEYS7259
|
||||
Ref: #keys7352
|
||||
Node: SCREENS11414
|
||||
Ref: #screens11512
|
||||
Node: Menu12198
|
||||
Ref: #menu12290
|
||||
Node: All accounts12367
|
||||
Ref: #all-accounts12506
|
||||
Node: Balance sheet accounts12757
|
||||
Ref: #balance-sheet-accounts12937
|
||||
Node: Income statement accounts13125
|
||||
Ref: #income-statement-accounts13307
|
||||
Node: Register15727
|
||||
Ref: #register15864
|
||||
Node: Transaction17848
|
||||
Ref: #transaction17971
|
||||
Node: Error18841
|
||||
Ref: #error18935
|
||||
Node: TIPS19179
|
||||
Ref: #tips19278
|
||||
Node: Watch mode19320
|
||||
Ref: #watch-mode19427
|
||||
Node: Debug output20883
|
||||
Ref: #debug-output20994
|
||||
Node: ENVIRONMENT21206
|
||||
Ref: #environment21317
|
||||
Node: FILES22702
|
||||
Ref: #files22801
|
||||
Node: BUGS23014
|
||||
Ref: #bugs23091
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
||||
@ -4,14 +4,16 @@ HLEDGER-UI(1) hledger User Manuals HLEDGER-UI(1)
|
||||
|
||||
|
||||
NAME
|
||||
hledger-ui is a terminal interface (TUI) for the hledger accounting
|
||||
tool. This manual is for hledger-ui 1.28.99.
|
||||
hledger-ui - robust, friendly plain text accounting (TUI version)
|
||||
|
||||
SYNOPSIS
|
||||
hledger-ui [OPTIONS] [QUERYARGS]
|
||||
hledger ui -- [OPTIONS] [QUERYARGS]
|
||||
|
||||
DESCRIPTION
|
||||
This manual is for hledger's terminal interface, version 1.28.99. See
|
||||
also the hledger manual for common concepts and file formats.
|
||||
|
||||
hledger is a reliable, cross-platform set of programs for tracking
|
||||
money, time, or any other commodity, using double-entry accounting and
|
||||
a simple, editable file format. hledger is inspired by and largely
|
||||
@ -295,8 +297,8 @@ KEYS
|
||||
register and transaction screens, and at the error location (if possi-
|
||||
ble) when invoked from the error screen.
|
||||
|
||||
B toggles cost mode, showing amounts in their transaction price's com-
|
||||
modity (like toggling the -B/--cost flag).
|
||||
B toggles cost mode, showing amounts in their cost's commodity (like
|
||||
toggling the -B/--cost flag).
|
||||
|
||||
V toggles value mode, showing amounts' current market value in their
|
||||
default valuation commodity (like toggling the -V/--market flag).
|
||||
@ -543,21 +545,18 @@ FILES
|
||||
C:/Users/USER/.hledger.journal).
|
||||
|
||||
BUGS
|
||||
The need to precede options with -- when invoked from hledger is awk-
|
||||
ward.
|
||||
|
||||
-f- doesn't work (hledger-ui can't read from stdin).
|
||||
|
||||
-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.
|
||||
@ -568,16 +567,20 @@ BUGS
|
||||
|
||||
|
||||
REPORTING BUGS
|
||||
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
|
||||
or hledger mail list)
|
||||
Report bugs at http://bugs.hledger.org (or on the #hledger chat or
|
||||
hledger mail list)
|
||||
|
||||
|
||||
AUTHORS
|
||||
Simon Michael <simon@joyful.com> and contributors
|
||||
Simon Michael <simon@joyful.com> and contributors.
|
||||
See http://hledger.org/CREDITS.html
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
Copyright (C) 2007-2020 Simon Michael.
|
||||
Copyright 2007-2023 Simon Michael and contributors.
|
||||
|
||||
|
||||
LICENSE
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
||||
|
||||
@ -5,24 +5,27 @@
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
hledger-web is a web interface (WUI) for the hledger accounting tool.
|
||||
This manual is for hledger-web 1.28.99.
|
||||
hledger-web - robust, friendly plain text accounting (Web version)
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[V]hledger-web [OPTIONS] # run temporarily & browse\f[R]
|
||||
\f[V]hledger-web [OPTIONS] # run temporarily & browse\f[R]
|
||||
.PD 0
|
||||
.P
|
||||
.PD
|
||||
\f[V]hledger-web --serve [OPTIONS] # run without stopping\f[R]
|
||||
\f[V]hledger-web --serve [OPTIONS] # run without stopping\f[R]
|
||||
.PD 0
|
||||
.P
|
||||
.PD
|
||||
\f[V]hledger-web --serve-api [OPTIONS] # run JSON server only\f[R]
|
||||
\f[V]hledger-web --serve-api [OPTIONS] # run JSON server only\f[R]
|
||||
.PD 0
|
||||
.P
|
||||
.PD
|
||||
\f[V]hledger web -- [OPTIONS] [QUERYARGS]\f[R] # start from hledger
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This manual is for hledger\[aq]s web interface, version 1.28.99.
|
||||
See also the hledger manual for common concepts and file formats.
|
||||
.PP
|
||||
hledger is a reliable, cross-platform set of programs for tracking
|
||||
money, time, or any other commodity, using double-entry accounting and a
|
||||
simple, editable file format.
|
||||
@ -457,7 +460,7 @@ $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool
|
||||
Most of the JSON corresponds to hledger\[aq]s data types; for details of
|
||||
what the fields mean, see the Hledger.Data.Json haddock docs and click
|
||||
on the various data types, eg Transaction.
|
||||
And for a higher level understanding, see the journal manual.
|
||||
And for a higher level understanding, see the journal docs.
|
||||
.PP
|
||||
In some cases there is outer JSON corresponding to a \[dq]Report\[dq]
|
||||
type.
|
||||
@ -664,9 +667,6 @@ timedot, or CSV format specified with \f[V]-f\f[R], or
|
||||
perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]).
|
||||
.SH BUGS
|
||||
.PP
|
||||
The need to precede options with \f[V]--\f[R] when invoked from hledger
|
||||
is awkward.
|
||||
.PP
|
||||
\f[V]-f-\f[R] doesn\[aq]t work (hledger-web can\[aq]t read from stdin).
|
||||
.PP
|
||||
Query arguments and some hledger options are ignored.
|
||||
@ -678,15 +678,17 @@ Does not work well on small screens.
|
||||
|
||||
.SH "REPORTING BUGS"
|
||||
Report bugs at http://bugs.hledger.org
|
||||
(or on the #hledger IRC channel or hledger mail list)
|
||||
(or on the #hledger chat or hledger mail list)
|
||||
|
||||
.SH AUTHORS
|
||||
Simon Michael <simon@joyful.com> and contributors
|
||||
Simon Michael <simon@joyful.com> and contributors.
|
||||
.br
|
||||
See http://hledger.org/CREDITS.html
|
||||
|
||||
.SH COPYRIGHT
|
||||
Copyright 2007-2023 Simon Michael and contributors.
|
||||
|
||||
Copyright (C) 2007-2020 Simon Michael.
|
||||
.br
|
||||
.SH LICENSE
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
.SH SEE ALSO
|
||||
|
||||
@ -11,12 +11,15 @@ File: hledger-web.info, Node: Top, Next: OPTIONS, Up: (dir)
|
||||
hledger-web(1)
|
||||
**************
|
||||
|
||||
hledger-web is a web interface (WUI) for the hledger accounting tool.
|
||||
This manual is for hledger-web 1.28.99.
|
||||
hledger-web - robust, friendly plain text accounting (Web version)
|
||||
|
||||
'hledger-web [OPTIONS] # run temporarily & browse'
|
||||
'hledger-web --serve [OPTIONS] # run without stopping'
|
||||
'hledger-web --serve-api [OPTIONS] # run JSON server only'
|
||||
'hledger web -- [OPTIONS] [QUERYARGS]' # start from hledger
|
||||
|
||||
This manual is for hledger's web interface, version 1.28.99. See
|
||||
also the hledger manual for common concepts and file formats.
|
||||
|
||||
hledger is a reliable, cross-platform set of programs for tracking
|
||||
money, time, or any other commodity, using double-entry accounting and a
|
||||
@ -450,7 +453,7 @@ $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool
|
||||
Most of the JSON corresponds to hledger's data types; for details of
|
||||
what the fields mean, see the Hledger.Data.Json haddock docs and click
|
||||
on the various data types, eg Transaction. And for a higher level
|
||||
understanding, see the journal manual.
|
||||
understanding, see the journal docs.
|
||||
|
||||
In some cases there is outer JSON corresponding to a "Report" type.
|
||||
To understand that, go to the Hledger.Web.Handler.MiscR haddock and look
|
||||
@ -648,10 +651,7 @@ File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top
|
||||
9 BUGS
|
||||
******
|
||||
|
||||
The need to precede options with '--' when invoked from hledger is
|
||||
awkward.
|
||||
|
||||
'-f-' doesn't work (hledger-web can't read from stdin).
|
||||
'-f-' doesn't work (hledger-web can't read from stdin).
|
||||
|
||||
Query arguments and some hledger options are ignored.
|
||||
|
||||
@ -662,26 +662,26 @@ awkward.
|
||||
|
||||
Tag Table:
|
||||
Node: Top223
|
||||
Node: OPTIONS2436
|
||||
Ref: #options2541
|
||||
Node: PERMISSIONS9940
|
||||
Ref: #permissions10079
|
||||
Node: EDITING UPLOADING DOWNLOADING11291
|
||||
Ref: #editing-uploading-downloading11472
|
||||
Node: RELOADING12306
|
||||
Ref: #reloading12440
|
||||
Node: JSON API12873
|
||||
Ref: #json-api12988
|
||||
Node: DEBUG OUTPUT18478
|
||||
Ref: #debug-output18603
|
||||
Node: Debug output18630
|
||||
Ref: #debug-output-118731
|
||||
Node: ENVIRONMENT19148
|
||||
Ref: #environment19268
|
||||
Node: FILES20579
|
||||
Ref: #files20679
|
||||
Node: BUGS20892
|
||||
Ref: #bugs20970
|
||||
Node: OPTIONS2585
|
||||
Ref: #options2690
|
||||
Node: PERMISSIONS10089
|
||||
Ref: #permissions10228
|
||||
Node: EDITING UPLOADING DOWNLOADING11440
|
||||
Ref: #editing-uploading-downloading11621
|
||||
Node: RELOADING12455
|
||||
Ref: #reloading12589
|
||||
Node: JSON API13022
|
||||
Ref: #json-api13137
|
||||
Node: DEBUG OUTPUT18625
|
||||
Ref: #debug-output18750
|
||||
Node: Debug output18777
|
||||
Ref: #debug-output-118878
|
||||
Node: ENVIRONMENT19295
|
||||
Ref: #environment19415
|
||||
Node: FILES20726
|
||||
Ref: #files20826
|
||||
Node: BUGS21039
|
||||
Ref: #bugs21117
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
||||
@ -4,15 +4,18 @@ HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1)
|
||||
|
||||
|
||||
NAME
|
||||
hledger-web is a web interface (WUI) for the hledger accounting tool.
|
||||
This manual is for hledger-web 1.28.99.
|
||||
hledger-web - robust, friendly plain text accounting (Web version)
|
||||
|
||||
SYNOPSIS
|
||||
hledger-web [OPTIONS] # run temporarily & browse
|
||||
hledger-web --serve [OPTIONS] # run without stopping
|
||||
hledger-web --serve-api [OPTIONS] # run JSON server only
|
||||
hledger-web [OPTIONS] # run temporarily & browse
|
||||
hledger-web --serve [OPTIONS] # run without stopping
|
||||
hledger-web --serve-api [OPTIONS] # run JSON server only
|
||||
hledger web -- [OPTIONS] [QUERYARGS] # start from hledger
|
||||
|
||||
DESCRIPTION
|
||||
This manual is for hledger's web interface, version 1.28.99. See also
|
||||
the hledger manual for common concepts and file formats.
|
||||
|
||||
hledger is a reliable, cross-platform set of programs for tracking
|
||||
money, time, or any other commodity, using double-entry accounting and
|
||||
a simple, editable file format. hledger is inspired by and largely
|
||||
@ -401,7 +404,7 @@ JSON API
|
||||
Most of the JSON corresponds to hledger's data types; for details of
|
||||
what the fields mean, see the Hledger.Data.Json haddock docs and click
|
||||
on the various data types, eg Transaction. And for a higher level
|
||||
understanding, see the journal manual.
|
||||
understanding, see the journal docs.
|
||||
|
||||
In some cases there is outer JSON corresponding to a "Report" type. To
|
||||
understand that, go to the Hledger.Web.Handler.MiscR haddock and look
|
||||
@ -570,9 +573,6 @@ FILES
|
||||
C:/Users/USER/.hledger.journal).
|
||||
|
||||
BUGS
|
||||
The need to precede options with -- when invoked from hledger is awk-
|
||||
ward.
|
||||
|
||||
-f- doesn't work (hledger-web can't read from stdin).
|
||||
|
||||
Query arguments and some hledger options are ignored.
|
||||
@ -584,16 +584,20 @@ BUGS
|
||||
|
||||
|
||||
REPORTING BUGS
|
||||
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
|
||||
or hledger mail list)
|
||||
Report bugs at http://bugs.hledger.org (or on the #hledger chat or
|
||||
hledger mail list)
|
||||
|
||||
|
||||
AUTHORS
|
||||
Simon Michael <simon@joyful.com> and contributors
|
||||
Simon Michael <simon@joyful.com> and contributors.
|
||||
See http://hledger.org/CREDITS.html
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
Copyright (C) 2007-2020 Simon Michael.
|
||||
Copyright 2007-2023 Simon Michael and contributors.
|
||||
|
||||
|
||||
LICENSE
|
||||
Released under GNU GPL v3 or later.
|
||||
|
||||
|
||||
|
||||
10452
hledger/hledger.1
10452
hledger/hledger.1
File diff suppressed because it is too large
Load Diff
12733
hledger/hledger.info
12733
hledger/hledger.info
File diff suppressed because it is too large
Load Diff
8762
hledger/hledger.txt
8762
hledger/hledger.txt
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user