summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/DEVELOP.md.new0
-rw-r--r--doc/ledger.126
-rw-r--r--doc/ledger3.texi36
3 files changed, 29 insertions, 33 deletions
diff --git a/doc/DEVELOP.md.new b/doc/DEVELOP.md.new
deleted file mode 100644
index e69de29b..00000000
--- a/doc/DEVELOP.md.new
+++ /dev/null
diff --git a/doc/ledger.1 b/doc/ledger.1
index b4746eb9..6995e2c8 100644
--- a/doc/ledger.1
+++ b/doc/ledger.1
@@ -333,7 +333,7 @@ Anonymize registry output, mostly for sending in bug reports.
.It Fl \-auto-match
.It Fl \-aux-date
Show auxiliary dates for all calculations.
-Alias for
+Alias for
.Fl \-effective
.It Fl \-average Pq Fl A
Print average values over the number of transactions instead of
@@ -408,7 +408,7 @@ Shorthand for
.Nm --limit 'date <= today' .
.It Fl \-daily Pq Fl D
Shorthand for
-.Nm --period 'daily' .
+.Nm --period Ar 'daily' .
.It Fl \-date Ar EXPR
Transform the date of the transaction using
.Ar EXPR .
@@ -501,7 +501,7 @@ Print the first
.Ar INT
entries. Opposite of
.Fl \-tail Ar INT .
-Alias for
+Alias for
.Fl \-head .
.It Fl \-flat
Force the full names of accounts to be used in the balance report. The
@@ -582,7 +582,7 @@ report.
Alias for
.Fl \-tail .
.It Fl \-leeway Ar INT Pq Fl Z
-Alias for
+Alias for
.Fl \-price-expr .
.It Fl \-limit Ar EXPR Pq Fl l
Limit postings in calculations.
@@ -612,7 +612,7 @@ Specify the width of the Meta column used for the
options.
.It Fl \-monthly Pq Fl M
Shorthand for
-.Fl \-period 'monthly' .
+.Fl \-period Ar 'monthly' .
.It Fl \-no-aliases
Aliases are completely ignored.
.It Fl \-no-color
@@ -714,7 +714,7 @@ Show primary dates for all calculations. Alias for
Report commodity totals (this is the default).
.It Fl \-quarterly
Synonym for
-\Fl \-period 'quarterly' .
+\Fl \-period Ar 'quarterly' .
.It Fl \-raw
In the
.Nm print
@@ -739,7 +739,7 @@ of the transaction.
.It Fl \-related-all
Show all postings in a transaction, similar to
.Fl \-related
-but show
+but show
.Nm both sides
of each transaction.
.It Fl \-revalued
@@ -834,12 +834,12 @@ ledger will produce memory trace information.
Print version information and exit.
.It Fl \-weekly Pq Fl W
Synonym for
-.Fl \-period 'weekly' .
+.Fl \-period Ar 'weekly' .
.It Fl \-wide Pq Fl w
Assume 132 columns instead of 80.
.It Fl \-yearly Pq Fl Y
Synonym for
-.Fl \-period 'yearly' .
+.Fl \-period Ar 'yearly' .
.El
.Pp
.Sh PRE-COMMANDS
@@ -868,8 +868,8 @@ Evaluate the given period and report how Ledger interprets it.
.It Nm script
.It Nm template
Shows the insertion template that the
-.Nm xact sub-command generates.
-This is a debugging command.
+.Nm xact
+sub-command generates. This is a debugging command.
.El
.Pp
.Sh QUERIES
@@ -984,7 +984,7 @@ for example:
.Pp
.Sh ENTRIES
.Pp
-.Sh FORMATS
+.Sh FORMATS
.Pp
.Sh DEBUG COMMANDS
In addition to the regular reporting commands, Ledger also accepts several
@@ -1033,7 +1033,7 @@ and displays information about how it was parsed. See the section on
.El
.Pp
.Sh SEE ALSO
-.Xr beancount 1,
+.Xr beancount 1 ,
.Xr hledger 1
.Sh AUTHORS
.An "John Wiegley"
diff --git a/doc/ledger3.texi b/doc/ledger3.texi
index 8df5edc0..1d88df53 100644
--- a/doc/ledger3.texi
+++ b/doc/ledger3.texi
@@ -5770,31 +5770,27 @@ Specify the location of the init file. The default is @file{~/.ledgerrc}.
Display the options in effect for this Ledger invocation, along with
their values and the source of those values, for example:
-@smallexample
-$ ledger --options bal --cleared -f ~/ledger/test/input/drewr3.dat
-===========================================================================
+@smallexample @c command:A9349E4,with_input:03ACB97
+$ ledger --options bal --cleared
+@end smallexample
+
+@smallexample @c output:A9349E4
+===============================================================================
[Global scope options]
+ --args-only --args-only
[Session scope options]
- --file = ~/ledger/test/input/drewr3.dat -f
- --price-db = ~/FinanceData/PriceDB $price-db
+ --file = A9349E4.dat --file
[Report scope options]
- --cleared --cleared
- --color ?normalize
- --date-format = %Y/%m/%d $date-format
- --limit = cleared --cleared
- --prepend-width = 0 ?normalize
- --meta-width = 0 ?normalize
- --date-width = 10 ?normalize
- --payee-width = 21 ?normalize
- --account-width = 21 ?normalize
- --amount-width = 12 ?normalize
- --total-width = 12 ?normalize
-===========================================================================
- $ 775.00 Assets:Checking
- $ -1,000.00 Equity:Opening Balances
- $ 225.00 Expenses:Food:Groceries
+ --cleared --cleared
+ --columns = 80 --columns
+ --limit = cleared --cleared
+===============================================================================
+ $15.00 Expenses
+ $12.45 Food
+ $2.55 Tips
+ $-15.00 Liabilities:MasterCard
--------------------
0
@end smallexample