simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-11-08 07:09:28 +03:00
Code Issues Projects Releases Wiki Activity

imp: doc: directives ends-at-file-end column

Browse Source
This commit is contained in:
Simon Michael 2021-11-21 22:56:28 -10:00
parent c7cc1caca0
commit 6225db6b36
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
hledger/hledger.m4.md
View File

@ -2489,21 +2489,21 @@ Here are all the directives and their precise effects, with links to more detail
<!-- h1,h2,h3,h4,h5,h6 { color:red; } -->
<!-- </style> -->
| directive | effects |
|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[`account`]** | Declare an account, for [checking](#check) all entries in all files;<br>and its [display order](#account-display-order) and [type](#declaring-account-types), for reports.<br>Subdirectives: any text, ignored. |
| **[`alias`]** | Rewrites account names, in following entries until end of current file or [`end aliases`]. |
| **[`apply account`]** | Prepends a common parent account to all account names, in following entries until end of current file or [`end apply account`]. |
| **[`comment`]** | Ignores part of the journal file, until end of current file or [`end comment`]. |
| **[`commodity`]** | Declares a commodity, for checking all entries in all files;<br>the decimal mark for parsing amounts of this commodity, for following entries until end of current file;<br>and its display style, for reports. Takes precedence over `D`.<br>Subdirectives: [`format`] (alternate syntax). |
| **[`D`]** | Sets a default commodity to use for no-symbol amounts,<br>and its decimal mark for parsing amounts of this commodity in following entries until end of current file;<br>and its display style, for reports. |
| **[`decimal-mark`]** | Declares the decimal mark, for parsing amounts of all commodities in following entries until next `decimal-mark` or end of current file. Included files can override. Takes precedence over `commodity` and `D`. |
| **[`include`]** | Includes entries and directives from another file, as if they were written inline. |
| **[`payee`]** | Declares a payee name, for checking all entries in all files. |
| **[`P`]** | Declares a market price for a commodity on some date, for [valuation](#valuation) reports. |
| **[`Y`]** | Declares a year for yearless dates, for following entries until end of current file. |
| **[`~`]** (tilde) | Declares a periodic transaction rule that generates future transactions with `--forecast` and budget goals with `balance --budget`. |
| **[`=`]** (equals) | Declares an auto posting rule that generates extra postings on matched transactions with `--auto`, in current, parent, and child files (but not sibling files, see [#1212](https://github.com/simonmichael/hledger/issues/1212)). |
| directive | effects | ends at file end? |
|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
| **[`account`]** | Declare an account, for [checking](#check) all entries in all files; <br>and its [display order](#account-display-order) and [type](#declaring-account-types), for reports. <br>Subdirectives: any text, ignored. | |
| **[`alias`]** | Rewrites account names, in following entries until end of current file or [`end aliases`]. | Y |
| **[`apply account`]** | Prepends a common parent account to all account names, in following entries until end of current file or [`end apply account`]. | Y |
| **[`comment`]** | Ignores part of the journal file, until end of current file or [`end comment`]. | Y |
| **[`commodity`]** | Declares a commodity, for checking all entries in all files; <br>the decimal mark for parsing amounts of this commodity, for following entries until end of current file; <br>and its display style, for reports. Takes precedence over `D`. <br>Subdirectives: [`format`] (alternate syntax). | N, <br>Y<br><br> |
| **[`D`]** | Sets a default commodity to use for no-symbol amounts, <br>and its decimal mark for parsing amounts of this commodity in following entries until end of current file; <br>and its display style, for reports. | Y |
| **[`decimal-mark`]** | Declares the decimal mark, for parsing amounts of all commodities in following entries until next `decimal-mark` or end of current file. Included files can override. Takes precedence over `commodity` and `D`. | Y |
| **[`include`]** | Includes entries and directives from another file, as if they were written inline. | |
| **[`payee`]** | Declares a payee name, for checking all entries in all files. | |
| **[`P`]** | Declares a market price for a commodity on some date, for [valuation](#valuation) reports. | |
| **[`Y`]** | Declares a year for yearless dates, for following entries until end of current file. | Y |
| **[`~`]** (tilde) | Declares a periodic transaction rule that generates future transactions with `--forecast` and budget goals with `balance --budget`. | |
| **[`=`]** (equals) | Declares an auto posting rule that generates extra postings on matched transactions with `--auto`, in current, parent, and child files (but not sibling files, see [#1212](https://github.com/simonmichael/hledger/issues/1212)). | partly |
And here is an overview of which directives are useful for what:
@ -2516,7 +2516,7 @@ And here is an overview of which directives are useful for what:
| Generating extra postings | `=` | |
| Defining entities to help with error checking | `account`, `commodity`, `payee` | |
| Defining accounts' display order and accounting type | `account` | |
| Defining commodity display styles for output | `commodity`, `D` | `-c/--commodity-style` |
| Defining commodity display styles | `commodity`, `D` | `-c/--commodity-style` |
[`account`]: #declaring-accounts
[`alias`]: #rewriting-accounts