slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2022-07-28 17:32:58 +01:00
parent 959bf0d989
commit 06c14ff034
9 changed files with 2144 additions and 2135 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
hledger-ui/hledger-ui.1
View File

@ -557,9 +557,10 @@ 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].
\f[C]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R].
You can change this by running a command like this in a powershell
window:
window (let us know if you need to be an Administrator, and if this
persists across a reboot):
.IP
.nf
\f[C]
@ -567,8 +568,8 @@ window:
\f[R]
.fi
.PP
(Let us know if you need to be an Administrator, and if this persists
across a reboot.)
Or, change it in settings: see
https://www.java.com/en/download/help/path.html.
.SH FILES
.PP
Reads data from one or more files in hledger journal, timeclock,

17
hledger-ui/hledger-ui.info
View File

@ -589,13 +589,14 @@ the GUI (eg, Emacs started from a dock icon): In
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:
'C:\Users\YOURNAME\.hledger.journal'. You can change this by running a
command like this in a powershell window (let us know if you need to be
an Administrator, and if this persists across a reboot):
> 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.)
Or, change it in settings: see
https://www.java.com/en/download/help/path.html.

File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
@ -663,10 +664,10 @@ Node: Watch mode limitations18399
Ref: #watch-mode-limitations18540
Node: ENVIRONMENT19676
Ref: #environment19787
Node: FILES21095
Ref: #files21194
Node: BUGS21407
Ref: #bugs21484
Node: FILES21172
Ref: #files21271
Node: BUGS21484
Ref: #bugs21561

End Tag Table

31
hledger-ui/hledger-ui.txt
View File

@ -489,23 +489,24 @@ ENVIRONMENT
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:
On Windows computers, the default value is probably C:\Users\YOUR-
NAME\.hledger.journal. You can change this by running a command like
this in a powershell window (let us know if you need to be an Adminis-
trator, and if this persists across a reboot):
> 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.)
Or, change it in settings: see https://www.java.com/en/down-
load/help/path.html.
FILES
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal).
BUGS
The need to precede options with -- when invoked from hledger is awk-
The need to precede options with -- when invoked from hledger is awk-
ward.
-f- doesn't work (hledger-ui can't read from stdin).
@ -513,13 +514,13 @@ BUGS
-V affects only the accounts screen.
When you press g, the current and all previous screens are regenerated,
which may cause a noticeable pause with large files. Also there is no
which may cause a noticeable pause with large files. Also there is no
visual indication that this is in progress.
--watch is not yet fully robust. It works well for normal usage, but
many file changes in a short time (eg saving the file thousands of
times with an editor macro) can cause problems at least on OSX. Symp-
toms include: unresponsive UI, periodic resetting of the cursor posi-
--watch is not yet fully robust. It works well for normal usage, but
many file changes in a short time (eg saving the file thousands of
times with an editor macro) can cause problems at least on OSX. Symp-
toms include: unresponsive UI, periodic resetting of the cursor posi-
tion, momentary display of parse errors, high CPU usage eventually sub-
siding, and possibly a small but persistent build-up of CPU usage until
the program is restarted.
@ -530,7 +531,7 @@ BUGS
REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list)

9
hledger-web/hledger-web.1
View File

@ -615,9 +615,10 @@ 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].
\f[C]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R].
You can change this by running a command like this in a powershell
window:
window (let us know if you need to be an Administrator, and if this
persists across a reboot):
.IP
.nf
\f[C]
@ -625,8 +626,8 @@ window:
\f[R]
.fi
.PP
(Let us know if you need to be an Administrator, and if this persists
across a reboot.)
Or, change it in settings: see
https://www.java.com/en/download/help/path.html.
.SH FILES
.PP
Reads data from one or more files in hledger journal, timeclock,

17
hledger-web/hledger-web.info
View File

@ -592,13 +592,14 @@ the GUI (eg, Emacs started from a dock icon): In
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:
'C:\Users\YOURNAME\.hledger.journal'. You can change this by running a
command like this in a powershell window (let us know if you need to be
an Administrator, and if this persists across a reboot):
> 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.)
Or, change it in settings: see
https://www.java.com/en/download/help/path.html.

File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
@ -643,10 +644,10 @@ Node: JSON API12838
Ref: #json-api12952
Node: ENVIRONMENT18442
Ref: #environment18558
Node: FILES19792
Ref: #files19892
Node: BUGS20105
Ref: #bugs20183
Node: FILES19869
Ref: #files19969
Node: BUGS20182
Ref: #bugs20260

End Tag Table

21
hledger-web/hledger-web.txt
View File

@ -537,23 +537,24 @@ ENVIRONMENT
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:
On Windows computers, the default value is probably C:\Users\YOUR-
NAME\.hledger.journal. You can change this by running a command like
this in a powershell window (let us know if you need to be an Adminis-
trator, and if this persists across a reboot):
> 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.)
Or, change it in settings: see https://www.java.com/en/down-
load/help/path.html.
FILES
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal).
BUGS
The need to precede options with -- when invoked from hledger is awk-
The need to precede options with -- when invoked from hledger is awk-
ward.
-f- doesn't work (hledger-web can't read from stdin).
@ -567,7 +568,7 @@ BUGS
REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list)

14
hledger/hledger.1
View File

@ -543,9 +543,10 @@ 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].
\f[C]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R].
You can change this by running a command like this in a powershell
window:
window (let us know if you need to be an Administrator, and if this
persists across a reboot):
.IP
.nf
\f[C]
@ -553,8 +554,8 @@ window:
\f[R]
.fi
.PP
(Let us know if you need to be an Administrator, and if this persists
across a reboot.)
Or, change it in settings: see
https://www.java.com/en/download/help/path.html.
.PP
\f[B]COLUMNS\f[R] The screen width used by the register command.
Default: the full terminal width.
@ -566,7 +567,8 @@ This is overriden by the --color/--colour option.
.PP
hledger reads transactions from one or more data files.
The default data file is \f[C]$HOME/.hledger.journal\f[R] (or on
Windows, something like \f[C]C:/Users/USER/.hledger.journal\f[R]).
Windows, something like
\f[C]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]).
.PP
You can override this with the \f[C]$LEDGER_FILE\f[R] environment
variable:
@ -11027,7 +11029,7 @@ In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger
add.
.PP
Not all of Ledger\[aq]s journal file syntax is supported.
See file format differences.
See hledger and Ledger > Differences > journal format.
.PP
On large data files, hledger is slower and uses more memory than Ledger.
.SH TROUBLESHOOTING

1063
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

3098
hledger/hledger.txt
View File

File diff suppressed because it is too large Load Diff