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

[doc] Replace Nm with Sy, Cm, Pa in manpage

Browse source 
[ci skip]
This commit is contained in:
Alexis Hildebrandt 2015-01-23 13:41:12 +01:00
parent 37777c284c
commit ce4511a220
1 changed files with 69 additions and 69 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

138
doc/ledger.1
View file

@ -130,7 +130,7 @@ The prices are reported with the granularity of a single day.
Reports prices for all commodities in postings matching the Reports prices for all commodities in postings matching the
.Ar report-query . .Ar report-query .
Prices are reported down to the second, using the same format as the Prices are reported down to the second, using the same format as the
.Li ~/.pricedb .Pa ~/.pricedb
file. file.
.It Ic print Oo Ar report-query Oc .It Ic print Oo Ar report-query Oc
Prints out the full transactions of any matching postings using the same Prints out the full transactions of any matching postings using the same
@ -276,7 +276,7 @@ transactions they are contained in. See the manual for more information.
.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
fit inside the fit inside the
.Nm account-width . .Sy account-width .
If If
.Ar INT .Ar INT
is zero, then the is zero, then the
@ -284,7 +284,7 @@ account name will be truncated on the right. If
.Ar INT .Ar INT
is greater is greater
than than
.Nm account-width .Sy account-width
then the account will be truncated on the then the account will be truncated on the
left, with no shortening of the account names in order to fit into the left, with no shortening of the account names in order to fit into the
desired width. desired width.
@ -435,9 +435,9 @@ a
.Fl \-depth 2 .Fl \-depth 2
statement will print balances only for account with statement will print balances only for account with
two levels, i.e. two levels, i.e.
.Nm Expenses:Entertainment .Sy Expenses:Entertainment
but not but not
.Nm Expenses:entertainment:Dining . .Sy Expenses:entertainment:Dining .
This is a display predicate, which This is a display predicate, which
means it only affects display, not the total calculations. means it only affects display, not the total calculations.
.It Fl \-deviation Pq Fl D .It Fl \-deviation Pq Fl D
@ -825,16 +825,16 @@ report.
.It Fl \-unrealized-gains .It Fl \-unrealized-gains
Allow the user to specify what account name should be used for Allow the user to specify what account name should be used for
unrealized gains. Defaults to unrealized gains. Defaults to
.Nm "Equity:Unrealized Gains" . .Sy "Equity:Unrealized Gains" .
Often set in one's Often set in one's
.Nm ~/.ledgerrc .Pa ~/.ledgerrc
file to change the default. file to change the default.
.It Fl \-unrealized-losses .It Fl \-unrealized-losses
Allow the user to specify what account name should be used for Allow the user to specify what account name should be used for
unrealized gains. Defaults to unrealized gains. Defaults to
.Nm "Equity:Unrealized Losses" . .Sy "Equity:Unrealized Losses" .
Often set in one's Often set in one's
.Nm ~/.ledgerrc .Pa ~/.ledgerrc
file to change the default. file to change the default.
.It Fl \-unround .It Fl \-unround
Perform all calculations without rounding and display results to full Perform all calculations without rounding and display results to full
@ -909,16 +909,16 @@ Query on the payee, rather than the account.
Query on anything found in an item's note. Query on anything found in an item's note.
.It Ic code Ar regex Pq \&# Ns Ar regex .It Ic code Ar regex Pq \&# Ns Ar regex
Query on the xact's optional code (which can be any string the user wishes). Query on the xact's optional code (which can be any string the user wishes).
.It Ar term Nm and Ar term .It Ar term Cm and Ar term
Query terms are joined by an implicit OR operator. You can change this to AND Query terms are joined by an implicit OR operator. You can change this to AND
by using that keyword. For example, to show food expenditures occurring at by using that keyword. For example, to show food expenditures occurring at
Shakee's Pizza, you could say: Shakee's Pizza, you could say:
.Pp .Pp
.Dl ledger reg food and @Shakee .Dl Li ledger reg food and @Shakee
.It Ar term Nm or Ar term .It Ar term Cm or Ar term
When you wish to be more explicit, use the OR operator. When you wish to be more explicit, use the OR operator.
.It Nm show .It Ic show
.It Nm not Ar term .It Cm not Ar term
Reverse the logical meaning of the following term. This can be used with Reverse the logical meaning of the following term. This can be used with
parentheses to great effect: parentheses to great effect:
.Pp .Pp
@ -935,12 +935,12 @@ interpret parentheses, you should always escape them:
.It Fn abs value .It Fn abs value
Return the absolute value of the given Return the absolute value of the given
.Ar value . .Ar value .
.It Nm account .It Sy account
.It Nm account_base .It Sy account_base
.It Nm account_amount .It Sy account_amount
.It Nm actual .It Sy actual
.It Nm amount .It Sy amount
.It Nm amount_expr .It Sy amount_expr
.It Fn ansify_if value color bool .It Fn ansify_if value color bool
Render the given Render the given
.Ar value .Ar value
@ -949,33 +949,33 @@ as a string, applying the proper ANSI escape codes to display it in the given
if if
.Ar bool .Ar bool
is true. It typically checks the value of the option is true. It typically checks the value of the option
.Nm Fl \-color , .Fl \-color ,
for example: for example:
.Dl ansify_if(amount, "blue", options.color) .Dl Li ansify_if(amount, "blue", options.color)
.It Nm beg_line .It Sy beg_line
Line number where entry for posting begins. Line number where entry for posting begins.
.It Nm beg_pos .It Sy beg_pos
Character position where entry for posting begins. Character position where entry for posting begins.
.It Nm calculated .It Sy calculated
.It Nm cleared .It Sy cleared
.It Nm code .It Sy code
Return the transaction code, the string between the parenthesis after the date. Return the transaction code, the string between the parenthesis after the date.
.It Nm comment .It Sy comment
.It Nm commodity .It Sy commodity
Return the commodity of the posting amount. Return the commodity of the posting amount.
.It Nm cost .It Sy cost
.It Nm count .It Sy count
.It Nm date .It Sy date
Return the date of the posting. Return the date of the posting.
.It Nm depth .It Sy depth
.It Nm depth_spacer .It Sy depth_spacer
.It Nm display_amount .It Sy display_amount
.It Nm display_total .It Sy display_total
.It Nm end_line .It Sy end_line
Line number where entry for posting ends. Line number where entry for posting ends.
.It Nm end_pos .It Sy end_pos
Character position where entry for posting ends. Character position where entry for posting ends.
.It Nm filename .It Sy filename
The name of the ledger data file from whence the posting came. The name of the ledger data file from whence the posting came.
.It Fn format_date date format .It Fn format_date date format
Return the Return the
@ -985,45 +985,45 @@ as a string using
See See
.Xr strftime 3 .Xr strftime 3
for format string details. for format string details.
.It Nm get_at .It Sy get_at
.It Nm has_meta .It Sy has_meta
.It Nm has_tag .It Sy has_tag
.It Nm is_seq .It Sy is_seq
.It Nm join .It Sy join
.It Nm market .It Sy market
.It Nm meta .It Sy meta
.It Nm note .It Sy note
.It Nm null .It Sy null
.It Nm options .It Sy options
.It Nm partial_account .It Sy partial_account
.It Nm payee .It Sy payee
.It Sy pending
.It Fn percent value_a value_b .It Fn percent value_a value_b
Return the percentage of Return the percentage of
.Ar value_a .Ar value_a
in relation to in relation to
.Ar value_b . .Ar value_b .
.It Nm pending .It Sy post
.It Nm post .It Sy print
.It Nm print .It Sy quantity
.It Nm quantity
.It Fn quoted expression .It Fn quoted expression
Surround Surround
.Ar expression .Ar expression
with double-quotes. with double-quotes.
.It Nm real .It Sy real
.It Nm rounded .It Sy rounded
.It Nm scrub .It Sy scrub
.It Nm status .It Sy status
.It Nm strip .It Sy strip
.It Nm subcount .It Sy subcount
.It Nm tag .It Sy tag
.It Nm today .It Sy today
.It Nm total .It Sy total
.It Nm total_expr .It Sy total_expr
.It Nm truncate .It Sy truncate
.It Nm uncleared .It Sy uncleared
.It Nm virtual .It Sy virtual
.It Nm xact .It Sy xact
.El .El
.Sh ENTRIES .Sh ENTRIES
.Sh FORMATS .Sh FORMATS