diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 016b66d85..7aef36cf4 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -90,7 +90,7 @@ $ hledger help --help # show more detailed help for the help command .PP Find more docs, chat, mail list, reddit, issue tracker: https://hledger.org#help-feedback -.SS Constructing a command line +.SS Constructing command lines .PP hledger has an extensive and powerful command line interface. We strive to keep it simple and ergonomic, but you may run into one of @@ -110,7 +110,7 @@ metacharacters from the shell .IP \[bu] 2 to see how a misbehaving command is being parsed, add \f[C]--debug=2\f[R]. -.SS Starting a Journal +.SS Starting a journal file .PP hledger looks for your accounting data in a journal file, \f[C]$HOME/.hledger.journal\f[R] by default: @@ -153,7 +153,7 @@ Commodities : 0 () Market prices : 0 () \f[R] .fi -.SS Setting Opening Balances +.SS Setting opening balances .PP Pick a starting date for which you can look up the balances of some real-world assets (bank accounts, wallet..) and liabilities (credit @@ -249,7 +249,7 @@ Eg: $ git commit -m \[aq]initial balances\[aq] 2020.journal \f[R] .fi -.SS Recording Transactions +.SS Recording transactions .PP As you spend or receive money, you can record these transactions using one of the methods above (text editor, hledger add) or by using the @@ -515,12 +515,15 @@ $ hledger activity -W 2020-01-13 **** \f[R] .fi -.SS Starting a New File +.SS Migrating to a new file .PP At the end of the year, you may want to continue your journal in a new file, so that old transactions don\[aq]t slow down or clutter your reports, and to help ensure the integrity of your accounting history. See the close command. +.PP +If using version control, don\[aq]t forget to \f[C]git add\f[R] the new +file. .SH OPTIONS .SS General options .PP diff --git a/hledger/hledger.info b/hledger/hledger.info index ddbf526c6..c5f87f617 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -76,16 +76,16 @@ https://hledger.org. * Menu: * Getting help:: -* Constructing a command line:: -* Starting a Journal:: -* Setting Opening Balances:: -* Recording Transactions:: +* Constructing command lines:: +* Starting a journal file:: +* Setting opening balances:: +* Recording transactions:: * Reconciling:: * Reporting:: -* Starting a New File:: +* Migrating to a new file::  -File: hledger.info, Node: Getting help, Next: Constructing a command line, Up: COMMON TASKS +File: hledger.info, Node: Getting help, Next: Constructing command lines, Up: COMMON TASKS 1.1 Getting help ================ @@ -102,10 +102,10 @@ $ hledger help --help # show more detailed help for the help command https://hledger.org#help-feedback  -File: hledger.info, Node: Constructing a command line, Next: Starting a Journal, Prev: Getting help, Up: COMMON TASKS +File: hledger.info, Node: Constructing command lines, Next: Starting a journal file, Prev: Getting help, Up: COMMON TASKS -1.2 Constructing a command line -=============================== +1.2 Constructing command lines +============================== hledger has an extensive and powerful command line interface. We strive to keep it simple and ergonomic, but you may run into one of the @@ -122,10 +122,10 @@ happens, here are some tips that may help: * to see how a misbehaving command is being parsed, add '--debug=2'.  -File: hledger.info, Node: Starting a Journal, Next: Setting Opening Balances, Prev: Constructing a command line, Up: COMMON TASKS +File: hledger.info, Node: Starting a journal file, Next: Setting opening balances, Prev: Constructing command lines, Up: COMMON TASKS -1.3 Starting a Journal -====================== +1.3 Starting a journal file +=========================== hledger looks for your accounting data in a journal file, '$HOME/.hledger.journal' by default: @@ -161,9 +161,9 @@ Commodities : 0 () Market prices : 0 ()  -File: hledger.info, Node: Setting Opening Balances, Next: Recording Transactions, Prev: Starting a Journal, Up: COMMON TASKS +File: hledger.info, Node: Setting opening balances, Next: Recording transactions, Prev: Starting a journal file, Up: COMMON TASKS -1.4 Setting Opening Balances +1.4 Setting opening balances ============================ Pick a starting date for which you can look up the balances of some @@ -244,9 +244,9 @@ the journal. Eg: $ git commit -m 'initial balances' 2020.journal  -File: hledger.info, Node: Recording Transactions, Next: Reconciling, Prev: Setting Opening Balances, Up: COMMON TASKS +File: hledger.info, Node: Recording transactions, Next: Reconciling, Prev: Setting opening balances, Up: COMMON TASKS -1.5 Recording Transactions +1.5 Recording transactions ========================== As you spend or receive money, you can record these transactions using @@ -270,7 +270,7 @@ and hledger.org for more ideas: assets:bank:checking $1000  -File: hledger.info, Node: Reconciling, Next: Reporting, Prev: Recording Transactions, Up: COMMON TASKS +File: hledger.info, Node: Reconciling, Next: Reporting, Prev: Recording transactions, Up: COMMON TASKS 1.6 Reconciling =============== @@ -325,7 +325,7 @@ commit: $ git commit -m 'txns' 2020.journal  -File: hledger.info, Node: Reporting, Next: Starting a New File, Prev: Reconciling, Up: COMMON TASKS +File: hledger.info, Node: Reporting, Next: Migrating to a new file, Prev: Reconciling, Up: COMMON TASKS 1.7 Reporting ============= @@ -473,16 +473,18 @@ $ hledger activity -W 2020-01-13 ****  -File: hledger.info, Node: Starting a New File, Prev: Reporting, Up: COMMON TASKS +File: hledger.info, Node: Migrating to a new file, Prev: Reporting, Up: COMMON TASKS -1.8 Starting a New File -======================= +1.8 Migrating to a new file +=========================== At the end of the year, you may want to continue your journal in a new file, so that old transactions don't slow down or clutter your reports, and to help ensure the integrity of your accounting history. See the close command. + If using version control, don't forget to 'git add' the new file. +  File: hledger.info, Node: OPTIONS, Next: COMMANDS, Prev: COMMON TASKS, Up: Top @@ -3648,185 +3650,185 @@ Tag Table: Node: Top68 Node: COMMON TASKS2321 Ref: #common-tasks2433 -Node: Getting help2832 -Ref: #getting-help2965 -Node: Constructing a command line3518 -Ref: #constructing-a-command-line3708 -Node: Starting a Journal4405 -Ref: #starting-a-journal4589 -Node: Setting Opening Balances5777 -Ref: #setting-opening-balances5968 -Node: Recording Transactions9110 -Ref: #recording-transactions9290 -Node: Reconciling9846 -Ref: #reconciling9989 -Node: Reporting12246 -Ref: #reporting12382 -Node: Starting a New File16381 -Ref: #starting-a-new-file16517 -Node: OPTIONS16746 -Ref: #options16853 -Node: General options17223 -Ref: #general-options17348 -Node: Command options20047 -Ref: #command-options20198 -Node: Command arguments20596 -Ref: #command-arguments20743 -Node: Queries21623 -Ref: #queries21778 -Node: Special characters in arguments and queries25740 -Ref: #special-characters-in-arguments-and-queries25968 -Node: More escaping26419 -Ref: #more-escaping26581 -Node: Even more escaping26877 -Ref: #even-more-escaping27071 -Node: Less escaping27742 -Ref: #less-escaping27904 -Node: Unicode characters28149 -Ref: #unicode-characters28331 -Node: Input files29743 -Ref: #input-files29886 -Node: Output destination31815 -Ref: #output-destination31967 -Node: Output format32250 -Ref: #output-format32400 -Node: Regular expressions32785 -Ref: #regular-expressions32942 -Node: Smart dates34303 -Ref: #smart-dates34454 -Node: Report start & end date35860 -Ref: #report-start-end-date36032 -Node: Report intervals37456 -Ref: #report-intervals37621 -Node: Period expressions38011 -Ref: #period-expressions38171 -Node: Depth limiting42126 -Ref: #depth-limiting42270 -Node: Pivoting42612 -Ref: #pivoting42735 -Node: Valuation44411 -Ref: #valuation44513 -Node: -B Cost44693 -Ref: #b-cost44804 -Node: -V Market value45002 -Ref: #v-market-value45176 -Node: -X Market value in specified commodity46608 -Ref: #x-market-value-in-specified-commodity46847 -Node: --value Flexible valuation47023 -Ref: #value-flexible-valuation47249 -Node: Effect of --value on reports51439 -Ref: #effect-of---value-on-reports51655 -Node: Combining -B -V -X --value56586 -Ref: #combining--b--v--x---value56769 -Node: COMMANDS56805 -Ref: #commands56913 -Node: accounts57997 -Ref: #accounts58095 -Node: activity58794 -Ref: #activity58904 -Node: add59287 -Ref: #add59386 -Node: balance62125 -Ref: #balance62236 -Node: Classic balance report63694 -Ref: #classic-balance-report63867 -Node: Customising the classic balance report65236 -Ref: #customising-the-classic-balance-report65464 -Node: Colour support67540 -Ref: #colour-support67707 -Node: Flat mode67880 -Ref: #flat-mode68028 -Node: Depth limited balance reports68441 -Ref: #depth-limited-balance-reports68626 -Node: Percentages69082 -Ref: #percentages69248 -Node: Multicolumn balance report70385 -Ref: #multicolumn-balance-report70565 -Node: Budget report75879 -Ref: #budget-report76022 -Node: Nested budgets81224 -Ref: #nested-budgets81336 -Ref: #output-format-184817 -Node: balancesheet84895 -Ref: #balancesheet85031 -Node: balancesheetequity86414 -Ref: #balancesheetequity86563 -Node: cashflow87124 -Ref: #cashflow87252 -Node: check-dates88348 -Ref: #check-dates88475 -Node: check-dupes88754 -Ref: #check-dupes88878 -Node: close89171 -Ref: #close89285 -Node: close usage90807 -Ref: #close-usage90900 -Node: commodities93713 -Ref: #commodities93840 -Node: descriptions93922 -Ref: #descriptions94050 -Node: diff94231 -Ref: #diff94337 -Node: files95384 -Ref: #files95484 -Node: help95631 -Ref: #help95731 -Node: import96812 -Ref: #import96926 -Node: Importing balance assignments97819 -Ref: #importing-balance-assignments97967 -Node: incomestatement98616 -Ref: #incomestatement98749 -Node: notes100153 -Ref: #notes100266 -Node: payees100392 -Ref: #payees100498 -Node: prices100656 -Ref: #prices100762 -Node: print101103 -Ref: #print101213 -Node: print-unique105857 -Ref: #print-unique105983 -Node: register106268 -Ref: #register106395 -Node: Custom register output110567 -Ref: #custom-register-output110696 -Node: register-match111958 -Ref: #register-match112092 -Node: rewrite112443 -Ref: #rewrite112558 -Node: Re-write rules in a file114413 -Ref: #re-write-rules-in-a-file114547 -Node: Diff output format115757 -Ref: #diff-output-format115926 -Node: rewrite vs print --auto117018 -Ref: #rewrite-vs.-print---auto117197 -Node: roi117753 -Ref: #roi117851 -Node: stats118863 -Ref: #stats118962 -Node: tags119750 -Ref: #tags119848 -Node: test120142 -Ref: #test120250 -Node: Add-on Commands120997 -Ref: #add-on-commands121114 -Node: ui122457 -Ref: #ui122545 -Node: web122599 -Ref: #web122702 -Node: iadd122818 -Ref: #iadd122929 -Node: interest123011 -Ref: #interest123118 -Node: ENVIRONMENT123358 -Ref: #environment123470 -Node: FILES124299 -Ref: #files-1124402 -Node: LIMITATIONS124615 -Ref: #limitations124734 -Node: TROUBLESHOOTING125476 -Ref: #troubleshooting125589 +Node: Getting help2840 +Ref: #getting-help2972 +Node: Constructing command lines3525 +Ref: #constructing-command-lines3717 +Node: Starting a journal file4414 +Ref: #starting-a-journal-file4612 +Node: Setting opening balances5800 +Ref: #setting-opening-balances5996 +Node: Recording transactions9138 +Ref: #recording-transactions9318 +Node: Reconciling9874 +Ref: #reconciling10017 +Node: Reporting12274 +Ref: #reporting12414 +Node: Migrating to a new file16413 +Ref: #migrating-to-a-new-file16561 +Node: OPTIONS16860 +Ref: #options16967 +Node: General options17337 +Ref: #general-options17462 +Node: Command options20161 +Ref: #command-options20312 +Node: Command arguments20710 +Ref: #command-arguments20857 +Node: Queries21737 +Ref: #queries21892 +Node: Special characters in arguments and queries25854 +Ref: #special-characters-in-arguments-and-queries26082 +Node: More escaping26533 +Ref: #more-escaping26695 +Node: Even more escaping26991 +Ref: #even-more-escaping27185 +Node: Less escaping27856 +Ref: #less-escaping28018 +Node: Unicode characters28263 +Ref: #unicode-characters28445 +Node: Input files29857 +Ref: #input-files30000 +Node: Output destination31929 +Ref: #output-destination32081 +Node: Output format32364 +Ref: #output-format32514 +Node: Regular expressions32899 +Ref: #regular-expressions33056 +Node: Smart dates34417 +Ref: #smart-dates34568 +Node: Report start & end date35974 +Ref: #report-start-end-date36146 +Node: Report intervals37570 +Ref: #report-intervals37735 +Node: Period expressions38125 +Ref: #period-expressions38285 +Node: Depth limiting42240 +Ref: #depth-limiting42384 +Node: Pivoting42726 +Ref: #pivoting42849 +Node: Valuation44525 +Ref: #valuation44627 +Node: -B Cost44807 +Ref: #b-cost44918 +Node: -V Market value45116 +Ref: #v-market-value45290 +Node: -X Market value in specified commodity46722 +Ref: #x-market-value-in-specified-commodity46961 +Node: --value Flexible valuation47137 +Ref: #value-flexible-valuation47363 +Node: Effect of --value on reports51553 +Ref: #effect-of---value-on-reports51769 +Node: Combining -B -V -X --value56700 +Ref: #combining--b--v--x---value56883 +Node: COMMANDS56919 +Ref: #commands57027 +Node: accounts58111 +Ref: #accounts58209 +Node: activity58908 +Ref: #activity59018 +Node: add59401 +Ref: #add59500 +Node: balance62239 +Ref: #balance62350 +Node: Classic balance report63808 +Ref: #classic-balance-report63981 +Node: Customising the classic balance report65350 +Ref: #customising-the-classic-balance-report65578 +Node: Colour support67654 +Ref: #colour-support67821 +Node: Flat mode67994 +Ref: #flat-mode68142 +Node: Depth limited balance reports68555 +Ref: #depth-limited-balance-reports68740 +Node: Percentages69196 +Ref: #percentages69362 +Node: Multicolumn balance report70499 +Ref: #multicolumn-balance-report70679 +Node: Budget report75993 +Ref: #budget-report76136 +Node: Nested budgets81338 +Ref: #nested-budgets81450 +Ref: #output-format-184931 +Node: balancesheet85009 +Ref: #balancesheet85145 +Node: balancesheetequity86528 +Ref: #balancesheetequity86677 +Node: cashflow87238 +Ref: #cashflow87366 +Node: check-dates88462 +Ref: #check-dates88589 +Node: check-dupes88868 +Ref: #check-dupes88992 +Node: close89285 +Ref: #close89399 +Node: close usage90921 +Ref: #close-usage91014 +Node: commodities93827 +Ref: #commodities93954 +Node: descriptions94036 +Ref: #descriptions94164 +Node: diff94345 +Ref: #diff94451 +Node: files95498 +Ref: #files95598 +Node: help95745 +Ref: #help95845 +Node: import96926 +Ref: #import97040 +Node: Importing balance assignments97933 +Ref: #importing-balance-assignments98081 +Node: incomestatement98730 +Ref: #incomestatement98863 +Node: notes100267 +Ref: #notes100380 +Node: payees100506 +Ref: #payees100612 +Node: prices100770 +Ref: #prices100876 +Node: print101217 +Ref: #print101327 +Node: print-unique105971 +Ref: #print-unique106097 +Node: register106382 +Ref: #register106509 +Node: Custom register output110681 +Ref: #custom-register-output110810 +Node: register-match112072 +Ref: #register-match112206 +Node: rewrite112557 +Ref: #rewrite112672 +Node: Re-write rules in a file114527 +Ref: #re-write-rules-in-a-file114661 +Node: Diff output format115871 +Ref: #diff-output-format116040 +Node: rewrite vs print --auto117132 +Ref: #rewrite-vs.-print---auto117311 +Node: roi117867 +Ref: #roi117965 +Node: stats118977 +Ref: #stats119076 +Node: tags119864 +Ref: #tags119962 +Node: test120256 +Ref: #test120364 +Node: Add-on Commands121111 +Ref: #add-on-commands121228 +Node: ui122571 +Ref: #ui122659 +Node: web122713 +Ref: #web122816 +Node: iadd122932 +Ref: #iadd123043 +Node: interest123125 +Ref: #interest123232 +Node: ENVIRONMENT123472 +Ref: #environment123584 +Node: FILES124413 +Ref: #files-1124516 +Node: LIMITATIONS124729 +Ref: #limitations124848 +Node: TROUBLESHOOTING125590 +Ref: #troubleshooting125703  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 3bf2a8435..f86c194f1 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -70,7 +70,7 @@ COMMON TASKS Find more docs, chat, mail list, reddit, issue tracker: https://hledger.org#help-feedback - Constructing a command line + Constructing command lines hledger has an extensive and powerful command line interface. We strive to keep it simple and ergonomic, but you may run into one of the confusing real world details described in OPTIONS, below. If that hap- @@ -89,7 +89,7 @@ COMMON TASKS o to see how a misbehaving command is being parsed, add --debug=2. - Starting a Journal + Starting a journal file hledger looks for your accounting data in a journal file, $HOME/.hledger.journal by default: @@ -123,7 +123,7 @@ COMMON TASKS Commodities : 0 () Market prices : 0 () - Setting Opening Balances + Setting opening balances Pick a starting date for which you can look up the balances of some real-world assets (bank accounts, wallet..) and liabilities (credit cards..). @@ -201,7 +201,7 @@ COMMON TASKS $ git commit -m 'initial balances' 2020.journal - Recording Transactions + Recording transactions As you spend or receive money, you can record these transactions using one of the methods above (text editor, hledger add) or by using the hledger-iadd or hledger-web add-ons, or by using the import command to @@ -415,12 +415,14 @@ COMMON TASKS 2020-01-06 **** 2020-01-13 **** - Starting a New File + Migrating to a new file At the end of the year, you may want to continue your journal in a new file, so that old transactions don't slow down or clutter your reports, and to help ensure the integrity of your accounting history. See the close command. + If using version control, don't forget to git add the new file. + OPTIONS General options To see general usage help, including general options which are sup- @@ -804,8 +806,6 @@ OPTIONS clock logging) timedot timedot files (approximate time .timedot logging) - - csv comma-separated values (data .csv interchange) @@ -995,6 +995,7 @@ OPTIONS "-". These are equivalent to the above: -p "2009/1/1 2009/4/1" + -p2009/1/1to2009/4/1 -p2009/1/1-2009/4/1 @@ -1087,8 +1088,6 @@ OPTIONS -p "every Tue" -- same -p "every 15th day" -- period bound- aries will be on 15th of each month - - -p "every 2nd Monday" -- period bound- aries will be on second Monday of each month @@ -1404,6 +1403,9 @@ OPTIONS ance (with -H) before report before report DATE/today or journal or journal start start + + + posting cost value at report value at report value at amounts (no end or today or journal end DATE/today report inter- @@ -1441,9 +1443,6 @@ OPTIONS val) column totals sums of dis- sums of dis- sums of dis- sums of dis- played values played values played values played values - - - grand to- sum/average of sum/average of sum/average of sum/average tal/average column totals column totals column totals of column to- tals