simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-19 18:29:36 +03:00
Code Issues Projects Releases Wiki Activity

;doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2023-05-26 09:28:53 -10:00
parent 32f616f666
commit d2cefedffb
13 changed files with 5055 additions and 4528 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger-lib/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{April 2023}})m4_dnl m4_define({{_monthyear_}}, {{May 2023}})m4_dnl

2
hledger-ui/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{April 2023}})m4_dnl m4_define({{_monthyear_}}, {{May 2023}})m4_dnl

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

@ -1,5 +1,5 @@
.TH "HLEDGER-UI" "1" "April 2023" "hledger-ui-1.29.99 " "hledger User Manuals" .TH "HLEDGER-UI" "1" "May 2023" "hledger-ui-1.29.99 " "hledger User Manuals"
@ -30,12 +30,13 @@ limited data entry capability.
It is easier than hledger\[aq]s command-line interface, and sometimes It is easier than hledger\[aq]s command-line interface, and sometimes
quicker and more convenient than the web interface. quicker and more convenient than the web interface.
.PP .PP
Like hledger, it reads data from one or more files in journal, Like hledger, it reads from (and appends to) a journal file specified by
timeclock, timedot, or CSV format. the \f[V]LEDGER_FILE\f[R] environment variable (defaulting to
The default file is \f[V].hledger.journal\f[R] in your home directory; \f[V]$HOME/.hledger.journal\f[R]); or you can specify files with
this can be overridden with one or more \f[V]-f FILE\f[R] options, or \f[V]-f\f[R] options.
the \f[V]LEDGER_FILE\f[R] environment variable. It can also read timeclock files, timedot files, or any CSV/SSV/TSV file
For more about this see hledger(1), hledger_journal(5) etc. with a date field.
(See hledger(1) -> Input for details.)
.PP .PP
Unlike hledger, hledger-ui hides all future-dated transactions by Unlike hledger, hledger-ui hides all future-dated transactions by
default. default.
@ -179,17 +180,29 @@ convert amounts to their market value in commodity COMM
\f[V]--value\f[R] \f[V]--value\f[R]
convert amounts to cost or market value, more flexibly than -B/-V/-X convert amounts to cost or market value, more flexibly than -B/-V/-X
.TP .TP
\f[V]--infer-market-prices\f[R] \f[V]--infer-equity\f[R]
use transaction prices (recorded with \[at] or \[at]\[at]) as additional infer conversion equity postings from costs
market prices, as if they were P directives
.TP .TP
\f[V]--auto\f[R] \f[V]--infer-costs\f[R]
apply automated posting rules to modify transactions. infer costs from conversion equity postings
.TP
\f[V]--infer-market-prices\f[R]
use costs as additional market prices, as if they were P directives
.TP .TP
\f[V]--forecast\f[R] \f[V]--forecast\f[R]
generate future transactions from periodic transaction rules, for the generate transactions from periodic rules,
next 6 months or till report end date. between the latest recorded txn and 6 months from today,
In hledger-ui, also make ordinary future transactions visible. or during the specified PERIOD (= is required).
Auto posting rules will be applied to these transactions as well.
Also, in hledger-ui make future-dated transactions visible.
.TP
\f[V]--auto\f[R]
generate extra postings by applying auto posting rules to all txns (not
just forecast txns)
.TP
\f[V]--verbose-tags\f[R]
add visible tags indicating transactions or postings which have been
generated/modified
.TP .TP
\f[V]--commodity-style\f[R] \f[V]--commodity-style\f[R]
Override the commodity style in the output for the specified commodity. Override the commodity style in the output for the specified commodity.
@ -515,23 +528,25 @@ This leaves more mental bandwidth for your accounting.
Of course you can still interact with hledger-ui when needed, eg to Of course you can still interact with hledger-ui when needed, eg to
toggle cleared mode, or to explore the history. toggle cleared mode, or to explore the history.
.PP .PP
Here are some current limitations to be aware of: There are currently some limitations with \f[V]--watch\f[R]:
.PP .PP
Changes might not be detected with certain editors, possibly including It may not work correctly for you, depending on platform or system
Jetbrains IDEs, \f[V]gedit\f[R], other Gnome applications; or on certain configuration.
unusual filesystems. (Eg #836.)
(#1617, #911).
To work around, reload manually by pressing \f[V]g\f[R] in the
hledger-ui window.
(Or see #1617 for another workaround, and let us know if it works for
you.)
.PP .PP
CPU and memory usage can sometimes gradually increase, if At least on mac, there can be a slow build-up of CPU usage over time,
\f[V]hledger-ui --watch\f[R] is left running for days. until the program is restarted (or, suspending and restarting with
(Possibly correlated with certain platforms, many transactions, and/or \f[V]CTRL-z\f[R] \f[V]fg\f[R] may be enough).
large numbers of other files present). .PP
To work around, \f[V]q\f[R]uit and restart it, or (where supported) It will not detect file changes made by certain editors, such as
suspend (\f[V]CTRL-z\f[R]) and restart it (\f[V]fg\f[R]). Jetbrains IDEs or \f[V]gedit\f[R], or on certain less common
filesystems.
(To work around, press \f[V]g\f[R] to reload manually, or try
#1617\[aq]s \f[V]fs.inotify.max_user_watches\f[R] workaround and let us
know.)
.PP
If you are viewing files mounted from another machine, the system clocks
on both machines should be roughly in agreement.
.SS Debug output .SS Debug output
.PP .PP
You can add \f[V]--debug[=N]\f[R] to the command line to log debug You can add \f[V]--debug[=N]\f[R] to the command line to log debug
@ -544,92 +559,29 @@ N ranges from 1 (least output, the default) to 9 (maximum output).
\f[B]COLUMNS\f[R] The screen width to use. \f[B]COLUMNS\f[R] The screen width to use.
Default: the full terminal width. Default: the full terminal width.
.PP .PP
\f[B]LEDGER_FILE\f[R] The journal file path when not specified with \f[B]LEDGER_FILE\f[R] The main journal file to use when not specified
\f[V]-f\f[R]. with \f[V]-f/--file\f[R].
.PP Default: \f[V]$HOME/.hledger.journal\f[R].
On unix computers, the default value is:
\f[V]\[ti]/.hledger.journal\f[R].
.PP
A more typical value is something like
\f[V]\[ti]/finance/YYYY.journal\f[R], where \f[V]\[ti]/finance\f[R] is a
version-controlled finance directory and YYYY is the current year.
Or, \f[V]\[ti]/finance/current.journal\f[R], where current.journal is a
symbolic link to YYYY.journal.
.PP
The usual way to set this permanently is to add a command to one of your
shell\[aq]s startup files (eg \f[V]\[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[V]\[ti]/.MacOSX/environment.plist\f[R], add an entry like:
.IP
.nf
\f[C]
{
\[dq]LEDGER_FILE\[dq] : \[dq]\[ti]/finance/current.journal\[dq]
}
\f[R]
.fi
.PP
For this to take effect you might need to \f[V]killall Dock\f[R], or
reboot.
.PP
On Windows computers, the default value is probably
\f[V]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R].
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):
.IP
.nf
\f[C]
> setx LEDGER_FILE \[dq]C:\[rs]Users\[rs]MyUserName\[rs]finance\[rs]2021.journal\[dq]
\f[R]
.fi
.PP
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 journal, timeclock, timedot, or CSV
format.
The default file is \f[V].hledger.journal\f[R] in your home directory;
this can be overridden with one or more \f[V]-f FILE\f[R] options, or
the \f[V]LEDGER_FILE\f[R] environment variable.
.SH BUGS .SH BUGS
.PP .PP
We welcome bug reports in the hledger issue tracker (shortcut:
http://bugs.hledger.org), or on the #hledger chat or hledger mail list
(https://hledger.org/support).
.PP
Some known issues:
.PP
\f[V]-f-\f[R] doesn\[aq]t work (hledger-ui can\[aq]t read from stdin). \f[V]-f-\f[R] doesn\[aq]t work (hledger-ui can\[aq]t read from stdin).
.PP .PP
\f[V]-V\f[R] affects only the accounts screen. If you press \f[V]g\f[R] with large files, there could be a noticeable
pause.
.PP .PP
When you press \f[V]g\f[R], the current and all previous screens are The Transaction screen does not update from file changes until you exit
regenerated, which may cause a noticeable pause with large files. and re-endter it (see SCREENS > Transaction above).
Also there is no visual indication that this is in progress.
.PP .PP
\f[V]--watch\f[R] is not yet fully robust. \f[V]--watch\f[R] is not yet fully robust on all platforms (see Watch
It works well for normal usage, but many file changes in a short time mode above).
(eg saving the file thousands of times with an editor macro) can cause
problems at least on OSX.
Symptoms include: unresponsive UI, periodic resetting of the cursor
position, momentary display of parse errors, high CPU usage eventually
subsiding, and possibly a small but persistent build-up of CPU usage
until the program is restarted.
.PP
Also, if you are viewing files mounted from another machine,
\f[V]-w/--watch\f[R] requires that both machine clocks are roughly in
step.
.SH "REPORTING BUGS"
Report bugs at http://bugs.hledger.org
(or on the #hledger chat or hledger mail list)
.SH AUTHORS .SH AUTHORS
Simon Michael <simon@joyful.com> and contributors. Simon Michael <simon@joyful.com> and contributors.
.br .br

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

@ -31,11 +31,11 @@ limited data entry capability. It is easier than hledger's command-line
interface, and sometimes quicker and more convenient than the web interface, and sometimes quicker and more convenient than the web
interface. interface.
Like hledger, it reads data from one or more files in journal, Like hledger, it reads from (and appends to) a journal file specified
timeclock, timedot, or CSV format. The default file is by the 'LEDGER_FILE' environment variable (defaulting to
'.hledger.journal' in your home directory; this can be overridden with '$HOME/.hledger.journal'); or you can specify files with '-f' options.
one or more '-f FILE' options, or the 'LEDGER_FILE' environment It can also read timeclock files, timedot files, or any CSV/SSV/TSV file
variable. For more about this see hledger(1), hledger_journal(5) etc. with a date field. (See hledger(1) -> Input for details.)
Unlike hledger, hledger-ui hides all future-dated transactions by Unlike hledger, hledger-ui hides all future-dated transactions by
default. They can be revealed, along with any rule-generated periodic default. They can be revealed, along with any rule-generated periodic
@ -50,7 +50,6 @@ enable "forecast mode".
* SCREENS:: * SCREENS::
* TIPS:: * TIPS::
* ENVIRONMENT:: * ENVIRONMENT::
* FILES::
* BUGS:: * BUGS::
 
@ -200,18 +199,30 @@ the data.
convert amounts to cost or market value, more flexibly than convert amounts to cost or market value, more flexibly than
-B/-V/-X -B/-V/-X
'--infer-equity'
infer conversion equity postings from costs
'--infer-costs'
infer costs from conversion equity postings
'--infer-market-prices' '--infer-market-prices'
use transaction prices (recorded with @ or @@) as additional market use costs as additional market prices, as if they were P directives
prices, as if they were P directives
'--auto'
apply automated posting rules to modify transactions.
'--forecast' '--forecast'
generate future transactions from periodic transaction rules, for generate transactions from periodic rules, between the latest
the next 6 months or till report end date. In hledger-ui, also recorded txn and 6 months from today, or during the specified
make ordinary future transactions visible. PERIOD (= is required). Auto posting rules will be applied to
these transactions as well. Also, in hledger-ui make future-dated
transactions visible.
'--auto'
generate extra postings by applying auto posting rules to all txns
(not just forecast txns)
'--verbose-tags'
add visible tags indicating transactions or postings which have
been generated/modified
'--commodity-style' '--commodity-style'
Override the commodity style in the output for the specified Override the commodity style in the output for the specified
@ -575,19 +586,22 @@ bandwidth for your accounting. Of course you can still interact with
hledger-ui when needed, eg to toggle cleared mode, or to explore the hledger-ui when needed, eg to toggle cleared mode, or to explore the
history. history.
Here are some current limitations to be aware of: There are currently some limitations with '--watch':
Changes might not be detected with certain editors, possibly It may not work correctly for you, depending on platform or system
including Jetbrains IDEs, 'gedit', other Gnome applications; or on configuration. (Eg #836.)
certain unusual filesystems. (#1617, #911). To work around, reload
manually by pressing 'g' in the hledger-ui window. (Or see #1617 for
another workaround, and let us know if it works for you.)
CPU and memory usage can sometimes gradually increase, if 'hledger-ui At least on mac, there can be a slow build-up of CPU usage over time,
--watch' is left running for days. (Possibly correlated with certain until the program is restarted (or, suspending and restarting with
platforms, many transactions, and/or large numbers of other files 'CTRL-z' 'fg' may be enough).
present). To work around, 'q'uit and restart it, or (where supported)
suspend ('CTRL-z') and restart it ('fg'). It will not detect file changes made by certain editors, such as
Jetbrains IDEs or 'gedit', or on certain less common filesystems. (To
work around, press 'g' to reload manually, or try #1617's
'fs.inotify.max_user_watches' workaround and let us know.)
If you are viewing files mounted from another machine, the system
clocks on both machines should be roughly in agreement.
 
File: hledger-ui.info, Node: Debug output, Prev: Watch mode, Up: TIPS File: hledger-ui.info, Node: Debug output, Prev: Watch mode, Up: TIPS
@ -600,123 +614,75 @@ will be logged to the file 'hledger-ui.log' in the current directory. N
ranges from 1 (least output, the default) to 9 (maximum output). ranges from 1 (least output, the default) to 9 (maximum output).
 
File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: TIPS, Up: Top File: hledger-ui.info, Node: ENVIRONMENT, Next: BUGS, Prev: TIPS, Up: Top
6 ENVIRONMENT 6 ENVIRONMENT
************* *************
*COLUMNS* The screen width to use. Default: the full terminal width. *COLUMNS* The screen width to use. Default: the full terminal width.
*LEDGER_FILE* The journal file path when not specified with '-f'. *LEDGER_FILE* The main journal file to use when not specified with
'-f/--file'. Default: '$HOME/.hledger.journal'.
On unix computers, the default value is: '~/.hledger.journal'.
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"
}
For this to take effect you might need to 'killall Dock', or reboot.
On Windows computers, the default value is probably
'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"
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 File: hledger-ui.info, Node: BUGS, Prev: ENVIRONMENT, Up: Top
7 FILES 7 BUGS
*******
Reads data from one or more files in journal, timeclock, timedot, or CSV
format. The default file is '.hledger.journal' in your home directory;
this can be overridden with one or more '-f FILE' options, or the
'LEDGER_FILE' environment variable.

File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top
8 BUGS
****** ******
We welcome bug reports in the hledger issue tracker (shortcut:
http://bugs.hledger.org), or on the #hledger chat or hledger mail list
(https://hledger.org/support).
Some known issues:
'-f-' doesn't work (hledger-ui can't read from stdin). '-f-' doesn't work (hledger-ui can't read from stdin).
'-V' affects only the accounts screen. If you press 'g' with large files, there could be a noticeable pause.
When you press 'g', the current and all previous screens are The Transaction screen does not update from file changes until you
regenerated, which may cause a noticeable pause with large files. Also exit and re-endter it (see SCREENS > Transaction above).
there is no visual indication that this is in progress.
'--watch' is not yet fully robust. It works well for normal usage, '--watch' is not yet fully robust on all platforms (see Watch mode
but many file changes in a short time (eg saving the file thousands of above).
times with an editor macro) can cause problems at least on OSX. Symptoms
include: unresponsive UI, periodic resetting of the cursor position,
momentary display of parse errors, high CPU usage eventually subsiding,
and possibly a small but persistent build-up of CPU usage until the
program is restarted.
Also, if you are viewing files mounted from another machine,
'-w/--watch' requires that both machine clocks are roughly in step.
 
Tag Table: Tag Table:
Node: Top223 Node: Top223
Node: OPTIONS1843 Node: OPTIONS1838
Ref: #options1941 Ref: #options1936
Node: MOUSE7074 Node: MOUSE7432
Ref: #mouse7169 Ref: #mouse7527
Node: KEYS7406 Node: KEYS7764
Ref: #keys7499 Ref: #keys7857
Node: SCREENS12012 Node: SCREENS12370
Ref: #screens12110 Ref: #screens12468
Node: Menu12690 Node: Menu13048
Ref: #menu12783 Ref: #menu13141
Node: Cash accounts12978 Node: Cash accounts13336
Ref: #cash-accounts13120 Ref: #cash-accounts13478
Node: Balance sheet accounts13304 Node: Balance sheet accounts13662
Ref: #balance-sheet-accounts13485 Ref: #balance-sheet-accounts13843
Node: Income statement accounts13605 Node: Income statement accounts13963
Ref: #income-statement-accounts13791 Ref: #income-statement-accounts14149
Node: All accounts13955 Node: All accounts14313
Ref: #all-accounts14101 Ref: #all-accounts14459
Node: Register14283 Node: Register14641
Ref: #register14407 Ref: #register14765
Node: Transaction16369 Node: Transaction16727
Ref: #transaction16492 Ref: #transaction16850
Node: Error17909 Node: Error18267
Ref: #error18003 Ref: #error18361
Node: TIPS18247 Node: TIPS18605
Ref: #tips18346 Ref: #tips18704
Node: Watch mode18388 Node: Watch mode18746
Ref: #watch-mode18495 Ref: #watch-mode18853
Node: Debug output19951 Node: Debug output20312
Ref: #debug-output20062 Ref: #debug-output20423
Node: ENVIRONMENT20274 Node: ENVIRONMENT20635
Ref: #environment20385 Ref: #environment20745
Node: FILES21770 Node: BUGS20936
Ref: #files21869 Ref: #bugs21019
Node: BUGS22117
Ref: #bugs22194
 
End Tag Table End Tag Table

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

@ -15,8 +15,8 @@ DESCRIPTION
also the hledger manual for common concepts and file formats. also the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs for hledger is a robust, user-friendly, cross-platform set of programs for
tracking money, time, or any other commodity, using double-entry tracking money, time, or any other commodity, using double-entry ac-
accounting and a simple, editable file format. hledger is inspired by counting and a simple, editable file format. hledger is inspired by
and largely compatible with ledger(1), and largely interconvertible and largely compatible with ledger(1), and largely interconvertible
with beancount(1). with beancount(1).
@ -26,14 +26,14 @@ DESCRIPTION
line interface, and sometimes quicker and more convenient than the web line interface, and sometimes quicker and more convenient than the web
interface. interface.
Like hledger, it reads data from one or more files in journal, time- Like hledger, it reads from (and appends to) a journal file specified
clock, timedot, or CSV format. The default file is .hledger.journal in by the LEDGER_FILE environment variable (defaulting to
your home directory; this can be overridden with one or more -f FILE $HOME/.hledger.journal); or you can specify files with -f options. It
options, or the LEDGER_FILE environment variable. For more about this can also read timeclock files, timedot files, or any CSV/SSV/TSV file
see hledger(1), hledger_journal(5) etc. with a date field. (See hledger(1) -> Input for details.)
Unlike hledger, hledger-ui hides all future-dated transactions by Unlike hledger, hledger-ui hides all future-dated transactions by de-
default. They can be revealed, along with any rule-generated periodic fault. They can be revealed, along with any rule-generated periodic
transactions, by pressing the F key (or starting with --forecast) to transactions, by pressing the F key (or starting with --forecast) to
enable "forecast mode". enable "forecast mode".
@ -99,8 +99,8 @@ OPTIONS
assignments) assignments)
-s --strict -s --strict
do extra error checking (check that all posted accounts are do extra error checking (check that all posted accounts are de-
declared) clared)
hledger reporting options: hledger reporting options:
@ -132,8 +132,8 @@ OPTIONS
using period expressions syntax using period expressions syntax
--date2 --date2
match the secondary date instead (see command help for other match the secondary date instead (see command help for other ef-
effects) fects)
--today=DATE --today=DATE
override today's date (affects relative smart dates, for override today's date (affects relative smart dates, for
@ -172,16 +172,29 @@ OPTIONS
convert amounts to cost or market value, more flexibly than convert amounts to cost or market value, more flexibly than
-B/-V/-X -B/-V/-X
--infer-market-prices --infer-equity
use transaction prices (recorded with @ or @@) as additional infer conversion equity postings from costs
market prices, as if they were P directives
--auto apply automated posting rules to modify transactions. --infer-costs
infer costs from conversion equity postings
--infer-market-prices
use costs as additional market prices, as if they were P direc-
tives
--forecast --forecast
generate future transactions from periodic transaction rules, generate transactions from periodic rules, between the latest
for the next 6 months or till report end date. In hledger-ui, recorded txn and 6 months from today, or during the specified
also make ordinary future transactions visible. PERIOD (= is required). Auto posting rules will be applied to
these transactions as well. Also, in hledger-ui make future-
dated transactions visible.
--auto generate extra postings by applying auto posting rules to all
txns (not just forecast txns)
--verbose-tags
add visible tags indicating transactions or postings which have
been generated/modified
--commodity-style --commodity-style
Override the commodity style in the output for the specified Override the commodity style in the output for the specified
@ -238,8 +251,8 @@ KEYS
Keyboard gives more control. Keyboard gives more control.
? shows a help dialog listing all keys. (Some of these also appear in ? shows a help dialog listing all keys. (Some of these also appear in
the quick help at the bottom of each screen.) Press ? again (or the quick help at the bottom of each screen.) Press ? again (or ES-
ESCAPE, or LEFT, or q) to close it. The following keys work on most CAPE, or LEFT, or q) to close it. The following keys work on most
screens: screens:
The cursor keys navigate: RIGHT or ENTER goes deeper, LEFT returns to The cursor keys navigate: RIGHT or ENTER goes deeper, LEFT returns to
@ -277,12 +290,12 @@ KEYS
As mentioned above, by default hledger-ui hides future transactions - As mentioned above, by default hledger-ui hides future transactions -
both ordinary transactions recorded in the journal, and periodic trans- both ordinary transactions recorded in the journal, and periodic trans-
actions generated by rule. F toggles forecast mode, in which actions generated by rule. F toggles forecast mode, in which fu-
future/forecasted transactions are shown. ture/forecasted transactions are shown.
ESCAPE resets the UI state and jumps back to the top screen, restoring ESCAPE resets the UI state and jumps back to the top screen, restoring
the app's initial state at startup. Or, it cancels minibuffer data the app's initial state at startup. Or, it cancels minibuffer data en-
entry or the help dialog. try or the help dialog.
CTRL-l redraws the screen and centers the selection if possible (selec- CTRL-l redraws the screen and centers the selection if possible (selec-
tions near the top won't be centered, since we don't scroll above the tions near the top won't be centered, since we don't scroll above the
@ -409,16 +422,16 @@ SCREENS
similar to hledger's print command and journal format (hledger_jour- similar to hledger's print command and journal format (hledger_jour-
nal(5)). nal(5)).
The transaction's date(s) and any cleared flag, transaction code, The transaction's date(s) and any cleared flag, transaction code, de-
description, comments, along with all of its account postings are scription, comments, along with all of its account postings are shown.
shown. Simple transactions have two postings, but there can be more Simple transactions have two postings, but there can be more (or in
(or in certain cases, fewer). certain cases, fewer).
UP and DOWN will step through all transactions listed in the previous UP and DOWN will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary show your position within that account register. They will vary de-
depending on which account register you came from (remember most trans- pending on which account register you came from (remember most transac-
actions appear in multiple account registers). The #N number preceding tions appear in multiple account registers). The #N number preceding
them is the transaction's position within the complete unfiltered jour- them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload). nal, which is a more stable id (at least until the next reload).
@ -458,19 +471,22 @@ TIPS
hledger-ui when needed, eg to toggle cleared mode, or to explore the hledger-ui when needed, eg to toggle cleared mode, or to explore the
history. history.
Here are some current limitations to be aware of: There are currently some limitations with --watch:
Changes might not be detected with certain editors, possibly including It may not work correctly for you, depending on platform or system con-
Jetbrains IDEs, gedit, other Gnome applications; or on certain unusual figuration. (Eg #836.)
filesystems. (#1617, #911). To work around, reload manually by press-
ing g in the hledger-ui window. (Or see #1617 for another workaround,
and let us know if it works for you.)
CPU and memory usage can sometimes gradually increase, if hledger-ui At least on mac, there can be a slow build-up of CPU usage over time,
--watch is left running for days. (Possibly correlated with certain until the program is restarted (or, suspending and restarting with
platforms, many transactions, and/or large numbers of other files CTRL-z fg may be enough).
present). To work around, quit and restart it, or (where supported)
suspend (CTRL-z) and restart it (fg). It will not detect file changes made by certain editors, such as Jet-
brains IDEs or gedit, or on certain less common filesystems. (To work
around, press g to reload manually, or try #1617's fs.ino-
tify.max_user_watches workaround and let us know.)
If you are viewing files mounted from another machine, the system
clocks on both machines should be roughly in agreement.
Debug output Debug output
You can add --debug[=N] to the command line to log debug output. This You can add --debug[=N] to the command line to log debug output. This
@ -480,72 +496,26 @@ TIPS
ENVIRONMENT ENVIRONMENT
COLUMNS The screen width to use. Default: the full terminal width. COLUMNS The screen width to use. Default: the full terminal width.
LEDGER_FILE The journal file path when not specified with -f. LEDGER_FILE The main journal file to use when not specified with
-f/--file. Default: $HOME/.hledger.journal.
On unix computers, the default value is: ~/.hledger.journal.
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"
}
For this to take effect you might need to killall Dock, or reboot.
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"
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 journal, timeclock, timedot, or
CSV format. The default file is .hledger.journal in your home direc-
tory; this can be overridden with one or more -f FILE options, or the
LEDGER_FILE environment variable.
BUGS BUGS
We welcome bug reports in the hledger issue tracker (shortcut:
http://bugs.hledger.org), or on the #hledger chat or hledger mail list
(https://hledger.org/support).
Some known issues:
-f- doesn't work (hledger-ui can't read from stdin). -f- doesn't work (hledger-ui can't read from stdin).
-V affects only the accounts screen. If you press g with large files, there could be a noticeable pause.
When you press g, the current and all previous screens are regenerated, The Transaction screen does not update from file changes until you exit
which may cause a noticeable pause with large files. Also there is no and re-endter it (see SCREENS > Transaction above).
visual indication that this is in progress.
--watch is not yet fully robust. It works well for normal usage, but --watch is not yet fully robust on all platforms (see Watch mode
many file changes in a short time (eg saving the file thousands of above).
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.
Also, if you are viewing files mounted from another machine, -w/--watch
requires that both machine clocks are roughly in step.
REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger chat or
hledger mail list)
AUTHORS AUTHORS
@ -566,4 +536,4 @@ SEE ALSO
hledger-ui-1.29.99 April 2023 HLEDGER-UI(1) hledger-ui-1.29.99 May 2023 HLEDGER-UI(1)

2
hledger-web/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{April 2023}})m4_dnl m4_define({{_monthyear_}}, {{May 2023}})m4_dnl

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

@ -1,5 +1,5 @@
.TH "HLEDGER-WEB" "1" "April 2023" "hledger-web-1.29.99 " "hledger User Manuals" .TH "HLEDGER-WEB" "1" "May 2023" "hledger-web-1.29.99 " "hledger User Manuals"
@ -47,12 +47,13 @@ As a small protection against data loss when running an unprotected
instance, it writes a numbered backup of the main journal file (only) on instance, it writes a numbered backup of the main journal file (only) on
every edit. every edit.
.PP .PP
Like hledger, it reads data from one or more files in journal, Like hledger, it reads from (and appends to) a journal file specified by
timeclock, timedot, or CSV format. the \f[V]LEDGER_FILE\f[R] environment variable (defaulting to
The default file is \f[V].hledger.journal\f[R] in your home directory; \f[V]$HOME/.hledger.journal\f[R]); or you can specify files with
this can be overridden with one or more \f[V]-f FILE\f[R] options, or \f[V]-f\f[R] options.
the \f[V]LEDGER_FILE\f[R] environment variable. It can also read timeclock files, timedot files, or any CSV/SSV/TSV file
For more about this see hledger(1). with a date field.
(See hledger(1) -> Input for details.)
.PP .PP
hledger-web can be run in three modes: hledger-web can be run in three modes:
.IP \[bu] 2 .IP \[bu] 2
@ -217,17 +218,29 @@ convert amounts to their market value in commodity COMM
\f[V]--value\f[R] \f[V]--value\f[R]
convert amounts to cost or market value, more flexibly than -B/-V/-X convert amounts to cost or market value, more flexibly than -B/-V/-X
.TP .TP
\f[V]--infer-market-prices\f[R] \f[V]--infer-equity\f[R]
use transaction prices (recorded with \[at] or \[at]\[at]) as additional infer conversion equity postings from costs
market prices, as if they were P directives
.TP .TP
\f[V]--auto\f[R] \f[V]--infer-costs\f[R]
apply automated posting rules to modify transactions. infer costs from conversion equity postings
.TP
\f[V]--infer-market-prices\f[R]
use costs as additional market prices, as if they were P directives
.TP .TP
\f[V]--forecast\f[R] \f[V]--forecast\f[R]
generate future transactions from periodic transaction rules, for the generate transactions from periodic rules,
next 6 months or till report end date. between the latest recorded txn and 6 months from today,
In hledger-ui, also make ordinary future transactions visible. or during the specified PERIOD (= is required).
Auto posting rules will be applied to these transactions as well.
Also, in hledger-ui make future-dated transactions visible.
.TP
\f[V]--auto\f[R]
generate extra postings by applying auto posting rules to all txns (not
just forecast txns)
.TP
\f[V]--verbose-tags\f[R]
add visible tags indicating transactions or postings which have been
generated/modified
.TP .TP
\f[V]--commodity-style\f[R] \f[V]--commodity-style\f[R]
Override the commodity style in the output for the specified commodity. Override the commodity style in the output for the specified commodity.
@ -611,79 +624,20 @@ stderr, eg:
\f[V]hledger-web --debug=3 2>hledger-web.log\f[R]. \f[V]hledger-web --debug=3 2>hledger-web.log\f[R].
.SH ENVIRONMENT .SH ENVIRONMENT
.PP .PP
\f[B]LEDGER_FILE\f[R] The journal file path when not specified with \f[B]LEDGER_FILE\f[R] The main journal file to use when not specified
\f[V]-f\f[R]. with \f[V]-f/--file\f[R].
.PP Default: \f[V]$HOME/.hledger.journal\f[R].
On unix computers, the default value is:
\f[V]\[ti]/.hledger.journal\f[R].
.PP
A more typical value is something like
\f[V]\[ti]/finance/YYYY.journal\f[R], where \f[V]\[ti]/finance\f[R] is a
version-controlled finance directory and YYYY is the current year.
Or, \f[V]\[ti]/finance/current.journal\f[R], where current.journal is a
symbolic link to YYYY.journal.
.PP
The usual way to set this permanently is to add a command to one of your
shell\[aq]s startup files (eg \f[V]\[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[V]\[ti]/.MacOSX/environment.plist\f[R], add an entry like:
.IP
.nf
\f[C]
{
\[dq]LEDGER_FILE\[dq] : \[dq]\[ti]/finance/current.journal\[dq]
}
\f[R]
.fi
.PP
For this to take effect you might need to \f[V]killall Dock\f[R], or
reboot.
.PP
On Windows computers, the default value is probably
\f[V]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R].
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):
.IP
.nf
\f[C]
> setx LEDGER_FILE \[dq]C:\[rs]Users\[rs]MyUserName\[rs]finance\[rs]2021.journal\[dq]
\f[R]
.fi
.PP
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 journal, timeclock, timedot, or CSV
format.
The default file is \f[V].hledger.journal\f[R] in your home directory;
this can be overridden with one or more \f[V]-f FILE\f[R] options, or
the \f[V]LEDGER_FILE\f[R] environment variable.
.SH BUGS .SH BUGS
.PP .PP
\f[V]-f-\f[R] doesn\[aq]t work (hledger-web can\[aq]t read from stdin). We welcome bug reports in the hledger issue tracker (shortcut:
http://bugs.hledger.org), or on the #hledger chat or hledger mail list
(https://hledger.org/support).
.PP .PP
Query arguments and some hledger options are ignored. Some known issues:
.PP .PP
Does not work in text-mode browsers. Does not work well on small screens, or in text-mode browsers.
.PP
Does not work well on small screens.
.SH "REPORTING BUGS"
Report bugs at http://bugs.hledger.org
(or on the #hledger chat or hledger mail list)
.SH AUTHORS .SH AUTHORS
Simon Michael <simon@joyful.com> and contributors. Simon Michael <simon@joyful.com> and contributors.
.br .br

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

@ -39,11 +39,11 @@ you should put it behind a suitable web proxy. As a small protection
against data loss when running an unprotected instance, it writes a against data loss when running an unprotected instance, it writes a
numbered backup of the main journal file (only) on every edit. numbered backup of the main journal file (only) on every edit.
Like hledger, it reads data from one or more files in journal, Like hledger, it reads from (and appends to) a journal file specified
timeclock, timedot, or CSV format. The default file is by the 'LEDGER_FILE' environment variable (defaulting to
'.hledger.journal' in your home directory; this can be overridden with '$HOME/.hledger.journal'); or you can specify files with '-f' options.
one or more '-f FILE' options, or the 'LEDGER_FILE' environment It can also read timeclock files, timedot files, or any CSV/SSV/TSV file
variable. For more about this see hledger(1). with a date field. (See hledger(1) -> Input for details.)
hledger-web can be run in three modes: hledger-web can be run in three modes:
@ -69,7 +69,6 @@ requests to stdout.
* JSON API:: * JSON API::
* DEBUG OUTPUT:: * DEBUG OUTPUT::
* ENVIRONMENT:: * ENVIRONMENT::
* FILES::
* BUGS:: * BUGS::
 
@ -227,18 +226,30 @@ before options, as shown in the synopsis above.
convert amounts to cost or market value, more flexibly than convert amounts to cost or market value, more flexibly than
-B/-V/-X -B/-V/-X
'--infer-equity'
infer conversion equity postings from costs
'--infer-costs'
infer costs from conversion equity postings
'--infer-market-prices' '--infer-market-prices'
use transaction prices (recorded with @ or @@) as additional market use costs as additional market prices, as if they were P directives
prices, as if they were P directives
'--auto'
apply automated posting rules to modify transactions.
'--forecast' '--forecast'
generate future transactions from periodic transaction rules, for generate transactions from periodic rules, between the latest
the next 6 months or till report end date. In hledger-ui, also recorded txn and 6 months from today, or during the specified
make ordinary future transactions visible. PERIOD (= is required). Auto posting rules will be applied to
these transactions as well. Also, in hledger-ui make future-dated
transactions visible.
'--auto'
generate extra postings by applying auto posting rules to all txns
(not just forecast txns)
'--verbose-tags'
add visible tags indicating transactions or postings which have
been generated/modified
'--commodity-style' '--commodity-style'
Override the commodity style in the output for the specified Override the commodity style in the output for the specified
@ -596,94 +607,49 @@ can usually redirect stderr, eg:
'hledger-web --debug=3 2>hledger-web.log'. 'hledger-web --debug=3 2>hledger-web.log'.
 
File: hledger-web.info, Node: ENVIRONMENT, Next: FILES, Prev: DEBUG OUTPUT, Up: Top File: hledger-web.info, Node: ENVIRONMENT, Next: BUGS, Prev: DEBUG OUTPUT, Up: Top
7 ENVIRONMENT 7 ENVIRONMENT
************* *************
*LEDGER_FILE* The journal file path when not specified with '-f'. *LEDGER_FILE* The main journal file to use when not specified with
'-f/--file'. Default: '$HOME/.hledger.journal'.
On unix computers, the default value is: '~/.hledger.journal'.
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"
}
For this to take effect you might need to 'killall Dock', or reboot.
On Windows computers, the default value is probably
'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"
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 File: hledger-web.info, Node: BUGS, Prev: ENVIRONMENT, Up: Top
8 FILES 8 BUGS
*******
Reads data from one or more files in journal, timeclock, timedot, or CSV
format. The default file is '.hledger.journal' in your home directory;
this can be overridden with one or more '-f FILE' options, or the
'LEDGER_FILE' environment variable.

File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top
9 BUGS
****** ******
'-f-' doesn't work (hledger-web can't read from stdin). We welcome bug reports in the hledger issue tracker (shortcut:
http://bugs.hledger.org), or on the #hledger chat or hledger mail list
(https://hledger.org/support).
Query arguments and some hledger options are ignored. Some known issues:
Does not work in text-mode browsers. Does not work well on small screens, or in text-mode browsers.
Does not work well on small screens.
 
Tag Table: Tag Table:
Node: Top225 Node: Top225
Node: OPTIONS2683 Node: OPTIONS2702
Ref: #options2788 Ref: #options2807
Node: PERMISSIONS10225 Node: PERMISSIONS10607
Ref: #permissions10364 Ref: #permissions10746
Node: EDITING UPLOADING DOWNLOADING11576 Node: EDITING UPLOADING DOWNLOADING11958
Ref: #editing-uploading-downloading11757 Ref: #editing-uploading-downloading12139
Node: RELOADING12591 Node: RELOADING12973
Ref: #reloading12725 Ref: #reloading13107
Node: JSON API13158 Node: JSON API13540
Ref: #json-api13273 Ref: #json-api13655
Node: DEBUG OUTPUT18761 Node: DEBUG OUTPUT19143
Ref: #debug-output18886 Ref: #debug-output19268
Node: Debug output18913 Node: Debug output19295
Ref: #debug-output-119014 Ref: #debug-output-119396
Node: ENVIRONMENT19431 Node: ENVIRONMENT19813
Ref: #environment19551 Ref: #environment19932
Node: FILES20862 Node: BUGS20049
Ref: #files20962 Ref: #bugs20133
Node: BUGS21210
Ref: #bugs21288
 
End Tag Table End Tag Table

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

@ -17,8 +17,8 @@ DESCRIPTION
the hledger manual for common concepts and file formats. the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs for hledger is a robust, user-friendly, cross-platform set of programs for
tracking money, time, or any other commodity, using double-entry tracking money, time, or any other commodity, using double-entry ac-
accounting and a simple, editable file format. hledger is inspired by counting and a simple, editable file format. hledger is inspired by
and largely compatible with ledger(1), and largely interconvertible and largely compatible with ledger(1), and largely interconvertible
with beancount(1). with beancount(1).
@ -34,11 +34,11 @@ DESCRIPTION
against data loss when running an unprotected instance, it writes a against data loss when running an unprotected instance, it writes a
numbered backup of the main journal file (only) on every edit. numbered backup of the main journal file (only) on every edit.
Like hledger, it reads data from one or more files in journal, time- Like hledger, it reads from (and appends to) a journal file specified
clock, timedot, or CSV format. The default file is .hledger.journal in by the LEDGER_FILE environment variable (defaulting to
your home directory; this can be overridden with one or more -f FILE $HOME/.hledger.journal); or you can specify files with -f options. It
options, or the LEDGER_FILE environment variable. For more about this can also read timeclock files, timedot files, or any CSV/SSV/TSV file
see hledger(1). with a date field. (See hledger(1) -> Input for details.)
hledger-web can be run in three modes: hledger-web can be run in three modes:
@ -78,8 +78,8 @@ OPTIONS
--socket=SOCKETFILE --socket=SOCKETFILE
use a unix domain socket file to listen for requests instead of use a unix domain socket file to listen for requests instead of
a TCP socket. Implies --serve. It can only be used if the a TCP socket. Implies --serve. It can only be used if the op-
operating system can provide this type of socket. erating system can provide this type of socket.
--base-url=URL --base-url=URL
set the base url (default: http://IPADDR:PORT). Note: affects set the base url (default: http://IPADDR:PORT). Note: affects
@ -129,8 +129,8 @@ OPTIONS
assignments) assignments)
-s --strict -s --strict
do extra error checking (check that all posted accounts are do extra error checking (check that all posted accounts are de-
declared) clared)
hledger reporting options: hledger reporting options:
@ -162,8 +162,8 @@ OPTIONS
using period expressions syntax using period expressions syntax
--date2 --date2
match the secondary date instead (see command help for other match the secondary date instead (see command help for other ef-
effects) fects)
--today=DATE --today=DATE
override today's date (affects relative smart dates, for override today's date (affects relative smart dates, for
@ -202,16 +202,29 @@ OPTIONS
convert amounts to cost or market value, more flexibly than convert amounts to cost or market value, more flexibly than
-B/-V/-X -B/-V/-X
--infer-market-prices --infer-equity
use transaction prices (recorded with @ or @@) as additional infer conversion equity postings from costs
market prices, as if they were P directives
--auto apply automated posting rules to modify transactions. --infer-costs
infer costs from conversion equity postings
--infer-market-prices
use costs as additional market prices, as if they were P direc-
tives
--forecast --forecast
generate future transactions from periodic transaction rules, generate transactions from periodic rules, between the latest
for the next 6 months or till report end date. In hledger-ui, recorded txn and 6 months from today, or during the specified
also make ordinary future transactions visible. PERIOD (= is required). Auto posting rules will be applied to
these transactions as well. Also, in hledger-ui make future-
dated transactions visible.
--auto generate extra postings by applying auto posting rules to all
txns (not just forecast txns)
--verbose-tags
add visible tags indicating transactions or postings which have
been generated/modified
--commodity-style --commodity-style
Override the commodity style in the output for the specified Override the commodity style in the output for the specified
@ -289,8 +302,8 @@ PERMISSIONS
You can restrict who can reach it by You can restrict who can reach it by
o setting the IP address it listens on (see --host above). By default o setting the IP address it listens on (see --host above). By default
it listens on 127.0.0.1, accessible to all users on the local it listens on 127.0.0.1, accessible to all users on the local ma-
machine. chine.
o putting it behind an authenticating proxy, using eg apache or nginx o putting it behind an authenticating proxy, using eg apache or nginx
@ -306,8 +319,8 @@ PERMISSIONS
o add - allows adding new transactions to the main journal file o add - allows adding new transactions to the main journal file
o manage - allows editing, uploading or downloading the main or o manage - allows editing, uploading or downloading the main or in-
included files cluded files
o using the --capabilities-header=HTTPHEADER flag to specify a HTTP o using the --capabilities-header=HTTPHEADER flag to specify a HTTP
header from which it will read capabilities to enable. hledger-web header from which it will read capabilities to enable. hledger-web
@ -317,8 +330,8 @@ PERMISSIONS
EDITING, UPLOADING, DOWNLOADING EDITING, UPLOADING, DOWNLOADING
If you enable the manage capability mentioned above, you'll see a new If you enable the manage capability mentioned above, you'll see a new
"spanner" button to the right of the search form. Clicking this will "spanner" button to the right of the search form. Clicking this will
let you edit, upload, or download the journal file or any files it let you edit, upload, or download the journal file or any files it in-
includes. cludes.
Note, unlike any other hledger command, in this mode you (or any visi- Note, unlike any other hledger command, in this mode you (or any visi-
tor) can alter or wipe the data files. tor) can alter or wipe the data files.
@ -337,8 +350,8 @@ RELOADING
hledger-web detects changes made to the files by other means (eg if you hledger-web detects changes made to the files by other means (eg if you
edit it directly, outside of hledger-web), and it will show the new edit it directly, outside of hledger-web), and it will show the new
data when you reload the page or navigate to a new page. If a change data when you reload the page or navigate to a new page. If a change
makes a file unparseable, hledger-web will display an error message makes a file unparseable, hledger-web will display an error message un-
until the file has been fixed. til the file has been fixed.
(Note: if you are viewing files mounted from another machine, make sure (Note: if you are viewing files mounted from another machine, make sure
that both machine clocks are roughly in step.) that both machine clocks are roughly in step.)
@ -405,15 +418,15 @@ JSON API
Most of the JSON corresponds to hledger's data types; for details of Most of the JSON corresponds to hledger's data types; for details of
what the fields mean, see the Hledger.Data.Json haddock docs and click what the fields mean, see the Hledger.Data.Json haddock docs and click
on the various data types, eg Transaction. And for a higher level on the various data types, eg Transaction. And for a higher level un-
understanding, see the journal docs. derstanding, see the journal docs.
In some cases there is outer JSON corresponding to a "Report" type. To In some cases there is outer JSON corresponding to a "Report" type. To
understand that, go to the Hledger.Web.Handler.MiscR haddock and look understand that, go to the Hledger.Web.Handler.MiscR haddock and look
at the source for the appropriate handler to see what it returns. Eg at the source for the appropriate handler to see what it returns. Eg
for /accounttransactions it's getAccounttransactionsR, returning a for /accounttransactions it's getAccounttransactionsR, returning a "ac-
"accountTransactionsReport ...". Looking up the haddock for that we countTransactionsReport ...". Looking up the haddock for that we can
can see that /accounttransactions returns an AccountTransactionsReport, see that /accounttransactions returns an AccountTransactionsReport,
which consists of a report title and a list of AccountTransactionsRe- which consists of a report title and a list of AccountTransactionsRe-
portItem (etc). portItem (etc).
@ -517,8 +530,8 @@ JSON API
"tstatus": "Unmarked" "tstatus": "Unmarked"
} }
And here's how to test adding it with curl. This should add a new And here's how to test adding it with curl. This should add a new en-
entry to your journal: try to your journal:
$ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json $ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json
@ -533,61 +546,18 @@ DEBUG OUTPUT
hledger-web --debug=3 2>hledger-web.log. hledger-web --debug=3 2>hledger-web.log.
ENVIRONMENT ENVIRONMENT
LEDGER_FILE The journal file path when not specified with -f. LEDGER_FILE The main journal file to use when not specified with
-f/--file. Default: $HOME/.hledger.journal.
On unix computers, the default value is: ~/.hledger.journal.
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"
}
For this to take effect you might need to killall Dock, or reboot.
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"
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 journal, timeclock, timedot, or
CSV format. The default file is .hledger.journal in your home direc-
tory; this can be overridden with one or more -f FILE options, or the
LEDGER_FILE environment variable.
BUGS BUGS
-f- doesn't work (hledger-web can't read from stdin). We welcome bug reports in the hledger issue tracker (shortcut:
http://bugs.hledger.org), or on the #hledger chat or hledger mail list
(https://hledger.org/support).
Query arguments and some hledger options are ignored. Some known issues:
Does not work in text-mode browsers. Does not work well on small screens, or in text-mode browsers.
Does not work well on small screens.
REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger chat or
hledger mail list)
AUTHORS AUTHORS
@ -608,4 +578,4 @@ SEE ALSO
hledger-web-1.29.99 April 2023 HLEDGER-WEB(1) hledger-web-1.29.99 May 2023 HLEDGER-WEB(1)

2
hledger/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{April 2023}})m4_dnl m4_define({{_monthyear_}}, {{May 2023}})m4_dnl

1572
hledger/hledger.1
View File

File diff suppressed because it is too large Load Diff

3437
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

2180
hledger/hledger.txt
View File

File diff suppressed because it is too large Load Diff