;doc: update manuals
This commit is contained in:
		
							parent
							
								
									43d935efda
								
							
						
					
					
						commit
						e532b7be49
					
				| @ -521,19 +521,29 @@ Default: the full terminal width. | ||||
| .PP | ||||
| \f[B]LEDGER_FILE\f[R] The journal file path when not specified with | ||||
| \f[C]-f\f[R]. | ||||
| Default: \f[C]\[ti]/.hledger.journal\f[R] (on windows, perhaps | ||||
| \f[C]C:/Users/USER/.hledger.journal\f[R]). | ||||
| .PP | ||||
| A typical value is \f[C]\[ti]/DIR/YYYY.journal\f[R], where DIR is a | ||||
| On unix computers, the default value is: | ||||
| \f[C]\[ti]/.hledger.journal\f[R]. | ||||
| .PP | ||||
| A more typical value is something like | ||||
| \f[C]\[ti]/finance/YYYY.journal\f[R], where \f[C]\[ti]/finance\f[R] is a | ||||
| version-controlled finance directory and YYYY is the current year. | ||||
| Or \f[C]\[ti]/DIR/current.journal\f[R], where current.journal is a | ||||
| Or, \f[C]\[ti]/finance/current.journal\f[R], where current.journal is a | ||||
| symbolic link to YYYY.journal. | ||||
| .PP | ||||
| On Mac computers, you can set this and other environment variables in a | ||||
| more thorough way that also affects applications started from the GUI | ||||
| (say, an Emacs dock icon). | ||||
| Eg on MacOS Catalina I have a \f[C]\[ti]/.MacOSX/environment.plist\f[R] | ||||
| file containing | ||||
| The usual way to set this permanently is to add a command to one of your | ||||
| shell\[aq]s startup files (eg \f[C]\[ti]/.profile\f[R]): | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| export LEDGER_FILE=\[ti]/finance/current.journal\[ga] | ||||
| \f[R] | ||||
| .fi | ||||
| .PP | ||||
| On some Mac computers, there is a more thorough way to set environment | ||||
| variables, that will also affect applications started from the GUI (eg, | ||||
| Emacs started from a dock icon): In | ||||
| \f[C]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| @ -543,7 +553,22 @@ file containing | ||||
| \f[R] | ||||
| .fi | ||||
| .PP | ||||
| To see the effect you may need to \f[C]killall Dock\f[R], or reboot. | ||||
| For this to take effect you might need to \f[C]killall Dock\f[R], or | ||||
| reboot. | ||||
| .PP | ||||
| On Windows computers, the default value is probably | ||||
| \f[C]C:\[rs]Users\[rs]MyUserName\[rs].hledger.journal\f[R]. | ||||
| You can change this by running a command like this in a powershell | ||||
| window: | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| > setx LEDGER_FILE \[dq]C:\[rs]Users\[rs]MyUserName\[rs]finance\[rs]2021.journal\[dq] | ||||
| \f[R] | ||||
| .fi | ||||
| .PP | ||||
| (Let us know if you need to be an Administrator, and if this persists | ||||
| across a reboot.) | ||||
| .SH FILES | ||||
| .PP | ||||
| Reads data from one or more files in hledger journal, timeclock, | ||||
|  | ||||
| @ -564,24 +564,38 @@ File: hledger-ui.info,  Node: ENVIRONMENT,  Next: FILES,  Prev: TIPS,  Up: Top | ||||
| *COLUMNS* The screen width to use.  Default: the full terminal width. | ||||
| 
 | ||||
|    *LEDGER_FILE* The journal file path when not specified with '-f'. | ||||
| Default: '~/.hledger.journal' (on windows, perhaps | ||||
| 'C:/Users/USER/.hledger.journal'). | ||||
| 
 | ||||
|    A typical value is '~/DIR/YYYY.journal', where DIR is a | ||||
| version-controlled finance directory and YYYY is the current year.  Or | ||||
| '~/DIR/current.journal', where current.journal is a symbolic link to | ||||
| YYYY.journal. | ||||
|    On unix computers, the default value is: '~/.hledger.journal'. | ||||
| 
 | ||||
|    On Mac computers, you can set this and other environment variables in | ||||
| a more thorough way that also affects applications started from the GUI | ||||
| (say, an Emacs dock icon).  Eg on MacOS Catalina I have a | ||||
| '~/.MacOSX/environment.plist' file containing | ||||
|    A more typical value is something like '~/finance/YYYY.journal', | ||||
| where '~/finance' is a version-controlled finance directory and YYYY is | ||||
| the current year.  Or, '~/finance/current.journal', where | ||||
| current.journal is a symbolic link to YYYY.journal. | ||||
| 
 | ||||
|    The usual way to set this permanently is to add a command to one of | ||||
| your shell's startup files (eg '~/.profile'): | ||||
| 
 | ||||
| export LEDGER_FILE=~/finance/current.journal` | ||||
| 
 | ||||
|    On some Mac computers, there is a more thorough way to set | ||||
| environment variables, that will also affect applications started from | ||||
| the GUI (eg, Emacs started from a dock icon): In | ||||
| '~/.MacOSX/environment.plist', add an entry like: | ||||
| 
 | ||||
| { | ||||
|   "LEDGER_FILE" : "~/finance/current.journal" | ||||
| } | ||||
| 
 | ||||
|    To see the effect you may need to 'killall Dock', or reboot. | ||||
|    For this to take effect you might need to 'killall Dock', or reboot. | ||||
| 
 | ||||
|    On Windows computers, the default value is probably | ||||
| 'C:\Users\MyUserName\.hledger.journal'.  You can change this by running | ||||
| a command like this in a powershell window: | ||||
| 
 | ||||
| > setx LEDGER_FILE "C:\Users\MyUserName\finance\2021.journal" | ||||
| 
 | ||||
|    (Let us know if you need to be an Administrator, and if this persists | ||||
| across a reboot.) | ||||
| 
 | ||||
|  | ||||
| File: hledger-ui.info,  Node: FILES,  Next: BUGS,  Prev: ENVIRONMENT,  Up: Top | ||||
| @ -649,10 +663,10 @@ Node: Watch mode limitations18399 | ||||
| Ref: #watch-mode-limitations18540 | ||||
| Node: ENVIRONMENT19676 | ||||
| Ref: #environment19787 | ||||
| Node: FILES20594 | ||||
| Ref: #files20693 | ||||
| Node: BUGS20906 | ||||
| Ref: #bugs20983 | ||||
| Node: FILES21095 | ||||
| Ref: #files21194 | ||||
| Node: BUGS21407 | ||||
| Ref: #bugs21484 | ||||
|  | ||||
| End Tag Table | ||||
| 
 | ||||
|  | ||||
| @ -464,24 +464,39 @@ TIPS | ||||
| ENVIRONMENT | ||||
|        COLUMNS The screen width to use.  Default: the full terminal width. | ||||
| 
 | ||||
|        LEDGER_FILE The journal file path when not specified with -f.  Default: | ||||
|        ~/.hledger.journal (on  windows,  perhaps  C:/Users/USER/.hledger.jour- | ||||
|        nal). | ||||
|        LEDGER_FILE The journal file path when not specified with -f. | ||||
| 
 | ||||
|        A  typical  value  is  ~/DIR/YYYY.journal,  where DIR is a version-con- | ||||
|        trolled finance directory and YYYY is the current year.  Or  ~/DIR/cur- | ||||
|        rent.journal, where current.journal is a symbolic link to YYYY.journal. | ||||
|        On unix computers, the default value is: ~/.hledger.journal. | ||||
| 
 | ||||
|        On Mac computers, you can set this and other environment variables in a | ||||
|        more  thorough  way that also affects applications started from the GUI | ||||
|        (say,  an  Emacs  dock  icon).   Eg  on  MacOS  Catalina   I   have   a | ||||
|        ~/.MacOSX/environment.plist file containing | ||||
|        A  more  typical  value is something like ~/finance/YYYY.journal, where | ||||
|        ~/finance is a version-controlled finance directory  and  YYYY  is  the | ||||
|        current  year.  Or, ~/finance/current.journal, where current.journal is | ||||
|        a symbolic link to YYYY.journal. | ||||
| 
 | ||||
|        The usual way to set this permanently is to add a  command  to  one  of | ||||
|        your shell's startup files (eg ~/.profile): | ||||
| 
 | ||||
|               export LEDGER_FILE=~/finance/current.journal` | ||||
| 
 | ||||
|        On  some Mac computers, there is a more thorough way to set environment | ||||
|        variables, that will also affect applications started from the GUI (eg, | ||||
|        Emacs started from a dock icon): In ~/.MacOSX/environment.plist, add an | ||||
|        entry like: | ||||
| 
 | ||||
|               { | ||||
|                 "LEDGER_FILE" : "~/finance/current.journal" | ||||
|               } | ||||
| 
 | ||||
|        To see the effect you may need to killall Dock, or reboot. | ||||
|        For this to take effect you might need to killall Dock, or reboot. | ||||
| 
 | ||||
|        On Windows computers, the default value  is  probably  C:\Users\MyUser- | ||||
|        Name\.hledger.journal.   You  can change this by running a command like | ||||
|        this in a powershell window: | ||||
| 
 | ||||
|               > setx LEDGER_FILE "C:\Users\MyUserName\finance\2021.journal" | ||||
| 
 | ||||
|        (Let us know if you need to be an Administrator, and if  this  persists | ||||
|        across a reboot.) | ||||
| 
 | ||||
| FILES | ||||
|        Reads  data from one or more files in hledger journal, timeclock, time- | ||||
|  | ||||
| @ -579,19 +579,29 @@ $ curl http://127.0.0.1:5000/add -X PUT -H \[aq]Content-Type: application/json\[ | ||||
| .PP | ||||
| \f[B]LEDGER_FILE\f[R] The journal file path when not specified with | ||||
| \f[C]-f\f[R]. | ||||
| Default: \f[C]\[ti]/.hledger.journal\f[R] (on windows, perhaps | ||||
| \f[C]C:/Users/USER/.hledger.journal\f[R]). | ||||
| .PP | ||||
| A typical value is \f[C]\[ti]/DIR/YYYY.journal\f[R], where DIR is a | ||||
| On unix computers, the default value is: | ||||
| \f[C]\[ti]/.hledger.journal\f[R]. | ||||
| .PP | ||||
| A more typical value is something like | ||||
| \f[C]\[ti]/finance/YYYY.journal\f[R], where \f[C]\[ti]/finance\f[R] is a | ||||
| version-controlled finance directory and YYYY is the current year. | ||||
| Or \f[C]\[ti]/DIR/current.journal\f[R], where current.journal is a | ||||
| Or, \f[C]\[ti]/finance/current.journal\f[R], where current.journal is a | ||||
| symbolic link to YYYY.journal. | ||||
| .PP | ||||
| On Mac computers, you can set this and other environment variables in a | ||||
| more thorough way that also affects applications started from the GUI | ||||
| (say, an Emacs dock icon). | ||||
| Eg on MacOS Catalina I have a \f[C]\[ti]/.MacOSX/environment.plist\f[R] | ||||
| file containing | ||||
| The usual way to set this permanently is to add a command to one of your | ||||
| shell\[aq]s startup files (eg \f[C]\[ti]/.profile\f[R]): | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| export LEDGER_FILE=\[ti]/finance/current.journal\[ga] | ||||
| \f[R] | ||||
| .fi | ||||
| .PP | ||||
| On some Mac computers, there is a more thorough way to set environment | ||||
| variables, that will also affect applications started from the GUI (eg, | ||||
| Emacs started from a dock icon): In | ||||
| \f[C]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| @ -601,7 +611,22 @@ file containing | ||||
| \f[R] | ||||
| .fi | ||||
| .PP | ||||
| To see the effect you may need to \f[C]killall Dock\f[R], or reboot. | ||||
| For this to take effect you might need to \f[C]killall Dock\f[R], or | ||||
| reboot. | ||||
| .PP | ||||
| On Windows computers, the default value is probably | ||||
| \f[C]C:\[rs]Users\[rs]MyUserName\[rs].hledger.journal\f[R]. | ||||
| You can change this by running a command like this in a powershell | ||||
| window: | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| > setx LEDGER_FILE \[dq]C:\[rs]Users\[rs]MyUserName\[rs]finance\[rs]2021.journal\[dq] | ||||
| \f[R] | ||||
| .fi | ||||
| .PP | ||||
| (Let us know if you need to be an Administrator, and if this persists | ||||
| across a reboot.) | ||||
| .SH FILES | ||||
| .PP | ||||
| Reads data from one or more files in hledger journal, timeclock, | ||||
|  | ||||
| @ -567,24 +567,38 @@ File: hledger-web.info,  Node: ENVIRONMENT,  Next: FILES,  Prev: JSON API,  Up: | ||||
| ************* | ||||
| 
 | ||||
| *LEDGER_FILE* The journal file path when not specified with '-f'. | ||||
| Default: '~/.hledger.journal' (on windows, perhaps | ||||
| 'C:/Users/USER/.hledger.journal'). | ||||
| 
 | ||||
|    A typical value is '~/DIR/YYYY.journal', where DIR is a | ||||
| version-controlled finance directory and YYYY is the current year.  Or | ||||
| '~/DIR/current.journal', where current.journal is a symbolic link to | ||||
| YYYY.journal. | ||||
|    On unix computers, the default value is: '~/.hledger.journal'. | ||||
| 
 | ||||
|    On Mac computers, you can set this and other environment variables in | ||||
| a more thorough way that also affects applications started from the GUI | ||||
| (say, an Emacs dock icon).  Eg on MacOS Catalina I have a | ||||
| '~/.MacOSX/environment.plist' file containing | ||||
|    A more typical value is something like '~/finance/YYYY.journal', | ||||
| where '~/finance' is a version-controlled finance directory and YYYY is | ||||
| the current year.  Or, '~/finance/current.journal', where | ||||
| current.journal is a symbolic link to YYYY.journal. | ||||
| 
 | ||||
|    The usual way to set this permanently is to add a command to one of | ||||
| your shell's startup files (eg '~/.profile'): | ||||
| 
 | ||||
| export LEDGER_FILE=~/finance/current.journal` | ||||
| 
 | ||||
|    On some Mac computers, there is a more thorough way to set | ||||
| environment variables, that will also affect applications started from | ||||
| the GUI (eg, Emacs started from a dock icon): In | ||||
| '~/.MacOSX/environment.plist', add an entry like: | ||||
| 
 | ||||
| { | ||||
|   "LEDGER_FILE" : "~/finance/current.journal" | ||||
| } | ||||
| 
 | ||||
|    To see the effect you may need to 'killall Dock', or reboot. | ||||
|    For this to take effect you might need to 'killall Dock', or reboot. | ||||
| 
 | ||||
|    On Windows computers, the default value is probably | ||||
| 'C:\Users\MyUserName\.hledger.journal'.  You can change this by running | ||||
| a command like this in a powershell window: | ||||
| 
 | ||||
| > setx LEDGER_FILE "C:\Users\MyUserName\finance\2021.journal" | ||||
| 
 | ||||
|    (Let us know if you need to be an Administrator, and if this persists | ||||
| across a reboot.) | ||||
| 
 | ||||
|  | ||||
| File: hledger-web.info,  Node: FILES,  Next: BUGS,  Prev: ENVIRONMENT,  Up: Top | ||||
| @ -629,10 +643,10 @@ Node: JSON API12838 | ||||
| Ref: #json-api12952 | ||||
| Node: ENVIRONMENT18442 | ||||
| Ref: #environment18558 | ||||
| Node: FILES19291 | ||||
| Ref: #files19391 | ||||
| Node: BUGS19604 | ||||
| Ref: #bugs19682 | ||||
| Node: FILES19792 | ||||
| Ref: #files19892 | ||||
| Node: BUGS20105 | ||||
| Ref: #bugs20183 | ||||
|  | ||||
| End Tag Table | ||||
| 
 | ||||
|  | ||||
| @ -512,24 +512,39 @@ JSON API | ||||
|               $ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json | ||||
| 
 | ||||
| ENVIRONMENT | ||||
|        LEDGER_FILE The journal file path when not specified with -f.  Default: | ||||
|        ~/.hledger.journal (on  windows,  perhaps  C:/Users/USER/.hledger.jour- | ||||
|        nal). | ||||
|        LEDGER_FILE The journal file path when not specified with -f. | ||||
| 
 | ||||
|        A  typical  value  is  ~/DIR/YYYY.journal,  where DIR is a version-con- | ||||
|        trolled finance directory and YYYY is the current year.  Or  ~/DIR/cur- | ||||
|        rent.journal, where current.journal is a symbolic link to YYYY.journal. | ||||
|        On unix computers, the default value is: ~/.hledger.journal. | ||||
| 
 | ||||
|        On Mac computers, you can set this and other environment variables in a | ||||
|        more  thorough  way that also affects applications started from the GUI | ||||
|        (say,  an  Emacs  dock  icon).   Eg  on  MacOS  Catalina   I   have   a | ||||
|        ~/.MacOSX/environment.plist file containing | ||||
|        A  more  typical  value is something like ~/finance/YYYY.journal, where | ||||
|        ~/finance is a version-controlled finance directory  and  YYYY  is  the | ||||
|        current  year.  Or, ~/finance/current.journal, where current.journal is | ||||
|        a symbolic link to YYYY.journal. | ||||
| 
 | ||||
|        The usual way to set this permanently is to add a  command  to  one  of | ||||
|        your shell's startup files (eg ~/.profile): | ||||
| 
 | ||||
|               export LEDGER_FILE=~/finance/current.journal` | ||||
| 
 | ||||
|        On  some Mac computers, there is a more thorough way to set environment | ||||
|        variables, that will also affect applications started from the GUI (eg, | ||||
|        Emacs started from a dock icon): In ~/.MacOSX/environment.plist, add an | ||||
|        entry like: | ||||
| 
 | ||||
|               { | ||||
|                 "LEDGER_FILE" : "~/finance/current.journal" | ||||
|               } | ||||
| 
 | ||||
|        To see the effect you may need to killall Dock, or reboot. | ||||
|        For this to take effect you might need to killall Dock, or reboot. | ||||
| 
 | ||||
|        On Windows computers, the default value  is  probably  C:\Users\MyUser- | ||||
|        Name\.hledger.journal.   You  can change this by running a command like | ||||
|        this in a powershell window: | ||||
| 
 | ||||
|               > setx LEDGER_FILE "C:\Users\MyUserName\finance\2021.journal" | ||||
| 
 | ||||
|        (Let us know if you need to be an Administrator, and if  this  persists | ||||
|        across a reboot.) | ||||
| 
 | ||||
| FILES | ||||
|        Reads  data from one or more files in hledger journal, timeclock, time- | ||||
|  | ||||
| @ -507,19 +507,29 @@ See Special characters. | ||||
| .PP | ||||
| \f[B]LEDGER_FILE\f[R] The journal file path when not specified with | ||||
| \f[C]-f\f[R]. | ||||
| Default: \f[C]\[ti]/.hledger.journal\f[R] (on windows, perhaps | ||||
| \f[C]C:/Users/USER/.hledger.journal\f[R]). | ||||
| .PP | ||||
| A typical value is \f[C]\[ti]/DIR/YYYY.journal\f[R], where DIR is a | ||||
| On unix computers, the default value is: | ||||
| \f[C]\[ti]/.hledger.journal\f[R]. | ||||
| .PP | ||||
| A more typical value is something like | ||||
| \f[C]\[ti]/finance/YYYY.journal\f[R], where \f[C]\[ti]/finance\f[R] is a | ||||
| version-controlled finance directory and YYYY is the current year. | ||||
| Or \f[C]\[ti]/DIR/current.journal\f[R], where current.journal is a | ||||
| Or, \f[C]\[ti]/finance/current.journal\f[R], where current.journal is a | ||||
| symbolic link to YYYY.journal. | ||||
| .PP | ||||
| On Mac computers, you can set this and other environment variables in a | ||||
| more thorough way that also affects applications started from the GUI | ||||
| (say, an Emacs dock icon). | ||||
| Eg on MacOS Catalina I have a \f[C]\[ti]/.MacOSX/environment.plist\f[R] | ||||
| file containing | ||||
| The usual way to set this permanently is to add a command to one of your | ||||
| shell\[aq]s startup files (eg \f[C]\[ti]/.profile\f[R]): | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| export LEDGER_FILE=\[ti]/finance/current.journal\[ga] | ||||
| \f[R] | ||||
| .fi | ||||
| .PP | ||||
| On some Mac computers, there is a more thorough way to set environment | ||||
| variables, that will also affect applications started from the GUI (eg, | ||||
| Emacs started from a dock icon): In | ||||
| \f[C]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| @ -529,7 +539,22 @@ file containing | ||||
| \f[R] | ||||
| .fi | ||||
| .PP | ||||
| To see the effect you may need to \f[C]killall Dock\f[R], or reboot. | ||||
| For this to take effect you might need to \f[C]killall Dock\f[R], or | ||||
| reboot. | ||||
| .PP | ||||
| On Windows computers, the default value is probably | ||||
| \f[C]C:\[rs]Users\[rs]MyUserName\[rs].hledger.journal\f[R]. | ||||
| You can change this by running a command like this in a powershell | ||||
| window: | ||||
| .IP | ||||
| .nf | ||||
| \f[C] | ||||
| > setx LEDGER_FILE \[dq]C:\[rs]Users\[rs]MyUserName\[rs]finance\[rs]2021.journal\[dq] | ||||
| \f[R] | ||||
| .fi | ||||
| .PP | ||||
| (Let us know if you need to be an Administrator, and if this persists | ||||
| across a reboot.) | ||||
| .PP | ||||
| \f[B]COLUMNS\f[R] The screen width used by the register command. | ||||
| Default: the full terminal width. | ||||
| @ -2520,6 +2545,10 @@ the file extension, if needed: | ||||
| $ hledger balancesheet -o foo.txt -O csv    # write CSV to foo.txt | ||||
| \f[R] | ||||
| .fi | ||||
| .SS CSV output | ||||
| .IP \[bu] 2 | ||||
| In CSV output, digit group marks (such as thousands separators) are | ||||
| disabled automatically. | ||||
| .SS HTML output | ||||
| .IP \[bu] 2 | ||||
| HTML output can be styled by an optional \f[C]hledger.css\f[R] file in | ||||
| @ -8706,6 +8735,9 @@ comma). | ||||
| Field names may not contain spaces. | ||||
| Spaces before/after field names are optional. | ||||
| .IP \[bu] 2 | ||||
| Field names may contain \f[C]_\f[R] (underscore) or \f[C]-\f[R] | ||||
| (hyphen). | ||||
| .IP \[bu] 2 | ||||
| If the CSV contains column headings, it\[aq]s a good idea to use these, | ||||
| suitably modified, as the basis for your field names (eg lower-cased, | ||||
| with underscores instead of spaces). | ||||
| @ -8782,10 +8814,13 @@ Assigning to \f[C]date\f[R] sets the transaction date. | ||||
| \f[C]commentN\f[R], where N is a number, sets the Nth posting\[aq]s | ||||
| comment. | ||||
| .PP | ||||
| Tips: - You can assign multi-line comments by writing literal | ||||
| \f[C]\[rs]n\f[R] in the code. | ||||
| Tips: | ||||
| .IP \[bu] 2 | ||||
| You can assign multi-line comments by writing literal \f[C]\[rs]n\f[R] | ||||
| in the code. | ||||
| A comment starting with \f[C]\[rs]n\f[R] will begin on a new line. | ||||
| - Comments can contain tags, as usual. | ||||
| .IP \[bu] 2 | ||||
| Comments can contain tags, as usual. | ||||
| .SS account field | ||||
| .PP | ||||
| Assigning to \f[C]accountN\f[R], where N is 1 to 99, sets the account | ||||
|  | ||||
							
								
								
									
										1053
									
								
								hledger/hledger.info
									
									
									
									
									
								
							
							
						
						
									
										1053
									
								
								hledger/hledger.info
									
									
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							| @ -404,24 +404,39 @@ OPTIONS | ||||
|          cial characters. | ||||
| 
 | ||||
| ENVIRONMENT | ||||
|        LEDGER_FILE The journal file path when not specified with -f.  Default: | ||||
|        ~/.hledger.journal  (on  windows,  perhaps C:/Users/USER/.hledger.jour- | ||||
|        nal). | ||||
|        LEDGER_FILE The journal file path when not specified with -f. | ||||
| 
 | ||||
|        A typical value is ~/DIR/YYYY.journal,  where  DIR  is  a  version-con- | ||||
|        trolled  finance directory and YYYY is the current year.  Or ~/DIR/cur- | ||||
|        rent.journal, where current.journal is a symbolic link to YYYY.journal. | ||||
|        On unix computers, the default value is: ~/.hledger.journal. | ||||
| 
 | ||||
|        On Mac computers, you can set this and other environment variables in a | ||||
|        more thorough way that also affects applications started from  the  GUI | ||||
|        (say,   an   Emacs   dock  icon).   Eg  on  MacOS  Catalina  I  have  a | ||||
|        ~/.MacOSX/environment.plist file containing | ||||
|        A more typical value is something  like  ~/finance/YYYY.journal,  where | ||||
|        ~/finance  is  a  version-controlled  finance directory and YYYY is the | ||||
|        current year.  Or, ~/finance/current.journal, where current.journal  is | ||||
|        a symbolic link to YYYY.journal. | ||||
| 
 | ||||
|        The  usual  way  to  set this permanently is to add a command to one of | ||||
|        your shell's startup files (eg ~/.profile): | ||||
| 
 | ||||
|               export LEDGER_FILE=~/finance/current.journal` | ||||
| 
 | ||||
|        On some Mac computers, there is a more thorough way to set  environment | ||||
|        variables, that will also affect applications started from the GUI (eg, | ||||
|        Emacs started from a dock icon): In ~/.MacOSX/environment.plist, add an | ||||
|        entry like: | ||||
| 
 | ||||
|               { | ||||
|                 "LEDGER_FILE" : "~/finance/current.journal" | ||||
|               } | ||||
| 
 | ||||
|        To see the effect you may need to killall Dock, or reboot. | ||||
|        For this to take effect you might need to killall Dock, or reboot. | ||||
| 
 | ||||
|        On  Windows  computers,  the default value is probably C:\Users\MyUser- | ||||
|        Name\.hledger.journal.  You can change this by running a  command  like | ||||
|        this in a powershell window: | ||||
| 
 | ||||
|               > setx LEDGER_FILE "C:\Users\MyUserName\finance\2021.journal" | ||||
| 
 | ||||
|        (Let  us  know if you need to be an Administrator, and if this persists | ||||
|        across a reboot.) | ||||
| 
 | ||||
|        COLUMNS The screen width used by the register  command.   Default:  the | ||||
|        full terminal width. | ||||
| @ -462,6 +477,8 @@ DATA FILES | ||||
|        clock      ging | ||||
|        timedot    timedot  files,  for  approximate  time   .timedot | ||||
|                   logging | ||||
| 
 | ||||
| 
 | ||||
|        csv        comma/semicolon/tab/other-separated       .csv .ssv .tsv | ||||
|                   values, for data import | ||||
| 
 | ||||
| @ -599,6 +616,7 @@ TIME PERIODS | ||||
|        -p thismonth       all transactions in the current month | ||||
|        date:2016/3/17..   the above written as  queries  instead  (..  can  also  be | ||||
|                           replaced with -) | ||||
| 
 | ||||
|        date:..12/1 | ||||
|        date:thismonth.. | ||||
|        date:thismonth | ||||
| @ -685,7 +703,6 @@ TIME PERIODS | ||||
|        earliest or latest transaction in your journal: | ||||
| 
 | ||||
| 
 | ||||
| 
 | ||||
|        -p "from 2009/1/1"   everything  after  january | ||||
|                             1, 2009 | ||||
|        -p "from 2009/1"     the same | ||||
| @ -736,6 +753,8 @@ TIME PERIODS | ||||
| 
 | ||||
|        -p "weekly from  2009/1/1   starts on 2008/12/29, closest preceding Mon- | ||||
|        to 2009/4/1"                day | ||||
| 
 | ||||
| 
 | ||||
|        -p      "monthly       in   starts on 2018/11/01 | ||||
|        2008/11/25" | ||||
|        -p     "quarterly    from   starts  on  2009/04/01,  ends on 2009/06/30, | ||||
| @ -804,6 +823,7 @@ TIME PERIODS | ||||
|                                   month | ||||
|        -p "every 2nd Monday"      period  boundaries will be on second Monday of | ||||
|                                   each month | ||||
| 
 | ||||
|        -p "every 11/05"           yearly  periods  with  boundaries  on  5th  of | ||||
|                                   November | ||||
|        -p "every 5th November"    same | ||||
| @ -1358,6 +1378,9 @@ VALUATION | ||||
|        starting bal-   cost           value     at   valued   at   day   value     at   value      at | ||||
|        ance (-H)                      report    or   each   historical   report    or   DATE/today | ||||
|                                       journal end    posting was made    journal end | ||||
| 
 | ||||
| 
 | ||||
| 
 | ||||
|        starting bal-   cost           value at day   valued   at   day   value at day   value      at | ||||
|        ance     (-H)                  before         each   historical   before         DATE/today | ||||
|        with   report                  report    or   posting was made    report    or | ||||
| @ -1392,11 +1415,6 @@ VALUATION | ||||
|        bse,  cf, is) | ||||
|        with   report | ||||
|        interval | ||||
| 
 | ||||
| 
 | ||||
| 
 | ||||
| 
 | ||||
| 
 | ||||
|        starting bal-   sums      of   value     at   sums of values of   value     at   sums of post- | ||||
|        ances (-H)      costs     of   report start   postings   before   report start   ings   before | ||||
|                        postings       of  sums  of   report  start  at   of  sums  of   report start | ||||
| @ -1588,6 +1606,10 @@ OUTPUT | ||||
| 
 | ||||
|               $ hledger balancesheet -o foo.txt -O csv    # write CSV to foo.txt | ||||
| 
 | ||||
|    CSV output | ||||
|        o In CSV output, digit group marks (such as thousands  separators)  are | ||||
|          disabled automatically. | ||||
| 
 | ||||
|    HTML output | ||||
|        o HTML output can be styled by an optional hledger.css file in the same | ||||
|          directory. | ||||
| @ -2220,12 +2242,12 @@ COMMANDS | ||||
|        formats: | ||||
| 
 | ||||
| 
 | ||||
| 
 | ||||
|        -      txt   csv   html   json   sql | ||||
|        ------------------------------------- | ||||
|        wide   Y     Y     Y | ||||
|        tall   Y     Y     Y | ||||
|        bare   Y     Y     Y | ||||
| 
 | ||||
|        tidy         Y | ||||
| 
 | ||||
|        Examples: | ||||
| @ -4984,6 +5006,7 @@ JOURNAL FORMAT | ||||
|        And here are all the directives and their precise effects: | ||||
| 
 | ||||
| 
 | ||||
| 
 | ||||
|        direc-     effects                                                         ends | ||||
|        tive                                                                       at | ||||
|                                                                                   file | ||||
| @ -5882,7 +5905,6 @@ CSV FORMAT | ||||
|                                     records | ||||
|        fields list                  name  CSV  fields,  assign  them  to hledger | ||||
|                                     fields | ||||
| 
 | ||||
|        field assignment             assign a value to one  hledger  field,  with | ||||
|                                     interpolation | ||||
|        Field names                  hledger field names, used in the fields list | ||||
| @ -6228,6 +6250,8 @@ CSV FORMAT | ||||
|        o Field names may not contain spaces.  Spaces before/after field  names | ||||
|          are optional. | ||||
| 
 | ||||
|        o Field names may contain _ (underscore) or - (hyphen). | ||||
| 
 | ||||
|        o If  the  CSV contains column headings, it's a good idea to use these, | ||||
|          suitably modified, as the basis for your field names (eg lower-cased, | ||||
|          with underscores instead of spaces). | ||||
| @ -6294,9 +6318,12 @@ CSV FORMAT | ||||
| 
 | ||||
|        commentN, where N is a number, sets the Nth posting's comment. | ||||
| 
 | ||||
|        Tips: - You can assign multi-line comments by writing literal \n in the | ||||
|        code.  A comment starting with \n will begin on a new line.  - Comments | ||||
|        can contain tags, as usual. | ||||
|        Tips: | ||||
| 
 | ||||
|        o You can assign multi-line comments by writing literal \n in the code. | ||||
|          A comment starting with \n will begin on a new line. | ||||
| 
 | ||||
|        o Comments can contain tags, as usual. | ||||
| 
 | ||||
|    account field | ||||
|        Assigning to accountN, where N is 1 to 99, sets the account name of the | ||||
|  | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user