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

;cln:doc: update the manuals' brief input files descriptions

Browse Source 
These come from the inputfiles (and new inputfileswithptr) macros,
currently used in five places in the three manuals.
This commit is contained in:
Simon Michael 2023-05-25 12:23:43 -10:00
parent b8f1a67503
commit a717cbd300
4 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/common.m4
View File

@ -230,11 +230,16 @@ and largely interconvertible with beancount(1). }} )m4_dnl
m4_dnl m4_dnl
m4_dnl A standard description of where hledger reads data from. m4_dnl A standard description of where hledger reads data from.
m4_define({{_inputfiles_}}, m4_define({{_inputfiles_}},
{{data from one or more files in journal, timeclock, timedot, or CSV format. {{reads from (and appends to) a journal file specified by the `LEDGER_FILE` environment variable
The default file is `.hledger.journal` in your home directory; (defaulting to `$HOME/.hledger.journal`); or you can specify files with `-f` options.
this can be overridden with one or more `-f FILE` options, It can also read timeclock files, timedot files, or any CSV/SSV/TSV file with a date field.}} )m4_dnl
or the `LEDGER_FILE` environment variable.}})m4_dnl
m4_dnl m4_dnl
m4_dnl Like the above, with an added pointer to the hledger manual.
m4_define({{_inputfileswithptr_}},
{{_inputfiles_
(See hledger(1) -> Input for details.)}} )m4_dnl
m4_dnl
m4_dnl A standard description of the LEDGER_FILE environment variable. m4_dnl A standard description of the LEDGER_FILE environment variable.
m4_define({{_LEDGER_FILE_}}, {{ m4_define({{_LEDGER_FILE_}}, {{
**LEDGER_FILE** **LEDGER_FILE**

5
hledger-ui/hledger-ui.m4.md
View File

@ -42,8 +42,7 @@ for viewing accounts and transactions, and some limited data entry capability.
It is easier than hledger's command-line interface, and It is easier than hledger's command-line interface, and
sometimes quicker and more convenient than the web interface. sometimes quicker and more convenient than the web interface.
Like hledger, it reads _inputfiles_ Like hledger, it _inputfileswithptr_
For more about this see hledger(1), hledger_journal(5) etc.
Unlike hledger, hledger-ui hides all future-dated transactions by default. Unlike hledger, hledger-ui hides all future-dated transactions by default.
They can be revealed, along with any rule-generated periodic transactions, They can be revealed, along with any rule-generated periodic transactions,
@ -376,7 +375,7 @@ _LEDGER_FILE_
# FILES # FILES
Reads _inputfiles_ It _inputfileswithptr_
# BUGS # BUGS

5
hledger-web/hledger-web.m4.md
View File

@ -47,8 +47,7 @@ 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.
Like hledger, it reads _inputfiles_ Like hledger, it _inputfileswithptr_
For more about this see hledger(1).
hledger-web can be run in three modes: hledger-web can be run in three modes:
@ -422,7 +421,7 @@ _LEDGER_FILE_
# FILES # FILES
Reads _inputfiles_ It _inputfileswithptr_
# BUGS # BUGS

5
hledger/hledger.m4.md
View File

@ -56,10 +56,9 @@ and print a useful report on the terminal (or save it as HTML, CSV, JSON or SQL)
Many reports are available, as subcommands. Many reports are available, as subcommands.
hledger will also detect other `hledger-*` executables as extra subcommands. hledger will also detect other `hledger-*` executables as extra subcommands.
hledger reads _inputfiles_ hledger usually _inputfiles_
hledger CLI can also read from stdin with `-f-`; more on that below.
Here is a small but valid hledger journal file describing one transaction: Here is a small journal file describing one transaction:
_journal_({{ _journal_({{
2015-10-16 bought food 2015-10-16 bought food