sfos/ledger
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[doc] Improve manpage

Browse source 
as suggested by:
%  mandoc -Tlint doc/ledger.1

[ci skip]
This commit is contained in:
Alexis Hildebrandt 2015-01-16 22:32:20 +01:00
parent 8cdc283d07
commit 31b9964e43
1 changed files with 2 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/ledger.1
View file

@ -1,5 +1,6 @@
.Dd March 23, 2012 .Dd March 23, 2012
.Dt ledger 1 .Dt LEDGER 1
.Os
.Sh NAME .Sh NAME
.Nm ledger .Nm ledger
.Nd Command-line, double-entry account reporting tool .Nd Command-line, double-entry account reporting tool
@ -13,7 +14,6 @@ Ledger is a command-line accounting tool based on the power and completeness
of double-entry accounting. It is only a reporting tool, which means it never of double-entry accounting. It is only a reporting tool, which means it never
modifies your data files, but it does offers a large selection of reports, and modifies your data files, but it does offers a large selection of reports, and
different ways to customize them to your liking. different ways to customize them to your liking.
.Pp
.Sh COMMANDS .Sh COMMANDS
Ledger accepts several top-level commands, each of which generates a different Ledger accepts several top-level commands, each of which generates a different
kind of basic report. Most of them accept a kind of basic report. Most of them accept a
@ -37,13 +37,11 @@ The following is a complete list of reporting commands accepted by Ledger:
Lists all accounts for postings matching the Lists all accounts for postings matching the
.Ar report-query . .Ar report-query .
.El .El
.Pp
.Bl -tag -width balance .Bl -tag -width balance
.It Nm balance Oo Ar report-query Oc .It Nm balance Oo Ar report-query Oc
Produces a balance report showing totals for all matching accounts, and Produces a balance report showing totals for all matching accounts, and
aggregate totals for parents of those accounts. Options most commonly used aggregate totals for parents of those accounts. Options most commonly used
with this command are: with this command are:
.Pp
.Bl -tag -compact -width "--collapse (-n)" .Bl -tag -compact -width "--collapse (-n)"
.It Fl \-basis Pq Fl B .It Fl \-basis Pq Fl B
Report in terms of cost basis, not amount or value. This is the only form of Report in terms of cost basis, not amount or value. This is the only form of
@ -275,9 +273,7 @@ Outputs data relating to the current report in XML format. It includes all
accounts and commodities involved in the report, plus the postings and the accounts and commodities involved in the report, plus the postings and the
transactions they are contained in. See the manual for more information. transactions they are contained in. See the manual for more information.
.El .El
.Pp
.Sh OPTIONS .Sh OPTIONS
.Pp
.Bl -tag -width -indent .Bl -tag -width -indent
.It Fl \-abbrev-len Ar INT .It Fl \-abbrev-len Ar INT
Set the minimum length an account can be abbreviated to if it doesn't Set the minimum length an account can be abbreviated to if it doesn't
@ -860,13 +856,11 @@ Assume 132 columns instead of 80.
Shorthand for Shorthand for
.Fl \-period Ar "yearly" . .Fl \-period Ar "yearly" .
.El .El
.Pp
.Sh PRE-COMMANDS .Sh PRE-COMMANDS
Pre-commands are useful when you aren't sure how a command or option Pre-commands are useful when you aren't sure how a command or option
will work. The difference between a pre-command and a regular command will work. The difference between a pre-command and a regular command
is that pre-commands ignore the journal data file completely, nor is is that pre-commands ignore the journal data file completely, nor is
the user's init file read. the user's init file read.
.Pp
.Bl -tag -width -indent .Bl -tag -width -indent
.It Nm args / query .It Nm args / query
Evaluate the given arguments and report how Ledger interprets it against Evaluate the given arguments and report how Ledger interprets it against
@ -890,7 +884,6 @@ Shows the insertion template that the
.Nm xact .Nm xact
sub-command generates. This is a debugging command. sub-command generates. This is a debugging command.
.El .El
.Pp
.Sh QUERIES .Sh QUERIES
The syntax for reporting queries can get somewhat complex. It is a series of The syntax for reporting queries can get somewhat complex. It is a series of
query terms with an implicit OR operator between them. The following terms query terms with an implicit OR operator between them. The following terms
@ -930,7 +923,6 @@ interpret parentheses, you should always escape them:
.Pp .Pp
.Dl ledger bal \e\\\&( assets or liab \e\\\&) and not food .Dl ledger bal \e\\\&( assets or liab \e\\\&) and not food
.El .El
.Pp
.Sh EXPRESSIONS .Sh EXPRESSIONS
.Bl -tag -width "partial_account" .Bl -tag -width "partial_account"
.It Nm account .It Nm account
@ -1000,11 +992,8 @@ for example:
.It Nm virtual .It Nm virtual
.It Nm xact .It Nm xact
.El .El
.Pp
.Sh ENTRIES .Sh ENTRIES
.Pp
.Sh FORMATS .Sh FORMATS
.Pp
.Sh DEBUG COMMANDS .Sh DEBUG COMMANDS
In addition to the regular reporting commands, Ledger also accepts several In addition to the regular reporting commands, Ledger also accepts several
debug commands: debug commands:
@ -1050,9 +1039,7 @@ Accepts a
and displays information about how it was parsed. See the section on and displays information about how it was parsed. See the section on
.Sx DRAFTS . .Sx DRAFTS .
.El .El
.Pp
.Sh FILES .Sh FILES
.TP 15
~/.ledgerrc ~/.ledgerrc
Your personal ledger initializations. Your personal ledger initializations.
.Sh SEE ALSO .Sh SEE ALSO