misc: release notes updated

[pkg/abook.git] / abook.1

diff --git a/abook.1 b/abook.1
index 42e0b5fea956a29da890ac76e1461eda3b121bce..cec604759956598a9514c9f8e9028880ce698da3 100644 (file)
--- a/abook.1
+++ b/abook.1
@@ -1,4 +1,4 @@
-.TH ABOOK 1 "June 6, 2003"
+.TH ABOOK 1 2006-09-06
 .nh
 .SH NAME
 abook \- text-based address book program
@@ -27,12 +27,14 @@ Use an alternative configuration file (default is \fI$HOME/.abook/abookrc\fR).
 \fB\-\-datafile\fP \fI<filename>\fR
 Use an alternative addressbook file (default is \fI$HOME/.abook/addressbook\fR).
 .TP
-\fB\-\-mutt\-query\fP \fI<string>\fR
+\fB\-\-mutt\-query\fP \fI<string>\fR [ \fB\-\-outformat\fP \fI<outputformat>\fR ]
 Make a query for mutt (search the addressbook for \fI<string>\fR).
 .br
 The \fB\-\-datafile\fP option, as documented above, may be used
 .BI BEFORE
 this option to search a different addressbook file.
+.br
+Only a subset of the below \fI<outputformat>\fR are allowed: \fBmutt\fP (default), \fBvcard\fP and \fBcustom\fP
 .TP
 \fB\-\-convert\fP [ \fB\-\-informat\fP \fI<inputformat>\fR ] [ \fB\-\-infile\fP \fI<inputfile>\fR ] [ \fB\-\-outformat\fP \fI<outputformat>\fR ] [ \fB\-\-outfile\fP \fI<outputfile>\fR ]
 Converts \fI<inputfile>\fR in \fI<inputformat>\fR to \fI<outputfile>\fR in \fI<outputformat>\fR
@@ -50,6 +52,10 @@ The following \fIinputformats\fR are supported:
 - \fBpine\fP pine addressbook
 .br
 - \fBcsv\fP comma separated values
+.br
+- \fBpalmcsv\fP Palm comma separated values
+.br
+- \fBvcard\fP VCard addressbook
 
 .br
 The following \fIoutputformats\fR are supported:
@@ -64,7 +70,7 @@ The following \fIoutputformats\fR are supported:
 .br
 - \fBpine\fP pine addressbook
 .br
-- \fBgcrd\fP GnomeCard (VCard) addressbook
+- \fBvcard\fP VCard addressbook
 .br
 - \fBcsv\fP comma separated values
 .br
@@ -75,6 +81,21 @@ The following \fIoutputformats\fR are supported:
 - \fBtext\fP plain text
 .br
 - \fBspruce\fP Spruce address book
+.br
+- \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 if \fB\-\-mutt\-query\fP \fIor\fR \fB\-\-convert\fP is specified \fIand\fR \fB\-\-outformat\fP=\fIcustom\fR. \fI<string>\fR is a format string allowing placeholders.
+.br
+A placeholder can be any of the standard fields names (see \fBabookrc\fP(5)) and must be encapsulated by curly brackets.
+.br
+The default value is "{nick} ({name}): {mobile}"
+.br
+If \fI<string>\fR starts with \fI!\fR only entries whose all fields from \fI<string>\fR are non-NULL are included.
 .TP
 \fB\-\-add-email\fP
 Read an e-mail message from stdin and add the sender to the addressbook.