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

;doc: more file extensions tweaks

Browse Source
This commit is contained in:
Simon Michael 2020-08-21 09:21:46 -07:00
parent c3d8857ae5
commit 20336ddc4d
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
hledger/hledger.m4.md
View File

@ -725,10 +725,8 @@ The file name `-` (hyphen) means standard input:
$ cat some.journal | hledger -f- $ cat some.journal | hledger -f-
``` ```
Usually the data file is in hledger's journal format, Usually the data file is in hledger's journal format, but it can be in
but it can also be one of several other formats, listed below. any of the supported file formats, which currently are:
hledger detects the format automatically based on the file extension,
or if that is not recognised, by trying each built-in "reader" in turn:
| Reader: | Reads: | Used for file extensions: | | Reader: | Reads: | Used for file extensions: |
|-------------|------------------------------------------------------------------|--------------------------------------| |-------------|------------------------------------------------------------------|--------------------------------------|
@ -737,22 +735,31 @@ or if that is not recognised, by trying each built-in "reader" in turn:
| `timedot` | timedot files, for approximate time logging | `.timedot` | | `timedot` | timedot files, for approximate time logging | `.timedot` |
| `csv` | comma/semicolon/tab/other-separated values, for data import | `.csv` `.ssv` `.tsv` | | `csv` | comma/semicolon/tab/other-separated values, for data import | `.csv` `.ssv` `.tsv` |
If needed (eg to ensure correct error messages when a file has the "wrong" extension), hledger detects the format automatically based on the file extensions
you can force a specific reader/format by prepending it to the file path with a colon. shown above. If it can't recognise the file extension, it assumes
Examples: `journal` format. So for non-journal files, it's important to use a
recognised file extension, so as to either read successfully or to
show relevant error messages.
When you can't ensure the right file extension, not to worry: you can
force a specific reader/format by prefixing the file path with the
format and a colon. Eg to read a .dat file as csv:
```shell ```shell
$ hledger -f csv:/some/csv-file.dat stats $ hledger -f csv:/some/csv-file.dat stats
$ echo 'i 2009/13/1 08:00:00' | hledger print -ftimeclock:- $ echo 'i 2009/13/1 08:00:00' | hledger print -ftimeclock:-
``` ```
You can also specify multiple `-f` options, to read multiple files as one big journal. You can specify multiple `-f` options, to read multiple files as one big journal.
There are some limitations with this: There are some limitations with this:
- directives in one file will not affect the other files - directives in one file will not affect the other files
- [balance assertions](journal.html#balance-assertions) will not see any account balances from previous files - [balance assertions](journal.html#balance-assertions) will not see any account balances from previous files
If you need those, either use the [include directive](journal.html#including-other-files), If you need either of those things, you can
or concatenate the files, eg: `cat a.journal b.journal | hledger -f- CMD`.
- use a single parent file which [includes](journal.html#including-other-files) the others
- or concatenate the files into one before reading, eg: `cat a.journal b.journal | hledger -f- CMD`.
## Output destination ## Output destination