summaryrefslogtreecommitdiff
path: root/doc/ledger.1
diff options
context:
space:
mode:
authorAlexis Hildebrandt <afh@surryhill.net>2015-01-19 17:27:43 +0100
committerAlexis Hildebrandt <afh@surryhill.net>2015-01-27 22:01:57 +0100
commit185656e191d5e0b3424f528b33956d2b4f917234 (patch)
treeaa85b7a6b7f031a0abf587a0421479f2ab36bb00 /doc/ledger.1
parent3d7eb241514e380fb6311ca666eaa31cb02acb48 (diff)
downloadfork-ledger-185656e191d5e0b3424f528b33956d2b4f917234.tar.gz
fork-ledger-185656e191d5e0b3424f528b33956d2b4f917234.tar.bz2
fork-ledger-185656e191d5e0b3424f528b33956d2b4f917234.zip
[doc] Add tests to value and format expressions
and change formatting for value expressions using @defun, @defvar.
Diffstat (limited to 'doc/ledger.1')
-rw-r--r--doc/ledger.120
1 files changed, 18 insertions, 2 deletions
diff --git a/doc/ledger.1 b/doc/ledger.1
index 03cd9dac..8aa0f474 100644
--- a/doc/ledger.1
+++ b/doc/ledger.1
@@ -956,6 +956,7 @@ Character position where entry for posting begins.
Return the transaction code, the string between the parenthesis after the date.
.It Nm comment
.It Nm commodity
+Return the commodity of the posting amount.
.It Nm cost
.It Nm count
.It Nm date
@@ -970,7 +971,14 @@ Line number where entry for posting ends.
Character position where entry for posting ends.
.It Nm filename
The name of the ledger data file from whence the posting came.
-.It Nm format_date
+.It Fn format_date date format
+Return the
+.Ar date
+as a string using
+.Ar format .
+See
+.Xr strftime 3
+for format string details.
.It Nm get_at
.It Nm has_meta
.It Nm has_tag
@@ -983,11 +991,19 @@ The name of the ledger data file from whence the posting came.
.It Nm options
.It Nm partial_account
.It Nm payee
+.It Fn percent value_a value_b
+Return the percentage of
+.Ar value_a
+in relation to
+.Ar value_b .
.It Nm pending
.It Nm post
.It Nm print
.It Nm quantity
-.It Nm quoted
+.It Fn quoted expression
+Surround
+.Ar expression
+with double-quotes.
.It Nm real
.It Nm rounded
.It Nm scrub