;help/manuals

This commit is contained in:
Simon Michael 2020-07-14 12:09:54 -07:00
parent 403cb457b7
commit 031f72ac4b
4 changed files with 411 additions and 409 deletions

View File

@ -129,10 +129,8 @@ Some example formats:
Colour support Colour support
The balance command shows negative amounts in red, if: In terminal output, when colour is enabled, the balance command shows
negative amounts in red.
- the TERM environment variable is not set to dumb
- the output is not being redirected or piped anywhere
Flat mode Flat mode
@ -303,7 +301,7 @@ multicommodity reports.
When the report is still too wide, a good workaround is to pipe it into When the report is still too wide, a good workaround is to pipe it into
less -RS (-R for colour, -S to chop long lines). Eg: less -RS (-R for colour, -S to chop long lines). Eg:
hledger bal -D | less -RS. hledger bal -D --color=yes | less -RS.
Budget report Budget report

View File

@ -2750,11 +2750,8 @@ rendered on one line
for the single-column balance report for the single-column balance report
.SS Colour support .SS Colour support
.PP .PP
The balance command shows negative amounts in red, if: In terminal output, when colour is enabled, the balance command shows
.IP \[bu] 2 negative amounts in red.
the \f[C]TERM\f[R] environment variable is not set to \f[C]dumb\f[R]
.IP \[bu] 2
the output is not being redirected or piped anywhere
.SS Flat mode .SS Flat mode
.PP .PP
To see a flat list instead of the default hierarchical display, use To see a flat list instead of the default hierarchical display, use
@ -2966,7 +2963,7 @@ the width of multicommodity reports.
.PP .PP
When the report is still too wide, a good workaround is to pipe it into When the report is still too wide, a good workaround is to pipe it into
\f[C]less -RS\f[R] (-R for colour, -S to chop long lines). \f[C]less -RS\f[R] (-R for colour, -S to chop long lines).
Eg: \f[C]hledger bal -D | less -RS\f[R]. Eg: \f[C]hledger bal -D --color=yes | less -RS\f[R].
.SS Budget report .SS Budget report
.PP .PP
With \f[C]--budget\f[R], extra columns are displayed showing budget With \f[C]--budget\f[R], extra columns are displayed showing budget
@ -4507,9 +4504,6 @@ bin/ directory.
These are typically prototypes and not guaranteed to work. These are typically prototypes and not guaranteed to work.
.SH ENVIRONMENT .SH ENVIRONMENT
.PP .PP
\f[B]COLUMNS\f[R] The screen width used by the register command.
Default: the full terminal width.
.PP
\f[B]LEDGER_FILE\f[R] The journal file path when not specified with \f[B]LEDGER_FILE\f[R] The journal file path when not specified with
\f[C]-f\f[R]. \f[C]-f\f[R].
Default: \f[C]\[ti]/.hledger.journal\f[R] (on windows, perhaps Default: \f[C]\[ti]/.hledger.journal\f[R] (on windows, perhaps
@ -4535,6 +4529,13 @@ file containing
.fi .fi
.PP .PP
To see the effect you may need to \f[C]killall Dock\f[R], or reboot. To see the effect you may need to \f[C]killall Dock\f[R], or reboot.
.PP
\f[B]COLUMNS\f[R] The screen width used by the register command.
Default: the full terminal width.
.PP
\f[B]NO_COLOR\f[R] If this variable exists with any value, hledger will
not use ANSI color codes in terminal output.
This overrides the --color/--colour option.
.SH FILES .SH FILES
.PP .PP
Reads data from one or more files in hledger journal, timeclock, Reads data from one or more files in hledger journal, timeclock,

View File

@ -2283,10 +2283,8 @@ File: hledger.info, Node: Colour support, Next: Flat mode, Prev: Customising
3.5.3 Colour support 3.5.3 Colour support
-------------------- --------------------
The balance command shows negative amounts in red, if: In terminal output, when colour is enabled, the balance command shows
negative amounts in red.
* the 'TERM' environment variable is not set to 'dumb'
* the output is not being redirected or piped anywhere
 
File: hledger.info, Node: Flat mode, Next: Depth limited balance reports, Prev: Colour support, Up: balance File: hledger.info, Node: Flat mode, Next: Depth limited balance reports, Prev: Colour support, Up: balance
@ -2474,7 +2472,7 @@ width of multicommodity reports.
When the report is still too wide, a good workaround is to pipe it When the report is still too wide, a good workaround is to pipe it
into 'less -RS' (-R for colour, -S to chop long lines). Eg: 'hledger into 'less -RS' (-R for colour, -S to chop long lines). Eg: 'hledger
bal -D | less -RS'. bal -D --color=yes | less -RS'.
 
File: hledger.info, Node: Budget report, Next: , Prev: Multicolumn balance report, Up: balance File: hledger.info, Node: Budget report, Next: , Prev: Multicolumn balance report, Up: balance
@ -3885,9 +3883,6 @@ File: hledger.info, Node: ENVIRONMENT, Next: FILES, Prev: COMMANDS, Up: Top
4 ENVIRONMENT 4 ENVIRONMENT
************* *************
*COLUMNS* The screen width used by the register command. Default: the
full terminal width.
*LEDGER_FILE* The journal file path when not specified with '-f'. *LEDGER_FILE* The journal file path when not specified with '-f'.
Default: '~/.hledger.journal' (on windows, perhaps Default: '~/.hledger.journal' (on windows, perhaps
'C:/Users/USER/.hledger.journal'). 'C:/Users/USER/.hledger.journal').
@ -3908,6 +3903,13 @@ a more thorough way that also affects applications started from the GUI
To see the effect you may need to 'killall Dock', or reboot. To see the effect you may need to 'killall Dock', or reboot.
*COLUMNS* The screen width used by the register command. Default:
the full terminal width.
*NO_COLOR* If this variable exists with any value, hledger will not
use ANSI color codes in terminal output. This overrides the
-color/-colour option.
 
File: hledger.info, Node: FILES, Next: LIMITATIONS, Prev: ENVIRONMENT, Up: Top File: hledger.info, Node: FILES, Next: LIMITATIONS, Prev: ENVIRONMENT, Up: Top
@ -4126,101 +4128,101 @@ Node: Customising the classic balance report75687
Ref: #customising-the-classic-balance-report75915 Ref: #customising-the-classic-balance-report75915
Node: Colour support77991 Node: Colour support77991
Ref: #colour-support78158 Ref: #colour-support78158
Node: Flat mode78331 Node: Flat mode78254
Ref: #flat-mode78479 Ref: #flat-mode78402
Node: Depth limited balance reports78892 Node: Depth limited balance reports78815
Ref: #depth-limited-balance-reports79077 Ref: #depth-limited-balance-reports79000
Node: Percentages79533 Node: Percentages79456
Ref: #percentages79699 Ref: #percentages79622
Node: Multicolumn balance report80836 Node: Multicolumn balance report80759
Ref: #multicolumn-balance-report81016 Ref: #multicolumn-balance-report80939
Node: Budget report86601 Node: Budget report86536
Ref: #budget-report86744 Ref: #budget-report86679
Node: Nested budgets92010 Node: Nested budgets91945
Ref: #nested-budgets92122 Ref: #nested-budgets92057
Ref: #output-format-295603 Ref: #output-format-295538
Node: balancesheet95800 Node: balancesheet95735
Ref: #balancesheet95936 Ref: #balancesheet95871
Node: balancesheetequity97402 Node: balancesheetequity97337
Ref: #balancesheetequity97551 Ref: #balancesheetequity97486
Node: cashflow98274 Node: cashflow98209
Ref: #cashflow98402 Ref: #cashflow98337
Node: check-dates99581 Node: check-dates99516
Ref: #check-dates99708 Ref: #check-dates99643
Node: check-dupes99987 Node: check-dupes99922
Ref: #check-dupes100113 Ref: #check-dupes100048
Node: close100406 Node: close100341
Ref: #close100514 Ref: #close100449
Node: close usage102036 Node: close usage101971
Ref: #close-usage102129 Ref: #close-usage102064
Node: codes104942 Node: codes104877
Ref: #codes105050 Ref: #codes104985
Node: commodities105762 Node: commodities105697
Ref: #commodities105889 Ref: #commodities105824
Node: descriptions105971 Node: descriptions105906
Ref: #descriptions106099 Ref: #descriptions106034
Node: diff106403 Node: diff106338
Ref: #diff106509 Ref: #diff106444
Node: files107556 Node: files107491
Ref: #files107656 Ref: #files107591
Node: help107803 Node: help107738
Ref: #help107903 Ref: #help107838
Node: import108984 Node: import108919
Ref: #import109098 Ref: #import109033
Node: Importing balance assignments109991 Node: Importing balance assignments109926
Ref: #importing-balance-assignments110139 Ref: #importing-balance-assignments110074
Node: incomestatement110788 Node: incomestatement110723
Ref: #incomestatement110921 Ref: #incomestatement110856
Node: notes112408 Node: notes112343
Ref: #notes112521 Ref: #notes112456
Node: payees112889 Node: payees112824
Ref: #payees112995 Ref: #payees112930
Node: prices113415 Node: prices113350
Ref: #prices113521 Ref: #prices113456
Node: print113862 Node: print113797
Ref: #print113972 Ref: #print113907
Node: print-unique118768 Node: print-unique118703
Ref: #print-unique118894 Ref: #print-unique118829
Node: register119179 Node: register119114
Ref: #register119306 Ref: #register119241
Node: Custom register output123478 Node: Custom register output123413
Ref: #custom-register-output123607 Ref: #custom-register-output123542
Node: register-match124944 Node: register-match124879
Ref: #register-match125078 Ref: #register-match125013
Node: rewrite125429 Node: rewrite125364
Ref: #rewrite125544 Ref: #rewrite125479
Node: Re-write rules in a file127399 Node: Re-write rules in a file127334
Ref: #re-write-rules-in-a-file127533 Ref: #re-write-rules-in-a-file127468
Node: Diff output format128743 Node: Diff output format128678
Ref: #diff-output-format128912 Ref: #diff-output-format128847
Node: rewrite vs print --auto130004 Node: rewrite vs print --auto129939
Ref: #rewrite-vs.-print---auto130183 Ref: #rewrite-vs.-print---auto130118
Node: roi130739 Node: roi130674
Ref: #roi130837 Ref: #roi130772
Node: stats131849 Node: stats131784
Ref: #stats131948 Ref: #stats131883
Node: tags132736 Node: tags132671
Ref: #tags132834 Ref: #tags132769
Node: test133353 Node: test133288
Ref: #test133461 Ref: #test133396
Node: Add-on commands134208 Node: Add-on commands134143
Ref: #add-on-commands134325 Ref: #add-on-commands134260
Node: ui135668 Node: ui135603
Ref: #ui135756 Ref: #ui135691
Node: web135810 Node: web135745
Ref: #web135913 Ref: #web135848
Node: iadd136029 Node: iadd135964
Ref: #iadd136140 Ref: #iadd136075
Node: interest136222 Node: interest136157
Ref: #interest136329 Ref: #interest136264
Node: ENVIRONMENT136569 Node: ENVIRONMENT136504
Ref: #environment136681 Ref: #environment136616
Node: FILES137510 Node: FILES137601
Ref: #files-1137613 Ref: #files-1137704
Node: LIMITATIONS137826 Node: LIMITATIONS137917
Ref: #limitations137945 Ref: #limitations138036
Node: TROUBLESHOOTING138687 Node: TROUBLESHOOTING138778
Ref: #troubleshooting138800 Ref: #troubleshooting138891
 
End Tag Table End Tag Table

View File

@ -1935,11 +1935,8 @@ COMMANDS
single-column balance report single-column balance report
Colour support Colour support
The balance command shows negative amounts in red, if: In terminal output, when colour is enabled, the balance command shows
negative amounts in red.
o the TERM environment variable is not set to dumb
o the output is not being redirected or piped anywhere
Flat mode Flat mode
To see a flat list instead of the default hierarchical display, use To see a flat list instead of the default hierarchical display, use
@ -2106,8 +2103,8 @@ COMMANDS
of multicommodity reports. of multicommodity reports.
When the report is still too wide, a good workaround is to pipe it into When the report is still too wide, a good workaround is to pipe it into
less -RS (-R for colour, -S to chop long lines). Eg: hledger bal -D | less -RS (-R for colour, -S to chop long lines). Eg: hledger bal -D
less -RS. --color=yes | less -RS.
Budget report Budget report
With --budget, extra columns are displayed showing budget goals for With --budget, extra columns are displayed showing budget goals for
@ -3280,9 +3277,6 @@ COMMANDS
directory. These are typically prototypes and not guaranteed to work. directory. These are typically prototypes and not guaranteed to work.
ENVIRONMENT ENVIRONMENT
COLUMNS The screen width used by the register command. Default: the
full terminal width.
LEDGER_FILE The journal file path when not specified with -f. Default: LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal). nal).
@ -3302,6 +3296,13 @@ ENVIRONMENT
To see the effect you may need to killall Dock, or reboot. To see the effect you may need to killall Dock, or reboot.
COLUMNS The screen width used by the register command. Default: the
full terminal width.
NO_COLOR If this variable exists with any value, hledger will not use
ANSI color codes in terminal output. This overrides the
--color/--colour option.
FILES FILES
Reads data from one or more files in hledger journal, timeclock, time- Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or dot, or CSV format specified with -f, or $LEDGER_FILE, or