summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJohn Wiegley <johnw@newartisans.com>2016-11-12 16:55:06 -0800
committerGitHub <noreply@github.com>2016-11-12 16:55:06 -0800
commita5fa6d67ca94fdeb5eddf5196833b7b94738e729 (patch)
tree51ff6ca9bd7e612b2dde122590ed1d6b380cd81d /doc
parent65e7d09b5c561feaf29808ab633207551289a943 (diff)
parent37beb581812d788ebedbb325b58e8db7682cc3a4 (diff)
downloadfork-ledger-a5fa6d67ca94fdeb5eddf5196833b7b94738e729.tar.gz
fork-ledger-a5fa6d67ca94fdeb5eddf5196833b7b94738e729.tar.bz2
fork-ledger-a5fa6d67ca94fdeb5eddf5196833b7b94738e729.zip
Merge pull request #480 from ginabythebay/next
document quoted_rfc4180
Diffstat (limited to 'doc')
-rw-r--r--doc/ledger.14
-rw-r--r--doc/ledger3.texi13
2 files changed, 16 insertions, 1 deletions
diff --git a/doc/ledger.1 b/doc/ledger.1
index 80649496..141d245c 100644
--- a/doc/ledger.1
+++ b/doc/ledger.1
@@ -1283,6 +1283,10 @@ for values that have a per-unit cost.
Surround
.Ar expression
with double-quotes.
+.It Fn quoted_rfc4180 expression
+Surround
+.Ar expression
+with double-quotes, compatible with rfc 4180.
.It Sy real
.\" Is there a difference between real and actual?
Return true if the transaction is real, i.e not a automated or virtual
diff --git a/doc/ledger3.texi b/doc/ledger3.texi
index 4427b8e7..b26e8cf6 100644
--- a/doc/ledger3.texi
+++ b/doc/ledger3.texi
@@ -8360,7 +8360,18 @@ Return the quantity of @var{value} for values that have a per-unit cost.
@end defun
@defun quoted expression
-Surround @var{expression} with double-quotes.
+Surround @var{expression} with double-quotes. If expression contains a double-quote, it will be escaped with a backslash.
+@smallexample @c command:EAD8AA7,with_input:3406FC1
+$ ledger -f expr.dat --format "%(quoted(account)) %(quoted(amount))\n" reg
+@end smallexample
+@smallexample @c output:EAD8AA7
+"Assets:Cash" "¤ -123,45"
+"Expenses:Office Supplies" "¤ 123,45"
+@end smallexample
+@end defun
+
+@defun quoted_rfc4180 expression
+Surround @var{expression} with double-quotes, compliant with rfc 4180. If expression contains a double-quote, it will be represented with two double-quotes.
@smallexample @c command:EAD8AA7,with_input:3406FC1
$ ledger -f expr.dat --format "%(quoted(account)) %(quoted(amount))\n" reg
@end smallexample