slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: more macros, less redundancy, cleanups

Browse Source
This commit is contained in:
Simon Michael 2016-06-09 18:07:08 -07:00
parent 499f249157
commit e6769b26fc
17 changed files with 596 additions and 612 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/lib.m4
View File

@ -142,3 +142,19 @@ m4_define({{_reportingoptions_}}, {{
: The TAG will only match if it is a full-length match. The pivot will only happen if the TAG is on a posting, not if it is on the transaction. If the tag value is a multi:level:account:name the new account name will be "TAG:multi:level:account:name". : The TAG will only match if it is a full-length match. The pivot will only happen if the TAG is on a posting, not if it is on the transaction. If the tag value is a multi:level:account:name the new account name will be "TAG:multi:level:account:name".
}} )m4_dnl }} )m4_dnl
m4_dnl
m4_define({{_hledgerdescription_}}, {{
hledger is a cross-platform program for tracking money, time, or any other commodity,
using double-entry accounting and a simple, editable file format.
hledger is inspired by and largely compatible with ledger(1). }} )m4_dnl
m4_dnl
m4_define({{_files_}},
{{data from one or more files in hledger journal, timeclock, timedot, or CSV format
specified with `-f`, or `$LEDGER_FILE`,
or `$HOME/.hledger.journal` (on windows, perhaps `C:/Users/USER/.hledger.journal`).}})m4_dnl
m4_dnl
m4_define({{_LEDGER_FILE_}}, {{
**LEDGER_FILE**
The journal file path when not specified with `-f`.
Default: `~/.hledger.journal` (on windows, perhaps `C:/Users/USER/.hledger.journal`).
}} )m4_dnl

22
hledger-api/doc/hledger-api.1
View File

@ -29,10 +29,11 @@ client\-side web apps operating on hledger data.
It comes with a series of simple client\-side app examples, which drive It comes with a series of simple client\-side app examples, which drive
it\[aq]s evolution. it\[aq]s evolution.
.PP .PP
Data is served from the usual hledger journal file: Like hledger, it reads data from one or more files in hledger journal,
\f[C]~/.hledger.journal\f[], \f[C]$LEDGER_FILE\f[], or another file timeclock, timedot, or CSV format specified with \f[C]\-f\f[], or
specified with \-f. \f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
For more about the format, see hledger(1) or hledger_journal(5). perhaps \f[C]C:/Users/USER/.hledger.journal\f[]).
For more about this see hledger(1), hledger_journal(5) etc.
.PP .PP
The server listens on port 8001, or another specified with The server listens on port 8001, or another specified with
\f[C]\-p\ PORT\f[]. \f[C]\-p\ PORT\f[].
@ -117,13 +118,16 @@ ignore any failing balance assertions in the journal
.RE .RE
.SH ENVIRONMENT .SH ENVIRONMENT
.PP .PP
\f[B]LEDGER_FILE\f[] sets the default journal file path. \f[B]LEDGER_FILE\f[] The journal file path when not specified with
If not set, it is \f[C]~/.hledger.journal\f[]. \f[C]\-f\f[].
Default: \f[C]~/.hledger.journal\f[] (on windows, perhaps
\f[C]C:/Users/USER/.hledger.journal\f[]).
.SH FILES .SH FILES
.PP .PP
Reads data from a hledger journal file (\f[C]$LEDGER_FILE\f[] or Reads data from one or more files in hledger journal, timeclock,
\f[C]~/.hledger.journal\f[] by default), or a CSV file plus associated timedot, or CSV format specified with \f[C]\-f\f[], or
CSV rules file. \f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[]).
.SH BUGS .SH BUGS
.PP .PP
The need to precede options with \f[C]\-\-\f[] when invoked from hledger The need to precede options with \f[C]\-\-\f[] when invoked from hledger

12
hledger-api/doc/hledger-api.1.info
View File

@ -11,9 +11,11 @@ hledger-api is a simple web API server, intended to support client-side
web apps operating on hledger data. It comes with a series of simple web apps operating on hledger data. It comes with a series of simple
client-side app examples, which drive it's evolution. client-side app examples, which drive it's evolution.
Data is served from the usual hledger journal file: Like hledger, it reads data from one or more files in hledger
`~/.hledger.journal', `$LEDGER_FILE', or another file specified with journal, timeclock, timedot, or CSV format specified with `-f', or
-f. For more about the format, see hledger(1) or hledger_journal(5). `$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal'). For more about this see hledger(1),
hledger_journal(5) etc.
The server listens on port 8001, or another specified with `-p The server listens on port 8001, or another specified with `-p
PORT'. Note there is no built-in access control, so you will need to PORT'. Note there is no built-in access control, so you will need to
@ -82,7 +84,7 @@ before options as shown above.
 
Tag Table: Tag Table:
Node: Top90 Node: Top90
Node: OPTIONS959 Node: OPTIONS1058
Ref: #options1046 Ref: #options1145
 
End Tag Table End Tag Table

34
hledger-api/doc/hledger-api.1.m4.md
View File

@ -10,8 +10,8 @@ version:
</div> </div>
_toc_ _toc_
}}) }})
_man_({{
_man_({{
# NAME # NAME
hledger-api - web API server for the hledger accounting tool hledger-api - web API server for the hledger accounting tool
@ -24,19 +24,15 @@ hledger-api - web API server for the hledger accounting tool
# DESCRIPTION # DESCRIPTION
hledger is a cross-platform program for tracking money, time, or any other commodity, _hledgerdescription_
using double-entry accounting and a simple, editable file format.
hledger is inspired by and largely compatible with ledger(1).
}}) }})
hledger-api is a simple web API server, intended to support hledger-api is a simple web API server, intended to support
client-side web apps operating on hledger data. It comes with a series client-side web apps operating on hledger data. It comes with a series
of simple client-side app examples, which drive it's evolution. of simple client-side app examples, which drive it's evolution.
Data is served from the usual hledger journal file: Like hledger, it reads _files_
`~/.hledger.journal`, `$LEDGER_FILE`, or another file specified with -f. For more about this see hledger(1), hledger_journal(5) etc.
For more about the format, see hledger(1) or hledger_journal(5).
The server listens on port 8001, or another specified with `-p PORT`. The server listens on port 8001, or another specified with `-p PORT`.
Note there is no built-in access control, so you will need to hide Note there is no built-in access control, so you will need to hide
@ -67,32 +63,14 @@ _man_({{
# ENVIRONMENT # ENVIRONMENT
**LEDGER_FILE** _LEDGER_FILE_
sets the default journal file path. If not set, it is `~/.hledger.journal`.
# FILES # FILES
Reads data from a hledger journal file (`$LEDGER_FILE` or Reads _files_
`~/.hledger.journal` by default), or a CSV file plus associated CSV
rules file.
# BUGS # BUGS
The need to precede options with `--` when invoked from hledger is awkward. The need to precede options with `--` when invoked from hledger is awkward.
<!-- `-f-` doesn't work (hledger-web can't read from stdin). -->
<!-- Query arguments and some applicable hledger options probably aren't supported. -->
<!-- Does not work in text-mode browsers. -->
<!-- Does not work well on small screens. -->
<!-- The auto-exit feature was added to avoid leaving stray processes, eg on Windows. -->
<!-- It is not well tested. -->
<!-- If you start two instances on the same port, the second one will -->
<!-- appear to run normally, but you will be seeing pages served from the -->
<!-- first one. -->
}}) }})

20
hledger-api/doc/hledger-api.1.txt
View File

@ -21,9 +21,11 @@ DDEESSCCRRIIPPTTIIOONN
web apps operating on hledger data. It comes with a series of simple web apps operating on hledger data. It comes with a series of simple
client-side app examples, which drive it's evolution. client-side app examples, which drive it's evolution.
Data is served from the usual hledger journal file: ~/.hledger.journal, Like hledger, it reads data from one or more files in hledger journal,
$LEDGER_FILE, or another file specified with -f. For more about the timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE,
format, see hledger(1) or hledger_journal(5). or $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal). For more about this see hledger(1),
hledger_journal(5) etc.
The server listens on port 8001, or another specified with -p PORT. The server listens on port 8001, or another specified with -p PORT.
Note there is no built-in access control, so you will need to hide Note there is no built-in access control, so you will need to hide
@ -77,13 +79,15 @@ OOPPTTIIOONNSS
ignore any failing balance assertions in the journal ignore any failing balance assertions in the journal
EENNVVIIRROONNMMEENNTT EENNVVIIRROONNMMEENNTT
LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is LLEEDDGGEERR__FFIILLEE The journal file path when not specified with -f. Default:
~/.hledger.journal. ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FFIILLEESS FFIILLEESS
Reads data from a hledger journal file ($LEDGER_FILE or Reads data from one or more files in hledger journal, timeclock, time-
~/.hledger.journal by default), or a CSV file plus associated CSV rules dot, or CSV format specified with -f, or $LEDGER_FILE, or
file. $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal).
BBUUGGSS BBUUGGSS
The need to precede options with -- when invoked from hledger is awk- The need to precede options with -- when invoked from hledger is awk-

41
hledger-ui/doc/hledger-ui.1
View File

@ -20,21 +20,17 @@ other commodity, using double\-entry accounting and a simple, editable
file format. file format.
hledger is inspired by and largely compatible with ledger(1). hledger is inspired by and largely compatible with ledger(1).
.PP .PP
hledger\-ui is hledger\[aq]s curses\-style interface. hledger\-ui is hledger\[aq]s curses\-style interface, providing an
It reads a hledger journal file 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 .PP
(~/.hledger.journal, $LEDGER_FILE, or \-f FILE; see hledger(1) or Like hledger, it reads data from one or more files in hledger journal,
hledger_journal(5)) timeclock, timedot, or CSV format specified with \f[C]\-f\f[], or
.PP \f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
and provides a simple full\-screen console interface for viewing account perhaps \f[C]C:/Users/USER/.hledger.journal\f[]).
balances and transactions. For more about this see hledger(1), hledger_journal(5) etc.
.PP
It is simpler and more convenient for browsing than the command\-line
interface, but lighter and faster than hledger\-web.
.PP
The journal file is \f[C]~/.hledger.journal\f[], \f[C]$LEDGER_FILE\f[],
or another file specified with \-f.
For more about the format, see hledger(1) or hledger_journal(5).
.SH OPTIONS .SH OPTIONS
.PP .PP
Note: if invoking hledger\-ui as a hledger subcommand, write Note: if invoking hledger\-ui as a hledger subcommand, write
@ -369,16 +365,19 @@ Once you have fixed the problem described, press g again to reload and
restore normal operation. restore normal operation.
.SH ENVIRONMENT .SH ENVIRONMENT
.PP .PP
\f[B]LEDGER_FILE\f[] sets the default journal file path. \f[B]COLUMNS\f[] The screen width to use.
If not set, it is \f[C]~/.hledger.journal\f[]. Default: the full terminal width.
.PP .PP
\f[B]COLUMNS\f[] sets the screen width to use (normally the full \f[B]LEDGER_FILE\f[] The journal file path when not specified with
terminal width). \f[C]\-f\f[].
Default: \f[C]~/.hledger.journal\f[] (on windows, perhaps
\f[C]C:/Users/USER/.hledger.journal\f[]).
.SH FILES .SH FILES
.PP .PP
Reads data from a hledger journal file (\f[C]$LEDGER_FILE\f[] or Reads data from one or more files in hledger journal, timeclock,
\f[C]~/.hledger.journal\f[] by default), or a CSV file plus associated timedot, or CSV format specified with \f[C]\-f\f[], or
CSV rules file. \f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[]).
.SH BUGS .SH BUGS
.PP .PP
The need to precede options with \f[C]\-\-\f[] when invoked from hledger The need to precede options with \f[C]\-\-\f[] when invoked from hledger

49
hledger-ui/doc/hledger-ui.1.info
View File

@ -7,18 +7,17 @@ File: hledger-ui.1.info, Node: Top, Up: (dir)
hledger-ui(1) hledger-ui 0.28 hledger-ui(1) hledger-ui 0.28
***************************** *****************************
hledger-ui is hledger's curses-style interface. It reads a hledger hledger-ui is hledger's curses-style interface, providing an efficient
journal file 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
interface.
and provides a simple full-screen console interface for viewing Like hledger, it reads data from one or more files in hledger
account balances and transactions. journal, timeclock, timedot, or CSV format specified with `-f', or
`$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps
It is simpler and more convenient for browsing than the command-line `C:/Users/USER/.hledger.journal'). For more about this see hledger(1),
interface, but lighter and faster than hledger-web. hledger_journal(5) etc.
The journal file is `~/.hledger.journal', `$LEDGER_FILE', or another
file specified with -f. For more about the format, see hledger(1) or
hledger_journal(5).
* Menu: * Menu:
@ -316,19 +315,19 @@ press g again to reload and restore normal operation.
 
Tag Table: Tag Table:
Node: Top88 Node: Top88
Node: OPTIONS714 Node: OPTIONS825
Ref: #options813 Ref: #options924
Node: KEYS3689 Node: KEYS3800
Ref: #keys3786 Ref: #keys3897
Node: SCREENS4726 Node: SCREENS4837
Ref: #screens4813 Ref: #screens4924
Node: Accounts screen4903 Node: Accounts screen5014
Ref: #accounts-screen5033 Ref: #accounts-screen5144
Node: Register screen6137 Node: Register screen6248
Ref: #register-screen6294 Ref: #register-screen6405
Node: Transaction screen8047 Node: Transaction screen8158
Ref: #transaction-screen8207 Ref: #transaction-screen8318
Node: Error screen9074 Node: Error screen9185
Ref: #error-screen9198 Ref: #error-screen9309
 
End Tag Table End Tag Table

37
hledger-ui/doc/hledger-ui.1.m4.md
View File

@ -19,8 +19,8 @@ _toc_
<a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade-cash.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade-cash.png" title="beancount example's etrade cash subaccount" /></a> <a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade-cash.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade-cash.png" title="beancount example's etrade cash subaccount" /></a>
<a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" title="beancount example's etrade investments, all commoditiess" /></a> <a href="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc-etrade.png" title="beancount example's etrade investments, all commoditiess" /></a>
}}) }})
_man_({{
_man_({{
# NAME # NAME
hledger-ui - curses-style interface for the hledger accounting tool hledger-ui - curses-style interface for the hledger accounting tool
@ -32,25 +32,16 @@ hledger-ui - curses-style interface for the hledger accounting tool
# DESCRIPTION # DESCRIPTION
hledger is a cross-platform program for tracking money, time, or any other commodity, _hledgerdescription_
using double-entry accounting and a simple, editable file format.
hledger is inspired by and largely compatible with ledger(1).
}}) }})
hledger-ui is hledger's curses-style interface. hledger-ui is hledger's curses-style interface, providing an efficient full-window text UI
It reads a hledger journal file for viewing accounts and transactions, and some limited data entry capability.
_man_({{ It is easier than hledger's command-line interface, and
(~/.hledger.journal, $LEDGER_FILE, or -f FILE; see hledger(1) or hledger_journal(5)) sometimes quicker and more convenient than the web interface.
}})
and provides a simple full-screen console interface for viewing account balances and transactions.
It is simpler and more convenient for Like hledger, it reads _files_
browsing than the command-line interface, but lighter and faster than For more about this see hledger(1), hledger_journal(5) etc.
hledger-web.
The journal file is `~/.hledger.journal`, `$LEDGER_FILE`, or another file specified with -f.
For more about the format, see hledger(1) or hledger_journal(5).
# OPTIONS # OPTIONS
@ -217,17 +208,15 @@ _man_({{
# ENVIRONMENT # ENVIRONMENT
**LEDGER_FILE**
sets the default journal file path. If not set, it is `~/.hledger.journal`.
**COLUMNS** **COLUMNS**
sets the screen width to use (normally the full terminal width). The screen width to use.
Default: the full terminal width.
_LEDGER_FILE_
# FILES # FILES
Reads data from a hledger journal file (`$LEDGER_FILE` or Reads _files_
`~/.hledger.journal` by default), or a CSV file plus associated CSV
rules file.
# BUGS # BUGS

39
hledger-ui/doc/hledger-ui.1.txt
View File

@ -16,21 +16,17 @@ DDEESSCCRRIIPPTTIIOONN
file format. hledger is inspired by and largely compatible with file format. hledger is inspired by and largely compatible with
ledger(1). ledger(1).
hledger-ui is hledger's curses-style interface. It reads a hledger hledger-ui is hledger's curses-style interface, providing an efficient
journal file full-window text UI for viewing accounts and transactions, and some
limited data entry capability. It is easier than hledger's com-
mand-line interface, and sometimes quicker and more convenient than the
web interface.
(~/.hledger.journal, $LEDGER_FILE, or -f FILE; see hledger(1) or Like hledger, it reads data from one or more files in hledger journal,
hledger_journal(5)) timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE,
or $HOME/.hledger.journal (on windows, perhaps
and provides a simple full-screen console interface for viewing account C:/Users/USER/.hledger.journal). For more about this see hledger(1),
balances and transactions. hledger_journal(5) etc.
It is simpler and more convenient for browsing than the command-line
interface, but lighter and faster than hledger-web.
The journal file is ~/.hledger.journal, $LEDGER_FILE, or another file
specified with -f. For more about the format, see hledger(1) or
hledger_journal(5).
OOPPTTIIOONNSS OOPPTTIIOONNSS
Note: if invoking hledger-ui as a hledger subcommand, write -- before Note: if invoking hledger-ui as a hledger subcommand, write -- before
@ -266,16 +262,17 @@ SSCCRREEEENNSS
press g again to reload and restore normal operation. press g again to reload and restore normal operation.
EENNVVIIRROONNMMEENNTT EENNVVIIRROONNMMEENNTT
LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is CCOOLLUUMMNNSS The screen width to use. Default: the full terminal width.
~/.hledger.journal.
CCOOLLUUMMNNSS sets the screen width to use (normally the full terminal LLEEDDGGEERR__FFIILLEE The journal file path when not specified with -f. Default:
width). ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FFIILLEESS FFIILLEESS
Reads data from a hledger journal file ($LEDGER_FILE or Reads data from one or more files in hledger journal, timeclock, time-
~/.hledger.journal by default), or a CSV file plus associated CSV rules dot, or CSV format specified with -f, or $LEDGER_FILE, or
file. $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal).
BBUUGGSS BBUUGGSS
The need to precede options with -- when invoked from hledger is awk- The need to precede options with -- when invoked from hledger is awk-

31
hledger-web/doc/hledger-web.1
View File

@ -38,9 +38,11 @@ As a small protection against data loss when running an unprotected
instance, it writes a numbered backup of the main journal file (only ?) instance, it writes a numbered backup of the main journal file (only ?)
on every edit. on every edit.
.PP .PP
The journal file is \f[C]~/.hledger.journal\f[], \f[C]$LEDGER_FILE\f[], Like hledger, it reads data from one or more files in hledger journal,
or another file specified with \-f. timeclock, timedot, or CSV format specified with \f[C]\-f\f[], or
For more about the format, see hledger(1) or hledger_journal(5). \f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[]).
For more about this see hledger(1), hledger_journal(5) etc.
.PP .PP
By default, hledger\-web starts the web app in "transient mode" and also By default, hledger\-web starts the web app in "transient mode" and also
opens it in your default web browser if possible. opens it in your default web browser if possible.
@ -266,13 +268,16 @@ be "TAG:multi:level:account:name".
.RE .RE
.SH ENVIRONMENT .SH ENVIRONMENT
.PP .PP
\f[B]LEDGER_FILE\f[] sets the default journal file path. \f[B]LEDGER_FILE\f[] The journal file path when not specified with
If not set, it is \f[C]~/.hledger.journal\f[]. \f[C]\-f\f[].
Default: \f[C]~/.hledger.journal\f[] (on windows, perhaps
\f[C]C:/Users/USER/.hledger.journal\f[]).
.SH FILES .SH FILES
.PP .PP
Reads data from a hledger journal file (\f[C]$LEDGER_FILE\f[] or Reads data from one or more files in hledger journal, timeclock,
\f[C]~/.hledger.journal\f[] by default), or a CSV file plus associated timedot, or CSV format specified with \f[C]\-f\f[], or
CSV rules file. \f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[]).
.SH BUGS .SH BUGS
.PP .PP
The need to precede options with \f[C]\-\-\f[] when invoked from hledger The need to precede options with \f[C]\-\-\f[] when invoked from hledger
@ -281,19 +286,11 @@ is awkward.
\f[C]\-f\-\f[] doesn\[aq]t work (hledger\-web can\[aq]t read from \f[C]\-f\-\f[] doesn\[aq]t work (hledger\-web can\[aq]t read from
stdin). stdin).
.PP .PP
Query arguments and some applicable hledger options probably aren\[aq]t Query arguments and some hledger options are ignored.
supported.
.PP .PP
Does not work in text\-mode browsers. Does not work in text\-mode browsers.
.PP .PP
Does not work well on small screens. Does not work well on small screens.
.PP
The auto\-exit feature was added to avoid leaving stray processes, eg on
Windows.
It is not well tested.
.PP
If you start two instances on the same port, the second one will appear
to run normally, but you will be seeing pages served from the first one.
.SH "REPORTING BUGS" .SH "REPORTING BUGS"

12
hledger-web/doc/hledger-web.1.info
View File

@ -20,9 +20,11 @@ should put it behind a suitable web proxy. As a small protection against
data loss when running an unprotected instance, it writes a numbered data loss when running an unprotected instance, it writes a numbered
backup of the main journal file (only ?) on every edit. backup of the main journal file (only ?) on every edit.
The journal file is `~/.hledger.journal', `$LEDGER_FILE', or another Like hledger, it reads data from one or more files in hledger
file specified with -f. For more about the format, see hledger(1) or journal, timeclock, timedot, or CSV format specified with `-f', or
hledger_journal(5). `$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal'). For more about this see hledger(1),
hledger_journal(5) etc.
By default, hledger-web starts the web app in "transient mode" and By default, hledger-web starts the web app in "transient mode" and
also opens it in your default web browser if possible. In this mode the also opens it in your default web browser if possible. In this mode the
@ -188,7 +190,7 @@ before options as shown above.
 
Tag Table: Tag Table:
Node: Top90 Node: Top90
Node: OPTIONS2868 Node: OPTIONS2999
Ref: #options2955 Ref: #options3086
 
End Tag Table End Tag Table

25
hledger-web/doc/hledger-web.1.m4.md
View File

@ -6,6 +6,7 @@ _web_({{
_versions_({{hledger-web}}) _versions_({{hledger-web}})
_toc_ _toc_
}}) }})
_man_({{ _man_({{
# NAME # NAME
@ -28,9 +29,7 @@ hledger-web - web interface for the hledger accounting tool
# DESCRIPTION # DESCRIPTION
hledger is a cross-platform program for tracking money, time, or any other commodity, _hledgerdescription_
using double-entry accounting and a simple, editable file format.
hledger is inspired by and largely compatible with ledger(1).
}}) }})
hledger-web is hledger's web interface. It starts a simple web hledger-web is hledger's web interface. It starts a simple web
@ -47,8 +46,8 @@ behind a suitable web proxy. As a small protection against data loss
when running an unprotected instance, it writes a numbered backup of when running an unprotected instance, it writes a numbered backup of
the main journal file (only ?) on every edit. the main journal file (only ?) on every edit.
The journal file is `~/.hledger.journal`, `$LEDGER_FILE`, or another file specified with -f. Like hledger, it reads _files_
For more about the format, see hledger(1) or hledger_journal(5). For more about this see hledger(1), hledger_journal(5) etc.
By default, hledger-web starts the web app in "transient mode" and By default, hledger-web starts the web app in "transient mode" and
also opens it in your default web browser if possible. In this mode also opens it in your default web browser if possible. In this mode
@ -133,14 +132,11 @@ _man_({{
# ENVIRONMENT # ENVIRONMENT
**LEDGER_FILE** _LEDGER_FILE_
sets the default journal file path. If not set, it is `~/.hledger.journal`.
# FILES # FILES
Reads data from a hledger journal file (`$LEDGER_FILE` or Reads _files_
`~/.hledger.journal` by default), or a CSV file plus associated CSV
rules file.
# BUGS # BUGS
@ -148,17 +144,10 @@ 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 applicable hledger options probably aren't supported. Query arguments and some hledger options are ignored.
Does not work in text-mode browsers. Does not work in text-mode browsers.
Does not work well on small screens. Does not work well on small screens.
The auto-exit feature was added to avoid leaving stray processes, eg on Windows.
It is not well tested.
If you start two instances on the same port, the second one will
appear to run normally, but you will be seeing pages served from the
first one.
}}) }})

30
hledger-web/doc/hledger-web.1.txt
View File

@ -31,9 +31,11 @@ DDEESSCCRRIIPPTTIIOONN
against data loss when running an unprotected instance, it writes a against data loss when running an unprotected instance, it writes a
numbered backup of the main journal file (only ?) on every edit. numbered backup of the main journal file (only ?) on every edit.
The journal file is ~/.hledger.journal, $LEDGER_FILE, or another file Like hledger, it reads data from one or more files in hledger journal,
specified with -f. For more about the format, see hledger(1) or timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE,
hledger_journal(5). or $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal). For more about this see hledger(1),
hledger_journal(5) etc.
By default, hledger-web starts the web app in "transient mode" and also By default, hledger-web starts the web app in "transient mode" and also
opens it in your default web browser if possible. In this mode the web opens it in your default web browser if possible. In this mode the web
@ -183,13 +185,15 @@ OOPPTTIIOONNSS
name will be "TAG:multi:level:account:name". name will be "TAG:multi:level:account:name".
EENNVVIIRROONNMMEENNTT EENNVVIIRROONNMMEENNTT
LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is LLEEDDGGEERR__FFIILLEE The journal file path when not specified with -f. Default:
~/.hledger.journal. ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FFIILLEESS FFIILLEESS
Reads data from a hledger journal file ($LEDGER_FILE or Reads data from one or more files in hledger journal, timeclock, time-
~/.hledger.journal by default), or a CSV file plus associated CSV rules dot, or CSV format specified with -f, or $LEDGER_FILE, or
file. $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal).
BBUUGGSS BBUUGGSS
The need to precede options with -- when invoked from hledger is awk- The need to precede options with -- when invoked from hledger is awk-
@ -197,20 +201,12 @@ BBUUGGSS
-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 applicable hledger options probably aren't Query arguments and some hledger options are ignored.
supported.
Does not work in text-mode browsers. Does not work in text-mode browsers.
Does not work well on small screens. Does not work well on small screens.
The auto-exit feature was added to avoid leaving stray processes, eg on
Windows. It is not well tested.
If you start two instances on the same port, the second one will appear
to run normally, but you will be seeing pages served from the first
one.
RREEPPOORRTTIINNGG BBUUGGSS RREEPPOORRTTIINNGG BBUUGGSS

40
hledger/doc/hledger.1
View File

@ -19,7 +19,10 @@ hledger \- a command\-line accounting tool
hledger is a cross\-platform program for tracking money, time, or any hledger is a cross\-platform program for tracking money, time, or any
other commodity, using double\-entry accounting and a simple, editable other commodity, using double\-entry accounting and a simple, editable
file format. file format.
It is inspired by and largely compatible with ledger(1). hledger is inspired by and largely compatible with ledger(1).
.PD 0
.P
.PD
Tested on unix, mac, windows, hledger aims to be a reliable, practical Tested on unix, mac, windows, hledger aims to be a reliable, practical
tool for daily use. tool for daily use.
.PP .PP
@ -28,16 +31,18 @@ interfaces).
Its basic function is to read a plain text file describing financial Its basic function is to read a plain text file describing financial
transactions (in accounting terms, a general journal) and print useful transactions (in accounting terms, a general journal) and print useful
reports on standard output, or export them as CSV. reports on standard output, or export them as CSV.
hledger can also read CSV files, converting them semi\-automatically to hledger can also read some other file formats such as CSV files,
journal format. translating them to journal format.
Additionally, hledger lists other hledger\-* executables found in the Additionally, hledger lists other hledger\-* executables found in the
user's $PATH and can invoke them as subcommands. user's $PATH and can invoke them as subcommands.
.PP .PP
The journal file is \f[C]~/.hledger.journal\f[] by default, or another hledger reads data from one or more files in hledger journal, timeclock,
file path specified by \f[C]$LEDGER_FILE\f[]. timedot, or CSV format specified with \f[C]\-f\f[], or
(This should be a real environment variable, not a shell variable.) You \f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
can also specify a file with \f[C]\-f\ FILE\f[], or standard input with perhaps \f[C]C:/Users/USER/.hledger.journal\f[]).
\f[C]\-f\-\f[]. If using \f[C]$LEDGER_FILE\f[], note this must be a real environment
variable, not a shell variable.
You can specify standard input with \f[C]\-f\-\f[].
.PP .PP
Transactions are dated movements of money between two (or more) named Transactions are dated movements of money between two (or more) named
accounts, and are recorded with journal entries like this: accounts, and are recorded with journal entries like this:
@ -50,7 +55,7 @@ accounts, and are recorded with journal entries like this:
\f[] \f[]
.fi .fi
.PP .PP
For more about the format, see hledger_journal(5). For more about this format, see hledger_journal(5).
.PP .PP
Most users use a text editor to edit the journal, usually with an editor Most users use a text editor to edit the journal, usually with an editor
mode such as ledger\-mode for added convenience. mode such as ledger\-mode for added convenience.
@ -2272,16 +2277,19 @@ In a windows Cygwin/MSYS/Mintty window, the tab key is not supported in
hledger add. hledger add.
.SH ENVIRONMENT .SH ENVIRONMENT
.PP .PP
\f[B]LEDGER_FILE\f[] sets the default journal file path. \f[B]COLUMNS\f[] The screen width used by the register command.
If not set, it is \f[C]~/.hledger.journal\f[]. Default: the full terminal width.
.PP .PP
\f[B]COLUMNS\f[] sets the default width used by the register command \f[B]LEDGER_FILE\f[] The journal file path when not specified with
(normally the full terminal width). \f[C]\-f\f[].
Default: \f[C]~/.hledger.journal\f[] (on windows, perhaps
\f[C]C:/Users/USER/.hledger.journal\f[]).
.SH FILES .SH FILES
.PP .PP
Reads data from a hledger journal file (\f[C]$LEDGER_FILE\f[] or Reads data from one or more files in hledger journal, timeclock,
\f[C]~/.hledger.journal\f[] by default), or a CSV file plus associated timedot, or CSV format specified with \f[C]\-f\f[], or
CSV rules file. \f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[]).
.SH BUGS .SH BUGS
.PP .PP
The need to precede options with \f[C]\-\-\f[] when invoked from hledger The need to precede options with \f[C]\-\-\f[] when invoked from hledger

207
hledger/doc/hledger.1.info
View File

@ -11,14 +11,17 @@ 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 interfaces). Its basic function is to read a plain text file describing
financial transactions (in accounting terms, a general journal) and financial transactions (in accounting terms, a general journal) and
print useful reports on standard output, or export them as CSV. hledger print useful reports on standard output, or export them as CSV. hledger
can also read CSV files, converting them semi-automatically to journal can also read some other file formats such as CSV files, translating
format. Additionally, hledger lists other hledger-* executables found in them to journal format. Additionally, hledger lists other hledger-*
the user's $PATH and can invoke them as subcommands. executables found in the user's $PATH and can invoke them as
subcommands.
The journal file is `~/.hledger.journal' by default, or another file hledger reads data from one or more files in hledger journal,
path specified by `$LEDGER_FILE'. (This should be a real environment timeclock, timedot, or CSV format specified with `-f', or
variable, not a shell variable.) You can also specify a file with `-f `$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps
FILE', or standard input with `-f-'. `C:/Users/USER/.hledger.journal'). If using `$LEDGER_FILE', note this
must be a real environment variable, not a shell variable. You can
specify standard input with `-f-'.
Transactions are dated movements of money between two (or more) named Transactions are dated movements of money between two (or more) named
accounts, and are recorded with journal entries like this: accounts, and are recorded with journal entries like this:
@ -28,7 +31,7 @@ accounts, and are recorded with journal entries like this:
expenses:food $10 expenses:food $10
assets:cash assets:cash
For more about the format, see hledger_journal(5). For more about this format, see hledger_journal(5).
Most users use a text editor to edit the journal, usually with an Most users use a text editor to edit the journal, usually with an
editor mode such as ledger-mode for added convenience. hledger's editor mode such as ledger-mode for added convenience. hledger's
@ -2039,99 +2042,99 @@ in hledger add.
 
Tag Table: Tag Table:
Node: Top82 Node: Top82
Node: EXAMPLES1748 Node: EXAMPLES1875
Ref: #examples1850 Ref: #examples1977
Node: OPTIONS3854 Node: OPTIONS3981
Ref: #options3958 Ref: #options4085
Node: Multiple files7267 Node: Multiple files7394
Ref: #multiple-files7392 Ref: #multiple-files7519
Node: Repeated options7657 Node: Repeated options7784
Ref: #repeated-options7809 Ref: #repeated-options7936
Node: Depth limiting7929 Node: Depth limiting8056
Ref: #depth-limiting8074 Ref: #depth-limiting8201
Node: Smart dates8275 Node: Smart dates8402
Ref: #smart-dates8416 Ref: #smart-dates8543
Node: Reporting interval9413 Node: Reporting interval9540
Ref: #reporting-interval9572 Ref: #reporting-interval9699
Node: Period expressions9915 Node: Period expressions10042
Ref: #period-expressions10082 Ref: #period-expressions10209
Node: Regular Expressions12128 Node: Regular Expressions12255
Ref: #regular-expressions12270 Ref: #regular-expressions12397
Node: QUERIES13753 Node: QUERIES13880
Ref: #queries13857 Ref: #queries13984
Node: COMMANDS17159 Node: COMMANDS17286
Ref: #commands17273 Ref: #commands17400
Node: accounts17946 Node: accounts18073
Ref: #accounts18046 Ref: #accounts18173
Node: activity19028 Node: activity19155
Ref: #activity19140 Ref: #activity19267
Node: add19499 Node: add19626
Ref: #add19600 Ref: #add19727
Node: balance22259 Node: balance22386
Ref: #balance22372 Ref: #balance22499
Node: Flat mode25088 Node: Flat mode25215
Ref: #flat-mode25215 Ref: #flat-mode25342
Node: Depth limited balance reports25634 Node: Depth limited balance reports25761
Ref: #depth-limited-balance-reports25837 Ref: #depth-limited-balance-reports25964
Node: Multicolumn balance reports26258 Node: Multicolumn balance reports26385
Ref: #multicolumn-balance-reports26460 Ref: #multicolumn-balance-reports26587
Node: Market value31109 Node: Market value31236
Ref: #market-value31273 Ref: #market-value31400
Node: Custom balance output31766 Node: Custom balance output31893
Ref: #custom-balance-output31939 Ref: #custom-balance-output32066
Node: Output destination34043 Node: Output destination34170
Ref: #output-destination34208 Ref: #output-destination34335
Node: CSV output34478 Node: CSV output34605
Ref: #csv-output34597 Ref: #csv-output34724
Node: balancesheet34994 Node: balancesheet35121
Ref: #balancesheet35122 Ref: #balancesheet35249
Node: cashflow35774 Node: cashflow35901
Ref: #cashflow35891 Ref: #cashflow36018
Node: help36581 Node: help36708
Ref: #help36693 Ref: #help36820
Node: incomestatement37530 Node: incomestatement37657
Ref: #incomestatement37660 Ref: #incomestatement37787
Node: info38387 Node: info38514
Ref: #info38494 Ref: #info38621
Node: man38856 Node: man38983
Ref: #man38953 Ref: #man39080
Node: print39356 Node: print39483
Ref: #print39461 Ref: #print39588
Node: register40812 Node: register40939
Ref: #register40925 Ref: #register41052
Node: Custom register output45266 Node: Custom register output45393
Ref: #custom-register-output45397 Ref: #custom-register-output45524
Node: stats46694 Node: stats46821
Ref: #stats46800 Ref: #stats46927
Node: test47681 Node: test47808
Ref: #test47768 Ref: #test47895
Node: ADD-ON COMMANDS48135 Node: ADD-ON COMMANDS48262
Ref: #add-on-commands48271 Ref: #add-on-commands48398
Node: api49559 Node: api49686
Ref: #api49651 Ref: #api49778
Node: autosync49685 Node: autosync49812
Ref: #autosync49800 Ref: #autosync49927
Node: diff52115 Node: diff52242
Ref: #diff52225 Ref: #diff52352
Node: equity52889 Node: equity53016
Ref: #equity53003 Ref: #equity53130
Node: interest54331 Node: interest54458
Ref: #interest54448 Ref: #interest54575
Node: irr57532 Node: irr57659
Ref: #irr57645 Ref: #irr57772
Node: print-unique60020 Node: print-unique60147
Ref: #print-unique60150 Ref: #print-unique60277
Node: rewrite60408 Node: rewrite60535
Ref: #rewrite60527 Ref: #rewrite60654
Node: ui61056 Node: ui61183
Ref: #ui61156 Ref: #ui61283
Node: web61197 Node: web61324
Ref: #web61285 Ref: #web61412
Node: TROUBLESHOOTING61318 Node: TROUBLESHOOTING61445
Ref: #troubleshooting61437 Ref: #troubleshooting61564
Node: Run-time problems61491 Node: Run-time problems61618
Ref: #run-time-problems61634 Ref: #run-time-problems61761
Node: Known limitations63578 Node: Known limitations63705
Ref: #known-limitations63721 Ref: #known-limitations63848
 
End Tag Table End Tag Table

35
hledger/doc/hledger.1.m4.md
View File

@ -6,6 +6,7 @@ _web_({{
_versions_({{hledger}}) _versions_({{hledger}})
_toc_ _toc_
}}) }})
_man_({{ _man_({{
# NAME # NAME
@ -19,27 +20,23 @@ hledger - a command-line accounting tool
# DESCRIPTION # DESCRIPTION
hledger is a cross-platform program for tracking money, time, or any _hledgerdescription_
other commodity, using double-entry accounting and a simple, editable
file format. It is inspired by and largely compatible with ledger(1).
Tested on unix, mac, windows, hledger aims to be a reliable, practical Tested on unix, mac, windows, hledger aims to be a reliable, practical
tool for daily use. tool for daily use.
}}) }})
This is hledger’s command-line interface (there are also curses and web 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 interfaces). Its basic function is to read a plain text file describing
financial transactions (in accounting terms, a general journal) and financial transactions (in accounting terms, a general journal) and
print useful reports on standard output, or export them as CSV. hledger print useful reports on standard output, or export them as CSV. hledger
can also read CSV files, converting them semi-automatically to journal can also read some other file formats such as CSV files, translating
format. Additionally, hledger lists other hledger-\* executables found them to journal format. Additionally, hledger lists other hledger-\*
in the user’s \$PATH and can invoke them as subcommands. executables found in the user’s \$PATH and can invoke them as subcommands.
The journal file is `~/.hledger.journal` by default, or another file path hledger reads _files_
specified by `$LEDGER_FILE`. If using `$LEDGER_FILE`, note this must be a real environment variable,
(This should be a real environment variable, not a shell variable.) not a shell variable.
You can also specify a file with `-f FILE`, You can specify standard input with `-f-`.
or standard input with `-f-`.
Transactions are dated movements of money between two (or more) named Transactions are dated movements of money between two (or more) named
accounts, and are recorded with journal entries like this: accounts, and are recorded with journal entries like this:
@ -50,7 +47,7 @@ _journal_({{
assets:cash assets:cash
}}) }})
For more about the format, see hledger_journal(5). For more about this format, see hledger_journal(5).
Most users use a text editor to edit the journal, usually with an editor Most users use a text editor to edit the journal, usually with an editor
mode such as ledger-mode for added convenience. hledger’s interactive mode such as ledger-mode for added convenience. hledger’s interactive
@ -71,17 +68,15 @@ _man_({{
# ENVIRONMENT # ENVIRONMENT
**LEDGER_FILE**
sets the default journal file path. If not set, it is `~/.hledger.journal`.
**COLUMNS** **COLUMNS**
sets the default width used by the register command (normally the full terminal width). The screen width used by the register command.
Default: the full terminal width.
_LEDGER_FILE_
# FILES # FILES
Reads data from a hledger journal file (`$LEDGER_FILE` or Reads _files_
`~/.hledger.journal` by default), or a CSV file plus associated CSV
rules file.
# BUGS # BUGS

38
hledger/doc/hledger.1.txt
View File

@ -13,7 +13,8 @@ SSYYNNOOPPSSIISS
DDEESSCCRRIIPPTTIIOONN DDEESSCCRRIIPPTTIIOONN
hledger is a cross-platform program for tracking money, time, or any hledger is a cross-platform program for tracking money, time, or any
other commodity, using double-entry accounting and a simple, editable other commodity, using double-entry accounting and a simple, editable
file format. It is inspired by and largely compatible with ledger(1). file format. hledger is inspired by and largely compatible with
ledger(1).
Tested on unix, mac, windows, hledger aims to be a reliable, practical Tested on unix, mac, windows, hledger aims to be a reliable, practical
tool for daily use. tool for daily use.
@ -21,14 +22,17 @@ DDEESSCCRRIIPPTTIIOONN
interfaces). Its basic function is to read a plain text file describ- interfaces). Its basic function is to read a plain text file describ-
ing financial transactions (in accounting terms, a general journal) and ing financial transactions (in accounting terms, a general journal) and
print useful reports on standard output, or export them as CSV. print useful reports on standard output, or export them as CSV.
hledger can also read CSV files, converting them semi-automatically to hledger can also read some other file formats such as CSV files, trans-
journal format. Additionally, hledger lists other hledger-* executa- lating them to journal format. Additionally, hledger lists other
bles found in the user's $PATH and can invoke them as subcommands. hledger-* executables found in the user's $PATH and can invoke them as
subcommands.
The journal file is ~/.hledger.journal by default, or another file path hledger reads data from one or more files in hledger journal, time-
specified by $LEDGER_FILE. (This should be a real environment vari- clock, timedot, or CSV format specified with -f, or $LEDGER_FILE, or
able, not a shell variable.) You can also specify a file with -f FILE, $HOME/.hledger.journal (on windows, perhaps
or standard input with -f-. C:/Users/USER/.hledger.journal). If using $LEDGER_FILE, note this must
be a real environment variable, not a shell variable. You can specify
standard input with -f-.
Transactions are dated movements of money between two (or more) named Transactions are dated movements of money between two (or more) named
accounts, and are recorded with journal entries like this: accounts, and are recorded with journal entries like this:
@ -37,7 +41,7 @@ DDEESSCCRRIIPPTTIIOONN
expenses:food $10 expenses:food $10
assets:cash assets:cash
For more about the format, see hledger_journal(5). For more about this format, see hledger_journal(5).
Most users use a text editor to edit the journal, usually with an edi- Most users use a text editor to edit the journal, usually with an edi-
tor mode such as ledger-mode for added convenience. hledger's interac- tor mode such as ledger-mode for added convenience. hledger's interac-
@ -1660,16 +1664,18 @@ TTRROOUUBBLLEESSHHOOOOTTIINNGG
hledger add. hledger add.
EENNVVIIRROONNMMEENNTT EENNVVIIRROONNMMEENNTT
LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is CCOOLLUUMMNNSS The screen width used by the register command. Default: the
~/.hledger.journal. full terminal width.
CCOOLLUUMMNNSS sets the default width used by the register command (normally LLEEDDGGEERR__FFIILLEE The journal file path when not specified with -f. Default:
the full terminal width). ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FFIILLEESS FFIILLEESS
Reads data from a hledger journal file ($LEDGER_FILE or Reads data from one or more files in hledger journal, timeclock, time-
~/.hledger.journal by default), or a CSV file plus associated CSV rules dot, or CSV format specified with -f, or $LEDGER_FILE, or
file. $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal).
BBUUGGSS BBUUGGSS
The need to precede options with -- when invoked from hledger is awk- The need to precede options with -- when invoked from hledger is awk-