;doc: some changes to hledger and input files description macros

This commit is contained in:
Simon Michael 2022-12-14 12:23:10 -10:00
parent 5a8e63d24d
commit 43023d3d86
4 changed files with 16 additions and 14 deletions

View File

@ -208,15 +208,19 @@ _optionnotes_
m4_dnl m4_dnl
m4_dnl A standard description of hledger. m4_dnl A standard description of hledger.
m4_define({{_hledgerdescription_}}, {{ m4_define({{_hledgerdescription_}}, {{
hledger is a reliable, cross-platform set of programs for tracking money, time, or any other commodity, hledger is a robust, user-friendly, cross-platform set of programs
for tracking money, time, or any other commodity,
using double-entry accounting and a simple, editable file format. using double-entry accounting and a simple, editable file format.
hledger is inspired by and largely compatible with ledger(1). }} )m4_dnl hledger is inspired by and largely compatible with ledger(1),
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({{_files_}}, m4_define({{_inputfiles_}},
{{data from one or more files in hledger journal, timeclock, timedot, or CSV format {{data from one or more files in journal, timeclock, timedot, or CSV format.
specified with `-f`, or `$LEDGER_FILE`, The default file is `.hledger.journal` in your home directory;
or `$HOME/.hledger.journal` (on windows, perhaps `C:/Users/USER/.hledger.journal`).}})m4_dnl this can be overridden with one or more `-f FILE` options,
or the `LEDGER_FILE` environment variable.}})m4_dnl
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_}}, {{

View File

@ -42,7 +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 _files_ Like hledger, it reads _inputfiles_
For more about this see hledger(1), hledger_journal(5) etc. 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.
@ -397,7 +397,7 @@ _LEDGER_FILE_
# FILES # FILES
Reads _files_ Reads _inputfiles_
# BUGS # BUGS

View File

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

View File

@ -54,10 +54,8 @@ can also read some other file formats such as CSV files, translating
them to journal format. Additionally, hledger lists other hledger-\* them to journal format. Additionally, hledger lists other hledger-\*
executables found in the users \$PATH and can invoke them as subcommands. executables found in the users \$PATH and can invoke them as subcommands.
hledger reads _files_ hledger reads _inputfiles_
If using `$LEDGER_FILE`, note this must be a real environment variable, hledger CLI can also read from stdin with `-f-`; more on that below.
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: