From 73d3cafbae35f3817d00faf17d975f0f34a6e445 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sun, 21 Nov 2021 23:24:43 -1000 Subject: [PATCH] ;doc: update manuals --- hledger/hledger.1 | 19 ++- hledger/hledger.info | 391 ++++++++++++++++++++++--------------------- hledger/hledger.txt | 13 +- 3 files changed, 222 insertions(+), 201 deletions(-) diff --git a/hledger/hledger.1 b/hledger/hledger.1 index a7f3f6f9f..df1c57138 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -6827,6 +6827,11 @@ command line options with similar effect T} _ T{ +\f[B]READING/GENERATING DATA:\f[R] +T}@T{ +T}@T{ +T} +T{ Declaring a commodity\[aq]s or file\[aq]s decimal mark to help parse amounts accurately T}@T{ @@ -6834,7 +6839,7 @@ T}@T{ T}@T{ T} T{ -Modifying the journal file while parsing +Applying changes to the data while parsing T}@T{ \f[C]alias\f[R], \f[C]apply account\f[R], \f[C]comment\f[R], \f[C]D\f[R], \f[C]Y\f[R] @@ -6861,12 +6866,22 @@ T}@T{ T}@T{ T} T{ -Defining entities to help with error checking +\f[B]CHECKING FOR ERRORS:\f[R] +T}@T{ +T}@T{ +T} +T{ +Defining valid entities to allow stricter error checking T}@T{ \f[C]account\f[R], \f[C]commodity\f[R], \f[C]payee\f[R] T}@T{ T} T{ +\f[B]DISPLAYING REPORTS:\f[R] +T}@T{ +T}@T{ +T} +T{ Defining accounts\[aq] display order and accounting type T}@T{ \f[C]account\f[R] diff --git a/hledger/hledger.info b/hledger/hledger.info index 7399f873a..14f5b70c8 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -5865,11 +5865,12 @@ purpose directives command line options with similar effect ---------------------------------------------------------------------------- +*READING/GENERATING DATA:* Declaring a commodity's or file's 'commodity', 'D', decimal mark to help parse 'decimal-mark' amounts accurately -Modifying the journal file while 'alias', 'apply '--alias' -parsing account', +Applying changes to the data 'alias', 'apply '--alias' +while parsing account', 'comment', 'D', 'Y' Inlining or concatenating extra 'include' multiple @@ -5877,9 +5878,11 @@ data files '-f/--file''s Generating extra transactions or '~' budget goals Generating extra postings '=' -Defining entities to help with 'account', -error checking 'commodity', +*CHECKING FOR ERRORS:* +Defining valid entities to allow 'account', +stricter error checking 'commodity', 'payee' +*DISPLAYING REPORTS:* Defining accounts' display order 'account' and accounting type Defining commodity display styles 'commodity', 'D' '-c/--commodity-style' @@ -9334,196 +9337,196 @@ Node: Balance assignments and prices211022 Ref: #balance-assignments-and-prices211188 Node: Directives211412 Ref: #directives211575 -Node: Directives and multiple files216025 -Ref: #directives-and-multiple-files216221 -Node: Comment blocks216913 -Ref: #comment-blocks217090 -Node: Including other files217266 -Ref: #including-other-files217440 -Node: Default year218364 -Ref: #default-year218522 -Node: Declaring payees218929 -Ref: #declaring-payees219100 -Node: Declaring the decimal mark219346 -Ref: #declaring-the-decimal-mark219546 -Node: Declaring commodities219943 -Ref: #declaring-commodities220134 -Node: Commodity error checking222652 -Ref: #commodity-error-checking222802 -Node: Default commodity223059 -Ref: #default-commodity223239 -Node: Declaring market prices224355 -Ref: #declaring-market-prices224544 -Node: Declaring accounts225357 -Ref: #declaring-accounts225537 -Node: Account error checking226739 -Ref: #account-error-checking226905 -Node: Account comments228084 -Ref: #account-comments228268 -Node: Account subdirectives228692 -Ref: #account-subdirectives228877 -Node: Account types229190 -Ref: #account-types229364 -Node: Declaring account types230022 -Ref: #declaring-account-types230201 -Node: Auto-detected account types231255 -Ref: #auto-detected-account-types231442 -Node: Account display order233460 -Ref: #account-display-order233620 -Node: Rewriting accounts234771 -Ref: #rewriting-accounts234950 -Node: Basic aliases235707 -Ref: #basic-aliases235843 -Node: Regex aliases236587 -Ref: #regex-aliases236749 -Node: Combining aliases237468 -Ref: #combining-aliases237651 -Node: Aliases and multiple files238927 -Ref: #aliases-and-multiple-files239126 -Node: end aliases239705 -Ref: #end-aliases239852 -Node: Default parent account240001 -Ref: #default-parent-account240191 -Node: Periodic transactions241075 -Ref: #periodic-transactions241258 -Node: Periodic rule syntax243175 -Ref: #periodic-rule-syntax243375 -Node: Two spaces between period expression and description!244079 -Ref: #two-spaces-between-period-expression-and-description244392 -Node: Forecasting with periodic transactions245076 -Ref: #forecasting-with-periodic-transactions245375 -Node: Budgeting with periodic transactions248146 -Ref: #budgeting-with-periodic-transactions248379 -Node: Auto postings248788 -Ref: #auto-postings248924 -Node: Auto postings and multiple files251103 -Ref: #auto-postings-and-multiple-files251301 -Node: Auto postings and dates251510 -Ref: #auto-postings-and-dates251778 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions251953 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions252298 -Node: Auto posting tags252801 -Ref: #auto-posting-tags253010 -Node: CSV FORMAT253646 -Ref: #csv-format253774 -Node: Examples256403 -Ref: #examples256506 -Node: Basic256714 -Ref: #basic256816 -Node: Bank of Ireland257358 -Ref: #bank-of-ireland257495 -Node: Amazon258957 -Ref: #amazon259077 -Node: Paypal260796 -Ref: #paypal260892 -Node: CSV rules268536 -Ref: #csv-rules268654 -Node: skip268987 -Ref: #skip269087 -Node: fields list269462 -Ref: #fields-list269601 -Node: field assignment271104 -Ref: #field-assignment271256 -Node: Field names272291 -Ref: #field-names272431 -Node: date field272811 -Ref: #date-field272931 -Node: date2 field272979 -Ref: #date2-field273122 -Node: status field273178 -Ref: #status-field273323 -Node: code field273372 -Ref: #code-field273519 -Node: description field273564 -Ref: #description-field273726 -Node: comment field273785 -Ref: #comment-field273942 -Node: account field274242 -Ref: #account-field274394 -Node: amount field274969 -Ref: #amount-field275120 -Node: currency field276365 -Ref: #currency-field276520 -Node: balance field276777 -Ref: #balance-field276911 -Node: separator277283 -Ref: #separator277415 -Node: if block277955 -Ref: #if-block278082 -Node: Matching the whole record278483 -Ref: #matching-the-whole-record278660 -Node: Matching individual fields279463 -Ref: #matching-individual-fields279669 -Node: Combining matchers279893 -Ref: #combining-matchers280091 -Node: Rules applied on successful match280404 -Ref: #rules-applied-on-successful-match280597 -Node: if table281251 -Ref: #if-table281372 -Node: end283110 -Ref: #end283224 -Node: date-format283448 -Ref: #date-format283582 -Node: decimal-mark284578 -Ref: #decimal-mark284725 -Node: newest-first285064 -Ref: #newest-first285207 -Node: include285890 -Ref: #include286023 -Node: balance-type286467 -Ref: #balance-type286589 -Node: Tips287289 -Ref: #tips287380 -Node: Rapid feedback287679 -Ref: #rapid-feedback287798 -Node: Valid CSV288250 -Ref: #valid-csv288382 -Node: File Extension288574 -Ref: #file-extension288728 -Node: Reading multiple CSV files289157 -Ref: #reading-multiple-csv-files289344 -Node: Valid transactions289585 -Ref: #valid-transactions289765 -Node: Deduplicating importing290393 -Ref: #deduplicating-importing290574 -Node: Setting amounts291607 -Ref: #setting-amounts291764 -Node: Amount signs294205 -Ref: #amount-signs294359 -Node: Setting currency/commodity295046 -Ref: #setting-currencycommodity295234 -Node: Amount decimal places296408 -Ref: #amount-decimal-places296600 -Node: Referencing other fields296912 -Ref: #referencing-other-fields297111 -Node: How CSV rules are evaluated298008 -Ref: #how-csv-rules-are-evaluated298183 -Node: TIMECLOCK FORMAT299634 -Ref: #timeclock-format299774 -Node: TIMEDOT FORMAT301835 -Ref: #timedot-format301973 -Node: COMMON TASKS306535 -Ref: #common-tasks306664 -Node: Getting help307071 -Ref: #getting-help307205 -Node: Constructing command lines307758 -Ref: #constructing-command-lines307952 -Node: Starting a journal file308649 -Ref: #starting-a-journal-file308849 -Node: Setting opening balances310037 -Ref: #setting-opening-balances310235 -Node: Recording transactions313376 -Ref: #recording-transactions313558 -Node: Reconciling314114 -Ref: #reconciling314259 -Node: Reporting316516 -Ref: #reporting316658 -Node: Migrating to a new file320657 -Ref: #migrating-to-a-new-file320807 -Node: LIMITATIONS321106 -Ref: #limitations321234 -Node: TROUBLESHOOTING321977 -Ref: #troubleshooting322092 +Node: Directives and multiple files216097 +Ref: #directives-and-multiple-files216293 +Node: Comment blocks216985 +Ref: #comment-blocks217162 +Node: Including other files217338 +Ref: #including-other-files217512 +Node: Default year218436 +Ref: #default-year218594 +Node: Declaring payees219001 +Ref: #declaring-payees219172 +Node: Declaring the decimal mark219418 +Ref: #declaring-the-decimal-mark219618 +Node: Declaring commodities220015 +Ref: #declaring-commodities220206 +Node: Commodity error checking222724 +Ref: #commodity-error-checking222874 +Node: Default commodity223131 +Ref: #default-commodity223311 +Node: Declaring market prices224427 +Ref: #declaring-market-prices224616 +Node: Declaring accounts225429 +Ref: #declaring-accounts225609 +Node: Account error checking226811 +Ref: #account-error-checking226977 +Node: Account comments228156 +Ref: #account-comments228340 +Node: Account subdirectives228764 +Ref: #account-subdirectives228949 +Node: Account types229262 +Ref: #account-types229436 +Node: Declaring account types230094 +Ref: #declaring-account-types230273 +Node: Auto-detected account types231327 +Ref: #auto-detected-account-types231514 +Node: Account display order233532 +Ref: #account-display-order233692 +Node: Rewriting accounts234843 +Ref: #rewriting-accounts235022 +Node: Basic aliases235779 +Ref: #basic-aliases235915 +Node: Regex aliases236659 +Ref: #regex-aliases236821 +Node: Combining aliases237540 +Ref: #combining-aliases237723 +Node: Aliases and multiple files238999 +Ref: #aliases-and-multiple-files239198 +Node: end aliases239777 +Ref: #end-aliases239924 +Node: Default parent account240073 +Ref: #default-parent-account240263 +Node: Periodic transactions241147 +Ref: #periodic-transactions241330 +Node: Periodic rule syntax243247 +Ref: #periodic-rule-syntax243447 +Node: Two spaces between period expression and description!244151 +Ref: #two-spaces-between-period-expression-and-description244464 +Node: Forecasting with periodic transactions245148 +Ref: #forecasting-with-periodic-transactions245447 +Node: Budgeting with periodic transactions248218 +Ref: #budgeting-with-periodic-transactions248451 +Node: Auto postings248860 +Ref: #auto-postings248996 +Node: Auto postings and multiple files251175 +Ref: #auto-postings-and-multiple-files251373 +Node: Auto postings and dates251582 +Ref: #auto-postings-and-dates251850 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions252025 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions252370 +Node: Auto posting tags252873 +Ref: #auto-posting-tags253082 +Node: CSV FORMAT253718 +Ref: #csv-format253846 +Node: Examples256475 +Ref: #examples256578 +Node: Basic256786 +Ref: #basic256888 +Node: Bank of Ireland257430 +Ref: #bank-of-ireland257567 +Node: Amazon259029 +Ref: #amazon259149 +Node: Paypal260868 +Ref: #paypal260964 +Node: CSV rules268608 +Ref: #csv-rules268726 +Node: skip269059 +Ref: #skip269159 +Node: fields list269534 +Ref: #fields-list269673 +Node: field assignment271176 +Ref: #field-assignment271328 +Node: Field names272363 +Ref: #field-names272503 +Node: date field272883 +Ref: #date-field273003 +Node: date2 field273051 +Ref: #date2-field273194 +Node: status field273250 +Ref: #status-field273395 +Node: code field273444 +Ref: #code-field273591 +Node: description field273636 +Ref: #description-field273798 +Node: comment field273857 +Ref: #comment-field274014 +Node: account field274314 +Ref: #account-field274466 +Node: amount field275041 +Ref: #amount-field275192 +Node: currency field276437 +Ref: #currency-field276592 +Node: balance field276849 +Ref: #balance-field276983 +Node: separator277355 +Ref: #separator277487 +Node: if block278027 +Ref: #if-block278154 +Node: Matching the whole record278555 +Ref: #matching-the-whole-record278732 +Node: Matching individual fields279535 +Ref: #matching-individual-fields279741 +Node: Combining matchers279965 +Ref: #combining-matchers280163 +Node: Rules applied on successful match280476 +Ref: #rules-applied-on-successful-match280669 +Node: if table281323 +Ref: #if-table281444 +Node: end283182 +Ref: #end283296 +Node: date-format283520 +Ref: #date-format283654 +Node: decimal-mark284650 +Ref: #decimal-mark284797 +Node: newest-first285136 +Ref: #newest-first285279 +Node: include285962 +Ref: #include286095 +Node: balance-type286539 +Ref: #balance-type286661 +Node: Tips287361 +Ref: #tips287452 +Node: Rapid feedback287751 +Ref: #rapid-feedback287870 +Node: Valid CSV288322 +Ref: #valid-csv288454 +Node: File Extension288646 +Ref: #file-extension288800 +Node: Reading multiple CSV files289229 +Ref: #reading-multiple-csv-files289416 +Node: Valid transactions289657 +Ref: #valid-transactions289837 +Node: Deduplicating importing290465 +Ref: #deduplicating-importing290646 +Node: Setting amounts291679 +Ref: #setting-amounts291836 +Node: Amount signs294277 +Ref: #amount-signs294431 +Node: Setting currency/commodity295118 +Ref: #setting-currencycommodity295306 +Node: Amount decimal places296480 +Ref: #amount-decimal-places296672 +Node: Referencing other fields296984 +Ref: #referencing-other-fields297183 +Node: How CSV rules are evaluated298080 +Ref: #how-csv-rules-are-evaluated298255 +Node: TIMECLOCK FORMAT299706 +Ref: #timeclock-format299846 +Node: TIMEDOT FORMAT301907 +Ref: #timedot-format302045 +Node: COMMON TASKS306607 +Ref: #common-tasks306736 +Node: Getting help307143 +Ref: #getting-help307277 +Node: Constructing command lines307830 +Ref: #constructing-command-lines308024 +Node: Starting a journal file308721 +Ref: #starting-a-journal-file308921 +Node: Setting opening balances310109 +Ref: #setting-opening-balances310307 +Node: Recording transactions313448 +Ref: #recording-transactions313630 +Node: Reconciling314186 +Ref: #reconciling314331 +Node: Reporting316588 +Ref: #reporting316730 +Node: Migrating to a new file320729 +Ref: #migrating-to-a-new-file320879 +Node: LIMITATIONS321178 +Ref: #limitations321306 +Node: TROUBLESHOOTING322049 +Ref: #troubleshooting322164  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 305c8516c..e22b2d681 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -4918,20 +4918,23 @@ JOURNAL FORMAT options with sim- ilar effect ----------------------------------------------------------------------------- + READING/GENERATING DATA: Declaring a commodity's or file's commodity, D, deci- decimal mark to help parse mal-mark amounts accurately - Modifying the journal file while alias, apply --alias - parsing account, comment, + Applying changes to the data alias, apply --alias + while parsing account, comment, D, Y Inlining or concatenating extra include multiple data files -f/--file's Generating extra transactions or ~ budget goals - Generating extra postings = - Defining entities to help with account, commodity, - error checking payee + Generating extra postings = + CHECKING FOR ERRORS: + Defining valid entities to allow account, commodity, + stricter error checking payee + DISPLAYING REPORTS: Defining accounts' display order account and accounting type Defining commodity display styles commodity, D -c/--commodity-