From: Raphaël Droz <raphael.droz+floss@gmail.com>
Date: Wed, 24 Oct 2012 16:22:55 +0000 (+0200)
Subject: custom output format (4/4): document custom output format in abook(1)
X-Git-Tag: upstream/0.6.1~2^2~49
X-Git-Url: https://git.deb.at/?p=pkg%2Fabook.git;a=commitdiff_plain;h=e412bbaaf492422e593312d7768f5b7e8261eb58

custom output format (4/4): document custom output format in abook(1)
---

diff --git a/abook.1 b/abook.1
index a1d5a72..3e37f98 100644
--- 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.