]> git.deb.at Git - pkg/abook.git/commitdiff
custom output format (4/4): document custom output format in abook(1)
authorRaphaël Droz <raphael.droz+floss@gmail.com>
Wed, 24 Oct 2012 16:22:55 +0000 (18:22 +0200)
committerRaphaël Droz <raphael.droz+floss@gmail.com>
Wed, 24 Oct 2012 16:24:43 +0000 (18:24 +0200)
abook.1

diff --git a/abook.1 b/abook.1
index a1d5a72fb08e9cf67ad6f5cab4105bcf83d585ce..3e37f98c6773345e346af4603ed8d796e0ef45fd 100644 (file)
--- a/abook.1
+++ b/abook.1
@@ -83,6 +83,15 @@ The following \fIoutputformats\fR are supported:
 - \fBwl\fP Wanderlust address book
 .br
 - \fBbsdcal\fP BSD calendar
+.br
+- \fBcustom\fP Custom output format, see below
+.TP
+\fB\-\-outformatstr\fP \fI<string>\fR
+Only used in the context of \fB\-\-mutt\-query\fP \fIand\fR \fB\-\-outformat\fP=\fIcustom\fR. \fI<string>\fR is a format string allowing placeholders.
+A placeholder can be any of the standard fields names (see \fBabookrc\fP(5)) and must be
+encapsulated by curly brackets.
+The default value is "{nick} ({name}): {mobile}"
+If \fI<string>\fR starts with \fI!\fR only entries whose every fields from \fI<string>\fR are non-NULL are part of the output.
 .TP
 \fB\-\-add-email\fP
 Read an e-mail message from stdin and add the sender to the addressbook.