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

;doc: regen manuals

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-11-27 13:18:08 -08:00
parent 177e24c078
commit 4faefcfab2
6 changed files with 141 additions and 133 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger-lib/hledger_csv.5
View File

@ -499,7 +499,7 @@ Or \f[C]amount-in\f[R] and \f[C]amount-out\f[R] with no N for posting 1.
For convenience and backwards compatibility, if you set the amount of For convenience and backwards compatibility, if you set the amount of
posting 1 only, a second posting with the negative amount will be posting 1 only, a second posting with the negative amount will be
generated automatically. generated automatically.
(This also means you can\[aq]t generate a transaction with just one (Unless the account name is parenthesised indicating an unbalanced
posting.) posting.)
.PP .PP
If the CSV has the currency symbol in a separate field, you can use If the CSV has the currency symbol in a separate field, you can use

68
hledger-lib/hledger_csv.info
View File

@ -458,8 +458,8 @@ with no N for posting 1.
For convenience and backwards compatibility, if you set the amount of For convenience and backwards compatibility, if you set the amount of
posting 1 only, a second posting with the negative amount will be posting 1 only, a second posting with the negative amount will be
generated automatically. (This also means you can't generate a generated automatically. (Unless the account name is parenthesised
transaction with just one posting.) indicating an unbalanced posting.)
If the CSV has the currency symbol in a separate field, you can use If the CSV has the currency symbol in a separate field, you can use
'currencyN' to prepend it to posting N's amount. 'currency' with no N 'currencyN' to prepend it to posting N's amount. 'currency' with no N
@ -908,37 +908,37 @@ Node: Transaction field names16428
Ref: #transaction-field-names16588 Ref: #transaction-field-names16588
Node: Posting field names16699 Node: Posting field names16699
Ref: #posting-field-names16851 Ref: #posting-field-names16851
Node: field assignment18080 Node: field assignment18083
Ref: #field-assignment18216 Ref: #field-assignment18219
Node: if19034 Node: if19037
Ref: #if19143 Ref: #if19146
Node: end20859 Node: end20862
Ref: #end20965 Ref: #end20968
Node: date-format21189 Node: date-format21192
Ref: #date-format21321 Ref: #date-format21324
Node: newest-first22070 Node: newest-first22073
Ref: #newest-first22208 Ref: #newest-first22211
Node: include22891 Node: include22894
Ref: #include22999 Ref: #include23002
Node: TIPS23443 Node: TIPS23446
Ref: #tips23525 Ref: #tips23528
Node: Valid CSV23774 Node: Valid CSV23777
Ref: #valid-csv23893 Ref: #valid-csv23896
Node: Other separator characters24085 Node: Other separator characters24088
Ref: #other-separator-characters24273 Ref: #other-separator-characters24276
Node: Reading multiple CSV files24602 Node: Reading multiple CSV files24605
Ref: #reading-multiple-csv-files24799 Ref: #reading-multiple-csv-files24802
Node: Valid transactions25040 Node: Valid transactions25043
Ref: #valid-transactions25218 Ref: #valid-transactions25221
Node: Deduplicating importing25846 Node: Deduplicating importing25849
Ref: #deduplicating-importing26025 Ref: #deduplicating-importing26028
Node: Setting amounts27058 Node: Setting amounts27061
Ref: #setting-amounts27227 Ref: #setting-amounts27230
Node: Setting currency/commodity28213 Node: Setting currency/commodity28216
Ref: #setting-currencycommodity28405 Ref: #setting-currencycommodity28408
Node: Referencing other fields29208 Node: Referencing other fields29211
Ref: #referencing-other-fields29408 Ref: #referencing-other-fields29411
Node: How CSV rules are evaluated30305 Node: How CSV rules are evaluated30308
Ref: #how-csv-rules-are-evaluated30476 Ref: #how-csv-rules-are-evaluated30479
 
End Tag Table End Tag Table

4
hledger-lib/hledger_csv.txt
View File

@ -388,8 +388,8 @@ CSV RULES
For convenience and backwards compatibility, if you set the amount of For convenience and backwards compatibility, if you set the amount of
posting 1 only, a second posting with the negative amount will be gen- posting 1 only, a second posting with the negative amount will be gen-
erated automatically. (This also means you can't generate a transac- erated automatically. (Unless the account name is parenthesised indi-
tion with just one posting.) cating an unbalanced posting.)
If the CSV has the currency symbol in a separate field, you can use If the CSV has the currency symbol in a separate field, you can use
currencyN to prepend it to posting N's amount. currency with no N af- currencyN to prepend it to posting N's amount. currency with no N af-

30
hledger/hledger.1
View File

@ -3595,22 +3595,28 @@ test
.PD .PD
Run built-in unit tests. Run built-in unit tests.
.PP .PP
This command runs the unit tests built in to hledger-lib and hledger, This command runs the unit tests built in to hledger and hledger-lib,
printing test names and results on stdout. printing the results on stdout.
If any test fails, the exit code will be non-zero. If any test fails, the exit code will be non-zero.
.PP .PP
Test names include a group prefix. This is mainly used by hledger developers, but you can also use it to
If a (exact, case sensitive) group prefix, or a full test name is sanity-check the installed hledger executable on your platform.
provided as the first argument, only that group or test is run. All tests are expected to pass - if you ever see a failure, please
report as a bug!
.PP .PP
If a numeric second argument is provided, it will set the randomness This command also accepts tasty test runner options, written after a --
seed, for repeatable results from tests using randomness (currently none (double hyphen).
of them). Eg to run only the tests in Hledger.Data.Amount, with ANSI colour codes
disabled:
.IP
.nf
\f[C]
$ hledger test -- -pData.Amount --color=never
\f[R]
.fi
.PP .PP
This is mainly used by developers, but it\[aq]s nice to be able to For help on these, see https://github.com/feuerbach/tasty#options
sanity-check your installed hledger executable at any time. (\f[C]-- --help\f[R] currently doesn\[aq]t show them).
All tests are expected to pass - if you ever see otherwise, something
has gone wrong, please report a bug!
.SH ADD-ON COMMANDS .SH ADD-ON COMMANDS
.PP .PP
hledger also searches for external add-on commands, and will include hledger also searches for external add-on commands, and will include

77
hledger/hledger.info
View File

@ -3008,22 +3008,23 @@ File: hledger.info, Node: test, Prev: tags, Up: COMMANDS
test test
Run built-in unit tests. Run built-in unit tests.
This command runs the unit tests built in to hledger-lib and hledger, This command runs the unit tests built in to hledger and hledger-lib,
printing test names and results on stdout. If any test fails, the exit printing the results on stdout. If any test fails, the exit code will
code will be non-zero. be non-zero.
Test names include a group prefix. If a (exact, case sensitive) This is mainly used by hledger developers, but you can also use it to
group prefix, or a full test name is provided as the first argument, sanity-check the installed hledger executable on your platform. All
only that group or test is run. tests are expected to pass - if you ever see a failure, please report as
a bug!
If a numeric second argument is provided, it will set the randomness This command also accepts tasty test runner options, written after a
seed, for repeatable results from tests using randomness (currently none - (double hyphen). Eg to run only the tests in Hledger.Data.Amount,
of them). with ANSI colour codes disabled:
This is mainly used by developers, but it's nice to be able to $ hledger test -- -pData.Amount --color=never
sanity-check your installed hledger executable at any time. All tests
are expected to pass - if you ever see otherwise, something has gone For help on these, see https://github.com/feuerbach/tasty#options
wrong, please report a bug! ('-- --help' currently doesn't show them).
 
File: hledger.info, Node: ADD-ON COMMANDS, Prev: COMMANDS, Up: Top File: hledger.info, Node: ADD-ON COMMANDS, Prev: COMMANDS, Up: Top
@ -3337,30 +3338,30 @@ Node: tags105791
Ref: #tags105889 Ref: #tags105889
Node: test106183 Node: test106183
Ref: #test106267 Ref: #test106267
Node: ADD-ON COMMANDS107028 Node: ADD-ON COMMANDS107014
Ref: #add-on-commands107138 Ref: #add-on-commands107124
Node: Official add-ons108426 Node: Official add-ons108412
Ref: #official-add-ons108566 Ref: #official-add-ons108552
Node: ui108646 Node: ui108632
Ref: #ui108733 Ref: #ui108719
Node: web108787 Node: web108773
Ref: #web108876 Ref: #web108862
Node: Third party add-ons108922 Node: Third party add-ons108908
Ref: #third-party-add-ons109097 Ref: #third-party-add-ons109083
Ref: #diff-1109256 Ref: #diff-1109242
Node: iadd109355 Node: iadd109341
Ref: #iadd109465 Ref: #iadd109451
Node: interest109547 Node: interest109533
Ref: #interest109668 Ref: #interest109654
Node: irr109763 Node: irr109749
Ref: #irr109861 Ref: #irr109847
Node: Experimental add-ons109992 Node: Experimental add-ons109978
Ref: #experimental-add-ons110144 Ref: #experimental-add-ons110130
Node: autosync110392 Node: autosync110378
Ref: #autosync110503 Ref: #autosync110489
Node: chart110742 Node: chart110728
Ref: #chart110861 Ref: #chart110847
Node: check110932 Node: check110918
Ref: #check111034 Ref: #check111020
 
End Tag Table End Tag Table

93
hledger/hledger.txt
View File

@ -2609,46 +2609,47 @@ COMMANDS
test test
Run built-in unit tests. Run built-in unit tests.
This command runs the unit tests built in to hledger-lib and hledger, This command runs the unit tests built in to hledger and hledger-lib,
printing test names and results on stdout. If any test fails, the exit printing the results on stdout. If any test fails, the exit code will
code will be non-zero. be non-zero.
Test names include a group prefix. If a (exact, case sensitive) group This is mainly used by hledger developers, but you can also use it to
prefix, or a full test name is provided as the first argument, only sanity-check the installed hledger executable on your platform. All
that group or test is run. tests are expected to pass - if you ever see a failure, please report
as a bug!
If a numeric second argument is provided, it will set the randomness This command also accepts tasty test runner options, written after a --
seed, for repeatable results from tests using randomness (currently (double hyphen). Eg to run only the tests in Hledger.Data.Amount, with
none of them). ANSI colour codes disabled:
This is mainly used by developers, but it's nice to be able to sanity- $ hledger test -- -pData.Amount --color=never
check your installed hledger executable at any time. All tests are ex-
pected to pass - if you ever see otherwise, something has gone wrong, For help on these, see https://github.com/feuerbach/tasty#options (--
please report a bug! --help currently doesn't show them).
ADD-ON COMMANDS ADD-ON COMMANDS
hledger also searches for external add-on commands, and will include hledger also searches for external add-on commands, and will include
these in the commands list. These are programs or scripts in your PATH these in the commands list. These are programs or scripts in your PATH
whose name starts with hledger- and ends with a recognised file exten- whose name starts with hledger- and ends with a recognised file exten-
sion (currently: no extension, bat,com,exe, hs,lhs,pl,py,rb,rkt,sh). sion (currently: no extension, bat,com,exe, hs,lhs,pl,py,rb,rkt,sh).
Add-ons can be invoked like any hledger command, but there are a few Add-ons can be invoked like any hledger command, but there are a few
things to be aware of. Eg if the hledger-web add-on is installed, things to be aware of. Eg if the hledger-web add-on is installed,
o hledger -h web shows hledger's help, while hledger web -h shows o hledger -h web shows hledger's help, while hledger web -h shows
hledger-web's help. hledger-web's help.
o Flags specific to the add-on must have a preceding -- to hide them o Flags specific to the add-on must have a preceding -- to hide them
from hledger. So hledger web --serve --port 9000 will be rejected; from hledger. So hledger web --serve --port 9000 will be rejected;
you must use hledger web -- --serve --port 9000. you must use hledger web -- --serve --port 9000.
o You can always run add-ons directly if preferred: hledger-web --serve o You can always run add-ons directly if preferred: hledger-web --serve
--port 9000. --port 9000.
Add-ons are a relatively easy way to add local features or experiment Add-ons are a relatively easy way to add local features or experiment
with new ideas. They can be written in any language, but haskell with new ideas. They can be written in any language, but haskell
scripts have a big advantage: they can use the same hledger (and scripts have a big advantage: they can use the same hledger (and
haskell) library functions that built-in commands do, for command-line haskell) library functions that built-in commands do, for command-line
options, journal parsing, reporting, etc. options, journal parsing, reporting, etc.
Here are some hledger add-ons available: Here are some hledger add-ons available:
@ -2663,7 +2664,7 @@ ADD-ON COMMANDS
hledger-web provides a simple web interface. hledger-web provides a simple web interface.
Third party add-ons Third party add-ons
These are maintained separately, and usually updated shortly after a These are maintained separately, and usually updated shortly after a
hledger release. hledger release.
diff diff
@ -2683,14 +2684,14 @@ ADD-ON COMMANDS
count, but it's superseded now by the built-in roi command. count, but it's superseded now by the built-in roi command.
Experimental add-ons Experimental add-ons
These are available in source form in the hledger repo's bin/ direc- These are available in source form in the hledger repo's bin/ direc-
tory. They may be less mature and documented than built-in commands. tory. They may be less mature and documented than built-in commands.
Reading and tweaking these is a good way to start making your own! Reading and tweaking these is a good way to start making your own!
autosync autosync
hledger-autosync is a symbolic link for easily running ledger-autosync, hledger-autosync is a symbolic link for easily running ledger-autosync,
if installed. ledger-autosync does deduplicating conversion of OFX if installed. ledger-autosync does deduplicating conversion of OFX
data and some CSV formats, and can also download the data if your bank data and some CSV formats, and can also download the data if your bank
offers OFX Direct Connect. offers OFX Direct Connect.
chart chart
@ -2700,21 +2701,21 @@ ADD-ON COMMANDS
hledger-check.hs checks more powerful account balance assertions. hledger-check.hs checks more powerful account balance assertions.
ENVIRONMENT ENVIRONMENT
COLUMNS The screen width used by the register command. Default: the COLUMNS The screen width used by the register command. Default: the
full terminal width. full terminal width.
LEDGER_FILE The journal file path when not specified with -f. Default: LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal). nal).
FILES FILES
Reads data from one or more files in hledger journal, timeclock, time- Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal). C:/Users/USER/.hledger.journal).
LIMITATIONS LIMITATIONS
The need to precede addon command options with -- when invoked from The need to precede addon command options with -- when invoked from
hledger is awkward. hledger is awkward.
When input data contains non-ascii characters, a suitable system locale When input data contains non-ascii characters, a suitable system locale
@ -2730,33 +2731,33 @@ LIMITATIONS
In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger
add. add.
Not all of Ledger's journal file syntax is supported. See file format Not all of Ledger's journal file syntax is supported. See file format
differences. differences.
On large data files, hledger is slower and uses more memory than On large data files, hledger is slower and uses more memory than
Ledger. Ledger.
TROUBLESHOOTING TROUBLESHOOTING
Here are some issues you might encounter when you run hledger (and re- Here are some issues you might encounter when you run hledger (and re-
member you can also seek help from the IRC channel, mail list or bug member you can also seek help from the IRC channel, mail list or bug
tracker): tracker):
Successfully installed, but "No command 'hledger' found" Successfully installed, but "No command 'hledger' found"
stack and cabal install binaries into a special directory, which should stack and cabal install binaries into a special directory, which should
be added to your PATH environment variable. Eg on unix-like systems, be added to your PATH environment variable. Eg on unix-like systems,
that is ~/.local/bin and ~/.cabal/bin respectively. that is ~/.local/bin and ~/.cabal/bin respectively.
I set a custom LEDGER_FILE, but hledger is still using the default file I set a custom LEDGER_FILE, but hledger is still using the default file
LEDGER_FILE should be a real environment variable, not just a shell LEDGER_FILE should be a real environment variable, not just a shell
variable. The command env | grep LEDGER_FILE should show it. You may variable. The command env | grep LEDGER_FILE should show it. You may
need to use export. Here's an explanation. need to use export. Here's an explanation.
"Illegal byte sequence" or "Invalid or incomplete multibyte or wide "Illegal byte sequence" or "Invalid or incomplete multibyte or wide
character" errors character" errors
In order to handle non-ascii letters and symbols (like ), hledger needs In order to handle non-ascii letters and symbols (like ), hledger needs
an appropriate locale. This is usually configured system-wide; you can an appropriate locale. This is usually configured system-wide; you can
also configure it temporarily. The locale may need to be one that sup- also configure it temporarily. The locale may need to be one that sup-
ports UTF-8, if you built hledger with GHC < 7.2 (or possibly always, ports UTF-8, if you built hledger with GHC < 7.2 (or possibly always,
I'm not sure yet). I'm not sure yet).
Here's an example of setting the locale temporarily, on ubuntu Here's an example of setting the locale temporarily, on ubuntu
@ -2775,7 +2776,7 @@ TROUBLESHOOTING
$ echo "export LANG=en_US.UTF-8" >>~/.bash_profile $ echo "export LANG=en_US.UTF-8" >>~/.bash_profile
$ bash --login $ bash --login
If we preferred to use eg fr_FR.utf8, we might have to install that If we preferred to use eg fr_FR.utf8, we might have to install that
first: first:
$ apt-get install language-pack-fr $ apt-get install language-pack-fr
@ -2796,7 +2797,7 @@ TROUBLESHOOTING
REPORTING BUGS REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list) or hledger mail list)
@ -2810,7 +2811,7 @@ COPYRIGHT
SEE ALSO SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
dot(5), ledger(1) dot(5), ledger(1)