summaryrefslogtreecommitdiff
path: root/hledger-ui.txt
diff options
context:
space:
mode:
Diffstat (limited to 'hledger-ui.txt')
-rw-r--r--hledger-ui.txt69
1 files changed, 36 insertions, 33 deletions
diff --git a/hledger-ui.txt b/hledger-ui.txt
index 82c5ba3..ac88077 100644
--- a/hledger-ui.txt
+++ b/hledger-ui.txt
@@ -4,40 +4,41 @@ HLEDGER-UI(1) hledger User Manuals HLEDGER-UI(1)
NAME
- A terminal interface (TUI) for the hledger accounting tool.
+ hledger-ui is a terminal interface (TUI) for the hledger accounting
+ tool. This manual is for hledger-ui 1.21.
SYNOPSIS
hledger-ui [OPTIONS] [QUERYARGS]
hledger ui -- [OPTIONS] [QUERYARGS]
DESCRIPTION
- hledger is a reliable, cross-platform set of programs for tracking
- money, time, or any other commodity, using double-entry accounting and
- a simple, editable file format. hledger is inspired by and largely
+ hledger is a reliable, cross-platform set of programs for tracking
+ money, time, or any other commodity, using double-entry accounting and
+ a simple, editable file format. hledger is inspired by and largely
compatible with ledger(1).
- hledger-ui is hledger's terminal interface, providing an efficient
- full-window text UI for viewing accounts and transactions, and some
- limited data entry capability. It is easier than hledger's command-
- line interface, and sometimes quicker and more convenient than the web
+ hledger-ui is hledger's terminal interface, providing an efficient
+ full-window text UI for viewing accounts and transactions, and some
+ limited data entry capability. It is easier than hledger's command-
+ line interface, and sometimes quicker and more convenient than the web
interface.
- Like hledger, it reads data from one or more files in hledger journal,
- timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE,
- or $HOME/.hledger.journal (on windows, perhaps
- C:/Users/USER/.hledger.journal). For more about this see hledger(1),
+ Like hledger, it reads data from one or more files in hledger journal,
+ timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE,
+ or $HOME/.hledger.journal (on windows, perhaps
+ C:/Users/USER/.hledger.journal). For more about this see hledger(1),
hledger_journal(5) etc.
- Unlike hledger, hledger-ui hides all future-dated transactions by
- default. They can be revealed, along with any rule-generated periodic
- transactions, by pressing the F key (or starting with --forecast) to
+ Unlike hledger, hledger-ui hides all future-dated transactions by
+ default. They can be revealed, along with any rule-generated periodic
+ transactions, by pressing the F key (or starting with --forecast) to
enable "forecast mode".
OPTIONS
- Note: if invoking hledger-ui as a hledger subcommand, write -- before
+ Note: if invoking hledger-ui as a hledger subcommand, write -- before
options as shown above.
- Any QUERYARGS are interpreted as a hledger search query which filters
+ Any QUERYARGS are interpreted as a hledger search query which filters
the data.
--watch
@@ -50,7 +51,7 @@ OPTIONS
start in the (first) matched account's register screen
--change
- show period balances (changes) at startup instead of historical
+ show period balances (changes) at startup instead of historical
balances
-l --flat
@@ -66,7 +67,7 @@ OPTIONS
$LEDGER_FILE or $HOME/.hledger.journal)
--rules-file=RULESFILE
- Conversion rules file to use when reading CSV (default:
+ Conversion rules file to use when reading CSV (default:
FILE.rules)
--separator=CHAR
@@ -85,7 +86,7 @@ OPTIONS
assignments)
-s --strict
- do extra error checking (check that all posted accounts are
+ do extra error checking (check that all posted accounts are
declared)
hledger reporting options:
@@ -112,11 +113,11 @@ OPTIONS
multiperiod/multicolumn report by year
-p --period=PERIODEXP
- set start date, end date, and/or reporting interval all at once
+ set start date, end date, and/or reporting interval all at once
using period expressions syntax
--date2
- match the secondary date instead (see command help for other
+ match the secondary date instead (see command help for other
effects)
-U --unmarked
@@ -135,25 +136,26 @@ OPTIONS
hide/aggregate accounts or postings more than NUM levels deep
-E --empty
- show items with zero amount, normally hidden (and vice-versa in
+ show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
-B --cost
convert amounts to their cost/selling amount at transaction time
-V --market
- convert amounts to their market value in default valuation com-
+ convert amounts to their market value in default valuation com-
modities
-X --exchange=COMM
convert amounts to their market value in commodity COMM
--value
- convert amounts to cost or market value, more flexibly than
+ convert amounts to cost or market value, more flexibly than
-B/-V/-X
- --infer-value
- with -V/-X/--value, also infer market prices from transactions
+ --infer-market-prices
+ use transaction prices (recorded with @ or @@) as additional
+ market prices, as if they were P directives
--auto apply automated posting rules to modify transactions.
@@ -177,10 +179,14 @@ OPTIONS
hledger help options:
-h --help
- show general usage (or after COMMAND, command usage)
+ show general or COMMAND help
+
+ --man show general or COMMAND user manual with man
+
+ --info show general or COMMAND user manual with info
--version
- show version
+ show general or ADDONCMD version
--debug[=N]
show debug output (levels 1-9, default: 1)
@@ -455,9 +461,6 @@ COPYRIGHT
SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
- hledger_journal(5), hledger_csv(5), hledger_timeclock(5), hledger_time-
- dot(5)
-
-hledger-ui-1.20.4 December 2020 HLEDGER-UI(1)
+hledger-ui-1.21 December 2020 HLEDGER-UI(1)