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".
}} )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\[aq]s evolution.
.PP
Data is served from the usual hledger journal file:
\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).
Like hledger, it reads data from one or more files in hledger journal,
timeclock, timedot, or CSV format specified with \f[C]\-f\f[], or
\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
The server listens on port 8001, or another specified with
\f[C]\-p\ PORT\f[].
@ -117,13 +118,16 @@ ignore any failing balance assertions in the journal
.RE
.SH ENVIRONMENT
.PP
\f[B]LEDGER_FILE\f[] sets the default journal file path.
If not set, it is \f[C]~/.hledger.journal\f[].
\f[B]LEDGER_FILE\f[] The journal file path when not specified with
\f[C]\-f\f[].
Default: \f[C]~/.hledger.journal\f[] (on windows, perhaps
\f[C]C:/Users/USER/.hledger.journal\f[]).
.SH FILES
.PP
Reads data from a hledger journal file (\f[C]$LEDGER_FILE\f[] or
\f[C]~/.hledger.journal\f[] by default), or a CSV file plus associated
CSV rules file.
Reads data from one or more files in hledger journal, timeclock,
timedot, or CSV format specified with \f[C]\-f\f[], or
\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
.PP
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
client-side app examples, which drive it's evolution.
Data is served from the usual hledger journal file:
`~/.hledger.journal', `$LEDGER_FILE', or another file specified with
-f. For more about the format, see hledger(1) or hledger_journal(5).
Like hledger, it reads 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'). For more about this see hledger(1),
hledger_journal(5) etc.
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
@ -82,7 +84,7 @@ before options as shown above.

Tag Table:
Node: Top90
Node: OPTIONS959
Ref: #options1046
Node: OPTIONS1058
Ref: #options1145

End Tag Table

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

@ -10,8 +10,8 @@ version:
</div>
_toc_
}})
_man_({{
_man_({{
# NAME
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
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).
_hledgerdescription_
}})
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 client-side app examples, which drive it's evolution.
Data is served from the usual hledger journal file:
`~/.hledger.journal`, `$LEDGER_FILE`, or another file specified with -f.
For more about the format, see hledger(1) or hledger_journal(5).
Like hledger, it reads _files_
For more about this see hledger(1), hledger_journal(5) etc.
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
@ -67,32 +63,14 @@ _man_({{
# ENVIRONMENT
**LEDGER_FILE**
sets the default journal file path. If not set, it is `~/.hledger.journal`.
_LEDGER_FILE_
# FILES
Reads data from a hledger journal file (`$LEDGER_FILE` or
`~/.hledger.journal` by default), or a CSV file plus associated CSV
rules file.
Reads _files_
# BUGS
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
client-side app examples, which drive it's evolution.
Data is served from the usual hledger journal file: ~/.hledger.journal,
$LEDGER_FILE, or another file specified with -f. For more about the
format, see hledger(1) or hledger_journal(5).
Like hledger, it reads 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). For more about this see hledger(1),
hledger_journal(5) etc.
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
@ -77,13 +79,15 @@ OOPPTTIIOONNSS
ignore any failing balance assertions in the journal
EENNVVIIRROONNMMEENNTT
LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is
~/.hledger.journal.
LLEEDDGGEERR__FFIILLEE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FFIILLEESS
Reads data from a hledger journal file ($LEDGER_FILE or
~/.hledger.journal by default), or a CSV file plus associated CSV rules
file.
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).
BBUUGGSS
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.
hledger is inspired by and largely compatible with ledger(1).
.PP
hledger\-ui is hledger\[aq]s curses\-style interface.
It reads a hledger journal file
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.
It is easier than hledger\[aq]s command\-line interface, and sometimes
quicker and more convenient than the web interface.
.PP
(~/.hledger.journal, $LEDGER_FILE, or \-f FILE; see hledger(1) or
hledger_journal(5))
.PP
and provides a simple full\-screen console interface for viewing account
balances and transactions.
.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).
Like hledger, it reads data from one or more files in hledger journal,
timeclock, timedot, or CSV format specified with \f[C]\-f\f[], or
\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.
.SH OPTIONS
.PP
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.
.SH ENVIRONMENT
.PP
\f[B]LEDGER_FILE\f[] sets the default journal file path.
If not set, it is \f[C]~/.hledger.journal\f[].
\f[B]COLUMNS\f[] The screen width to use.
Default: the full terminal width.
.PP
\f[B]COLUMNS\f[] sets the screen width to use (normally the full
terminal width).
\f[B]LEDGER_FILE\f[] The journal file path when not specified with
\f[C]\-f\f[].
Default: \f[C]~/.hledger.journal\f[] (on windows, perhaps
\f[C]C:/Users/USER/.hledger.journal\f[]).
.SH FILES
.PP
Reads data from a hledger journal file (\f[C]$LEDGER_FILE\f[] or
\f[C]~/.hledger.journal\f[] by default), or a CSV file plus associated
CSV rules file.
Reads data from one or more files in hledger journal, timeclock,
timedot, or CSV format specified with \f[C]\-f\f[], or
\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
.PP
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 is hledger's curses-style interface. It reads a hledger
journal file
hledger-ui is hledger's curses-style 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
interface.
and provides a simple full-screen console interface for viewing
account balances and transactions.
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).
Like hledger, it reads 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'). For more about this see hledger(1),
hledger_journal(5) etc.
* Menu:
@ -316,19 +315,19 @@ press g again to reload and restore normal operation.

Tag Table:
Node: Top88
Node: OPTIONS714
Ref: #options813
Node: KEYS3689
Ref: #keys3786
Node: SCREENS4726
Ref: #screens4813
Node: Accounts screen4903
Ref: #accounts-screen5033
Node: Register screen6137
Ref: #register-screen6294
Node: Transaction screen8047
Ref: #transaction-screen8207
Node: Error screen9074
Ref: #error-screen9198
Node: OPTIONS825
Ref: #options924
Node: KEYS3800
Ref: #keys3897
Node: SCREENS4837
Ref: #screens4924
Node: Accounts screen5014
Ref: #accounts-screen5144
Node: Register screen6248
Ref: #register-screen6405
Node: Transaction screen8158
Ref: #transaction-screen8318
Node: Error screen9185
Ref: #error-screen9309

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.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
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
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).
_hledgerdescription_
}})
hledger-ui is hledger's curses-style interface.
It reads a hledger journal file
_man_({{
(~/.hledger.journal, $LEDGER_FILE, or -f FILE; see hledger(1) or hledger_journal(5))
}})
and provides a simple full-screen console interface for viewing account balances and transactions.
hledger-ui is hledger's curses-style 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 interface.
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).
Like hledger, it reads _files_
For more about this see hledger(1), hledger_journal(5) etc.
# OPTIONS
@ -217,17 +208,15 @@ _man_({{
# ENVIRONMENT
**LEDGER_FILE**
sets the default journal file path. If not set, it is `~/.hledger.journal`.
**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
Reads data from a hledger journal file (`$LEDGER_FILE` or
`~/.hledger.journal` by default), or a CSV file plus associated CSV
rules file.
Reads _files_
# 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
ledger(1).
hledger-ui is hledger's curses-style interface. It reads a hledger
journal file
hledger-ui is hledger's curses-style 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 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
hledger_journal(5))
and provides a simple full-screen console interface for viewing account
balances and transactions.
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).
Like hledger, it reads 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). For more about this see hledger(1),
hledger_journal(5) etc.
OOPPTTIIOONNSS
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.
EENNVVIIRROONNMMEENNTT
LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is
~/.hledger.journal.
CCOOLLUUMMNNSS The screen width to use. Default: the full terminal width.
CCOOLLUUMMNNSS sets the screen width to use (normally the full terminal
width).
LLEEDDGGEERR__FFIILLEE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FFIILLEESS
Reads data from a hledger journal file ($LEDGER_FILE or
~/.hledger.journal by default), or a CSV file plus associated CSV rules
file.
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).
BBUUGGSS
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 ?)
on every edit.
.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).
Like hledger, it reads data from one or more files in hledger journal,
timeclock, timedot, or CSV format specified with \f[C]\-f\f[], or
\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
By default, hledger\-web starts the web app in "transient mode" and also
opens it in your default web browser if possible.
@ -266,13 +268,16 @@ be "TAG:multi:level:account:name".
.RE
.SH ENVIRONMENT
.PP
\f[B]LEDGER_FILE\f[] sets the default journal file path.
If not set, it is \f[C]~/.hledger.journal\f[].
\f[B]LEDGER_FILE\f[] The journal file path when not specified with
\f[C]\-f\f[].
Default: \f[C]~/.hledger.journal\f[] (on windows, perhaps
\f[C]C:/Users/USER/.hledger.journal\f[]).
.SH FILES
.PP
Reads data from a hledger journal file (\f[C]$LEDGER_FILE\f[] or
\f[C]~/.hledger.journal\f[] by default), or a CSV file plus associated
CSV rules file.
Reads data from one or more files in hledger journal, timeclock,
timedot, or CSV format specified with \f[C]\-f\f[], or
\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
.PP
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
stdin).
.PP
Query arguments and some applicable hledger options probably aren\[aq]t
supported.
Query arguments and some hledger options are ignored.
.PP
Does not work in text\-mode browsers.
.PP
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"

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
backup of the main journal file (only ?) on every edit.
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).
Like hledger, it reads 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'). For more about this see hledger(1),
hledger_journal(5) etc.
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
@ -188,7 +190,7 @@ before options as shown above.

Tag Table:
Node: Top90
Node: OPTIONS2868
Ref: #options2955
Node: OPTIONS2999
Ref: #options3086

End Tag Table

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

@ -6,6 +6,7 @@ _web_({{
_versions_({{hledger-web}})
_toc_
}})
_man_({{
# NAME
@ -28,9 +29,7 @@ hledger-web - web interface for the hledger accounting tool
# DESCRIPTION
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).
_hledgerdescription_
}})
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
the main journal file (only ?) on every edit.
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).
Like hledger, it reads _files_
For more about this see hledger(1), hledger_journal(5) etc.
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
@ -133,14 +132,11 @@ _man_({{
# ENVIRONMENT
**LEDGER_FILE**
sets the default journal file path. If not set, it is `~/.hledger.journal`.
_LEDGER_FILE_
# FILES
Reads data from a hledger journal file (`$LEDGER_FILE` or
`~/.hledger.journal` by default), or a CSV file plus associated CSV
rules file.
Reads _files_
# 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).
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 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
numbered backup of the main journal file (only ?) on every edit.
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).
Like hledger, it reads 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). For more about this see hledger(1),
hledger_journal(5) etc.
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
@ -183,13 +185,15 @@ OOPPTTIIOONNSS
name will be "TAG:multi:level:account:name".
EENNVVIIRROONNMMEENNTT
LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is
~/.hledger.journal.
LLEEDDGGEERR__FFIILLEE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FFIILLEESS
Reads data from a hledger journal file ($LEDGER_FILE or
~/.hledger.journal by default), or a CSV file plus associated CSV rules
file.
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).
BBUUGGSS
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).
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 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

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
other commodity, using double\-entry accounting and a simple, editable
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
tool for daily use.
.PP
@ -28,16 +31,18 @@ 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 CSV files, converting them semi\-automatically to
journal format.
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.
.PP
The journal file is \f[C]~/.hledger.journal\f[] by default, or another
file path specified by \f[C]$LEDGER_FILE\f[].
(This should be a real environment variable, not a shell variable.) You
can also specify a file with \f[C]\-f\ FILE\f[], or standard input with
\f[C]\-f\-\f[].
hledger reads data from one or more files in hledger journal, timeclock,
timedot, or CSV format specified with \f[C]\-f\f[], or
\f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\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
Transactions are dated movements of money between two (or more) named
accounts, and are recorded with journal entries like this:
@ -50,7 +55,7 @@ accounts, and are recorded with journal entries like this:
\f[]
.fi
.PP
For more about the format, see hledger_journal(5).
For more about this format, see hledger_journal(5).
.PP
Most users use a text editor to edit the journal, usually with an editor
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.
.SH ENVIRONMENT
.PP
\f[B]LEDGER_FILE\f[] sets the default journal file path.
If not set, it is \f[C]~/.hledger.journal\f[].
\f[B]COLUMNS\f[] The screen width used by the register command.
Default: the full terminal width.
.PP
\f[B]COLUMNS\f[] sets the default width used by the register command
(normally the full terminal width).
\f[B]LEDGER_FILE\f[] The journal file path when not specified with
\f[C]\-f\f[].
Default: \f[C]~/.hledger.journal\f[] (on windows, perhaps
\f[C]C:/Users/USER/.hledger.journal\f[]).
.SH FILES
.PP
Reads data from a hledger journal file (\f[C]$LEDGER_FILE\f[] or
\f[C]~/.hledger.journal\f[] by default), or a CSV file plus associated
CSV rules file.
Reads data from one or more files in hledger journal, timeclock,
timedot, or CSV format specified with \f[C]\-f\f[], or
\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
.PP
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
financial transactions (in accounting terms, a general journal) and
print useful reports on standard output, or export them as CSV. hledger
can also read CSV files, converting them semi-automatically to journal
format. Additionally, hledger lists other hledger-* executables found in
the user's $PATH and can invoke them as subcommands.
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.
The journal file is `~/.hledger.journal' by default, or another file
path specified by `$LEDGER_FILE'. (This should be a real environment
variable, not a shell variable.) You can also specify a file with `-f
FILE', or standard input with `-f-'.
hledger reads 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'). 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
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
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 mode such as ledger-mode for added convenience. hledger's
@ -2039,99 +2042,99 @@ in hledger add.

Tag Table:
Node: Top82
Node: EXAMPLES1748
Ref: #examples1850
Node: OPTIONS3854
Ref: #options3958
Node: Multiple files7267
Ref: #multiple-files7392
Node: Repeated options7657
Ref: #repeated-options7809
Node: Depth limiting7929
Ref: #depth-limiting8074
Node: Smart dates8275
Ref: #smart-dates8416
Node: Reporting interval9413
Ref: #reporting-interval9572
Node: Period expressions9915
Ref: #period-expressions10082
Node: Regular Expressions12128
Ref: #regular-expressions12270
Node: QUERIES13753
Ref: #queries13857
Node: COMMANDS17159
Ref: #commands17273
Node: accounts17946
Ref: #accounts18046
Node: activity19028
Ref: #activity19140
Node: add19499
Ref: #add19600
Node: balance22259
Ref: #balance22372
Node: Flat mode25088
Ref: #flat-mode25215
Node: Depth limited balance reports25634
Ref: #depth-limited-balance-reports25837
Node: Multicolumn balance reports26258
Ref: #multicolumn-balance-reports26460
Node: Market value31109
Ref: #market-value31273
Node: Custom balance output31766
Ref: #custom-balance-output31939
Node: Output destination34043
Ref: #output-destination34208
Node: CSV output34478
Ref: #csv-output34597
Node: balancesheet34994
Ref: #balancesheet35122
Node: cashflow35774
Ref: #cashflow35891
Node: help36581
Ref: #help36693
Node: incomestatement37530
Ref: #incomestatement37660
Node: info38387
Ref: #info38494
Node: man38856
Ref: #man38953
Node: print39356
Ref: #print39461
Node: register40812
Ref: #register40925
Node: Custom register output45266
Ref: #custom-register-output45397
Node: stats46694
Ref: #stats46800
Node: test47681
Ref: #test47768
Node: ADD-ON COMMANDS48135
Ref: #add-on-commands48271
Node: api49559
Ref: #api49651
Node: autosync49685
Ref: #autosync49800
Node: diff52115
Ref: #diff52225
Node: equity52889
Ref: #equity53003
Node: interest54331
Ref: #interest54448
Node: irr57532
Ref: #irr57645
Node: print-unique60020
Ref: #print-unique60150
Node: rewrite60408
Ref: #rewrite60527
Node: ui61056
Ref: #ui61156
Node: web61197
Ref: #web61285
Node: TROUBLESHOOTING61318
Ref: #troubleshooting61437
Node: Run-time problems61491
Ref: #run-time-problems61634
Node: Known limitations63578
Ref: #known-limitations63721
Node: EXAMPLES1875
Ref: #examples1977
Node: OPTIONS3981
Ref: #options4085
Node: Multiple files7394
Ref: #multiple-files7519
Node: Repeated options7784
Ref: #repeated-options7936
Node: Depth limiting8056
Ref: #depth-limiting8201
Node: Smart dates8402
Ref: #smart-dates8543
Node: Reporting interval9540
Ref: #reporting-interval9699
Node: Period expressions10042
Ref: #period-expressions10209
Node: Regular Expressions12255
Ref: #regular-expressions12397
Node: QUERIES13880
Ref: #queries13984
Node: COMMANDS17286
Ref: #commands17400
Node: accounts18073
Ref: #accounts18173
Node: activity19155
Ref: #activity19267
Node: add19626
Ref: #add19727
Node: balance22386
Ref: #balance22499
Node: Flat mode25215
Ref: #flat-mode25342
Node: Depth limited balance reports25761
Ref: #depth-limited-balance-reports25964
Node: Multicolumn balance reports26385
Ref: #multicolumn-balance-reports26587
Node: Market value31236
Ref: #market-value31400
Node: Custom balance output31893
Ref: #custom-balance-output32066
Node: Output destination34170
Ref: #output-destination34335
Node: CSV output34605
Ref: #csv-output34724
Node: balancesheet35121
Ref: #balancesheet35249
Node: cashflow35901
Ref: #cashflow36018
Node: help36708
Ref: #help36820
Node: incomestatement37657
Ref: #incomestatement37787
Node: info38514
Ref: #info38621
Node: man38983
Ref: #man39080
Node: print39483
Ref: #print39588
Node: register40939
Ref: #register41052
Node: Custom register output45393
Ref: #custom-register-output45524
Node: stats46821
Ref: #stats46927
Node: test47808
Ref: #test47895
Node: ADD-ON COMMANDS48262
Ref: #add-on-commands48398
Node: api49686
Ref: #api49778
Node: autosync49812
Ref: #autosync49927
Node: diff52242
Ref: #diff52352
Node: equity53016
Ref: #equity53130
Node: interest54458
Ref: #interest54575
Node: irr57659
Ref: #irr57772
Node: print-unique60147
Ref: #print-unique60277
Node: rewrite60535
Ref: #rewrite60654
Node: ui61183
Ref: #ui61283
Node: web61324
Ref: #web61412
Node: TROUBLESHOOTING61445
Ref: #troubleshooting61564
Node: Run-time problems61618
Ref: #run-time-problems61761
Node: Known limitations63705
Ref: #known-limitations63848

End Tag Table

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

@ -6,6 +6,7 @@ _web_({{
_versions_({{hledger}})
_toc_
}})
_man_({{
# NAME
@ -19,27 +20,23 @@ hledger - a command-line accounting tool
# DESCRIPTION
hledger is a cross-platform program for tracking money, time, or any
other commodity, using double-entry accounting and a simple, editable
file format. It is inspired by and largely compatible with ledger(1).
_hledgerdescription_
Tested on unix, mac, windows, hledger aims to be a reliable, practical
tool for daily use.
}})
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 CSV files, converting them semi-automatically to journal
format. Additionally, hledger lists other hledger-\* executables found
in the user’s \$PATH and can invoke them as subcommands.
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.
The journal file is `~/.hledger.journal` by default, or another file path
specified by `$LEDGER_FILE`.
(This should be a real environment variable, not a shell variable.)
You can also specify a file with `-f FILE`,
or standard input with `-f-`.
hledger reads _files_
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
accounts, and are recorded with journal entries like this:
@ -50,7 +47,7 @@ _journal_({{
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
mode such as ledger-mode for added convenience. hledger’s interactive
@ -71,17 +68,15 @@ _man_({{
# ENVIRONMENT
**LEDGER_FILE**
sets the default journal file path. If not set, it is `~/.hledger.journal`.
**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
Reads data from a hledger journal file (`$LEDGER_FILE` or
`~/.hledger.journal` by default), or a CSV file plus associated CSV
rules file.
Reads _files_
# BUGS

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

@ -13,7 +13,8 @@ SSYYNNOOPPSSIISS
DDEESSCCRRIIPPTTIIOONN
hledger is a cross-platform program for tracking money, time, or any
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
tool for daily use.
@ -21,14 +22,17 @@ DDEESSCCRRIIPPTTIIOONN
interfaces). Its basic function is to read a plain text file describ-
ing financial transactions (in accounting terms, a general journal) and
print useful reports on standard output, or export them as CSV.
hledger can also read CSV files, converting them semi-automatically to
journal format. Additionally, hledger lists other hledger-* executa-
bles found in the user's $PATH and can invoke them as subcommands.
hledger can also read some other file formats such as CSV files, trans-
lating them to journal format. Additionally, hledger lists other
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
specified by $LEDGER_FILE. (This should be a real environment vari-
able, not a shell variable.) You can also specify a file with -f FILE,
or standard input with -f-.
hledger reads data from one or more files in hledger journal, time-
clock, timedot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
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
accounts, and are recorded with journal entries like this:
@ -37,7 +41,7 @@ DDEESSCCRRIIPPTTIIOONN
expenses:food $10
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-
tor mode such as ledger-mode for added convenience. hledger's interac-
@ -1660,16 +1664,18 @@ TTRROOUUBBLLEESSHHOOOOTTIINNGG
hledger add.
EENNVVIIRROONNMMEENNTT
LLEEDDGGEERR__FFIILLEE sets the default journal file path. If not set, it is
~/.hledger.journal.
CCOOLLUUMMNNSS The screen width used by the register command. Default: the
full terminal width.
CCOOLLUUMMNNSS sets the default width used by the register command (normally
the full terminal width).
LLEEDDGGEERR__FFIILLEE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FFIILLEESS
Reads data from a hledger journal file ($LEDGER_FILE or
~/.hledger.journal by default), or a CSV file plus associated CSV rules
file.
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).
BBUUGGSS
The need to precede options with -- when invoked from hledger is awk-