Upload 0.6.1-2 to unstable

[pkg/abook.git] / abook.1

diff --git a/abook.1 b/abook.1
index 398ac7ce7b2adca7f3975b7a3ab419e616f70047..26282004e12710723a01ee631700a93380862c2d 100644 (file)
--- a/abook.1
+++ b/abook.1
@@ -1,10 +1,10 @@
-.TH ABOOK 1 "March 18, 2000"
+.TH ABOOK 1 2006-09-06
 .nh
 .SH NAME
-abook \- text-based address book program
+abook \- text\-based address book program
 .SH SYNOPSIS
 .B abook
-[ \fB--help\fP | \fB--datafile\fP <filename> | \fB--mutt-query\fP <string> | \fB--convert\fP <inputformat> <inputfile> <outputformat> <outputfile> | \fB--add-email\fP | \fB--add-email-quiet\fP ] 
+[ \fIOPTION\fR ]
 .SH DESCRIPTION
 This manual page documents briefly the
 .B abook
@@ -18,56 +18,93 @@ and various Phone fields. It is designed for use with mutt, but can be
 equally useful on its own.
 .SH OPTIONS
 .TP
-\fB\-\-help\fP
+\fB\-h \-\-help\fP
 Show usage.
 .TP
-\fB\-\-datafile\fP <filename>
-Use an alternative addressbook file (default is $HOME/.abook.addressbook).
+\fB\-C \-\-config\fP \fI<filename>\fR
+Use an alternative configuration file (default is \fI$HOME/.abook/abookrc\fR).
 .TP
-\fB\-\-mutt-query\fP <string>
-Make a query for mutt (search the addressbook for <string>).
+\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\-\-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
-The \fB\-\-datafile\fP option, as documented above, may be used BEFORE this
-option to search a different addressbook file.
+Only a subset of the below \fI<outputformat>\fR are allowed: \fBmutt\fP (default), \fBvcard\fP and \fBcustom\fP
 .TP
-\fB\-\-convert\fP <inputformat> <inputfile> <outputformat> <outputfile>
-Converts <inputfile> in <inputformat> to <outputfile> in <outputformat>
+\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
+(defaults are \fBabook\fP, \fBstdin\fP, \fBtext\fP and \fBstdout\fP).
 
 .br
-The following \fBinputformats\fP are supported:
+The following \fIinputformats\fR are supported:
+.br
+\- \fBabook\fP abook native format
+.br
+\- \fBldif\fP ldif / Netscape addressbook
 .br
-- \fBabook\fP abook native format
+\- \fBmutt\fP mutt alias
 .br
-- \fBldif\fP ldif / Netscape addressbook
+\- \fBpine\fP pine addressbook
 .br
-- \fBpine\fP pine addressbook
+\- \fBcsv\fP comma separated values
 .br
-- \fBcsv\fP comma separated values
+\- \fBpalmcsv\fP Palm comma separated values
+.br
+\- \fBvcard\fP VCard addressbook
 
 .br
-The following \fBoutputformats\fP are supported:
+The following \fIoutputformats\fR are supported:
+.br
+\- \fBabook\fP abook native format
+.br
+\- \fBldif\fP ldif / Netscape addressbook (.4ld)
+.br
+\- \fBmutt\fP mutt alias
 .br
-- \fBabook\fP abook native format
+\- \fBhtml\fP html document
 .br
-- \fBmutt\fP mutt alias
+\- \fBpine\fP pine addressbook
 .br
-- \fBhtml\fP html document
+\- \fBvcard\fP VCard addressbook
 .br
-- \fBpine\fP pine addressbook
+\- \fBcsv\fP comma separated values
 .br
-- \fBgcrd\fP GnomeCard (VCard) addressbook
+\- \fBpalmcsv\fP Palm comma separated values
 .br
-- \fBcsv\fP comma separated values
+\- \fBelm\fP elm alias
 .br
-- \fBelm\fP elm alias
+\- \fBtext\fP plain text
 .br
-- \fBtext\fP plain text
+\- \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.
 .TP
-\fB\-\-add-email\fP
-Read an e-mail message from stdin and add the sender to the addressbook.
+\fB\-\-add\-email\-quiet\fP
+Same as \-\-add\-email but doesn't confirm adding.
 .TP
-\fB\-\-add-email-quiet\fP
-Same as --add-email but doesn't confirm adding.
+\fB\-\-formats\fP
+List available formats.
 
 .SH COMMANDS DURING USE
 Press '\fB?\fP' during use to get a list of commands.