From 0dadeffcbc8020915e54df11746af6965dce37bd Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Mon, 21 Nov 2016 08:28:01 -0800 Subject: [PATCH] doc: more input files cleanup --- hledger/doc/options.m4.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/hledger/doc/options.m4.md b/hledger/doc/options.m4.md index 74ee0eb5e..820fe6c91 100644 --- a/hledger/doc/options.m4.md +++ b/hledger/doc/options.m4.md @@ -96,32 +96,25 @@ Usually this file is in hledger's journal format, but it can also be one of several other formats. Each one is handled by a built-in "reader", as follows: -| Reader:   | Reads: | Used for file extensions: +| Reader:  | Reads: | Used for file extensions: |---------------------|-----------------------------------------------------|------------------------------------------- | `journal` | hledger's journal format, also some Ledger journals | `.journal` `.j` `.hledger` `.ledger` | `timeclock` | timeclock files (precise time logging) | `.timeclock` | `timedot` | timedot files (approximate time logging) | `.timedot` -| `CSV` | comma-separated values (data interchange) | `.csv` +| `csv` | comma-separated values (data interchange) | `.csv` -Usually hledger identifies the correct format automatically based on the file extension, -or if that does not work, by trying each format in turn. -If needed - eg to ensure correct error messages - you can force a specific format +Usually hledger detects the format automatically based on the file extension, +or if that does not work, by trying each reader in turn. +If needed, eg to ensure correct error messages, you can force a specific reader/format by prepending it to the file path with a colon. Examples: ```bash $ hledger -f csv:/some/csv-file.dat stats $ echo 'i 2009/13/1 08:00:00' | hledger print -ftimeclock:- ``` -This experimental reader is also available but not used by default: - -| Reader:   | Reads: | File extensions: -|---------------------|---------------------------------------------|------------------------------------------- -| `ledger` | Ledger's journal format (incomplete) | - - You can specify multiple `-f` options, to read multiple files as one big journal. -Directives in one file will not affect subsequent files in this case (if you need that, -use the [include directive](#including-other-files) instead). +Directives in one file will not affect the other files - if you need that, +use the [include directive](#including-other-files) instead. ## Depth limiting