abook.1

   1 .TH ABOOK 1 2006-09-06
   2 .nh
   3 .SH NAME
   4 abook \- text\-based address book program
   5 .SH SYNOPSIS
   6 .B abook
   7 [ \fIOPTION\fR ]
   8 .SH DESCRIPTION
   9 This manual page documents briefly the
  10 .B abook
  11 program.
  12 This manual page was written for the Debian GNU/Linux distribution
  13 because the original program does not have a manual page.
  14 .PP
  15 .B abook
  16 is a text-based address book program. It contains Name, Email, Address
  17 and various Phone fields. It is designed for use with mutt, but can be
  18 equally useful on its own.
  19 .SH OPTIONS
  20 .TP
  21 \fB\-h \-\-help\fP
  22 Show usage.
  23 .TP
  24 \fB\-C \-\-config\fP \fI<filename>\fR
  25 Use an alternative configuration file (default is \fI$HOME/.abook/abookrc\fR).
  26 .TP
  27 \fB\-\-datafile\fP \fI<filename>\fR
  28 Use an alternative addressbook file (default is \fI$HOME/.abook/addressbook\fR).
  29 .TP
  30 \fB\-\-mutt\-query\fP \fI<string>\fR [ \fB\-\-outformat\fP \fI<outputformat>\fR ]
  31 Make a query for mutt (search the addressbook for \fI<string>\fR).
  32 .br
  33 The \fB\-\-datafile\fP option, as documented above, may be used
  34 .BI BEFORE
  35 this option to search a different addressbook file.
  36 .br
  37 Only a subset of the below \fI<outputformat>\fR are allowed: \fBmutt\fP (default), \fBvcard\fP and \fBcustom\fP
  38 .TP
  39 \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 ]
  40 Converts \fI<inputfile>\fR in \fI<inputformat>\fR to \fI<outputfile>\fR in \fI<outputformat>\fR
  41 (defaults are \fBabook\fP, \fBstdin\fP, \fBtext\fP and \fBstdout\fP).
  42
  43 .br
  44 The following \fIinputformats\fR are supported:
  45 .br
  46 \- \fBabook\fP abook native format
  47 .br
  48 \- \fBldif\fP ldif / Netscape addressbook
  49 .br
  50 \- \fBmutt\fP mutt alias
  51 .br
  52 \- \fBpine\fP pine addressbook
  53 .br
  54 \- \fBcsv\fP comma separated values
  55 .br
  56 \- \fBpalmcsv\fP Palm comma separated values
  57 .br
  58 \- \fBvcard\fP VCard addressbook
  59
  60 .br
  61 The following \fIoutputformats\fR are supported:
  62 .br
  63 \- \fBabook\fP abook native format
  64 .br
  65 \- \fBldif\fP ldif / Netscape addressbook (.4ld)
  66 .br
  67 \- \fBmutt\fP mutt alias
  68 .br
  69 \- \fBhtml\fP html document
  70 .br
  71 \- \fBpine\fP pine addressbook
  72 .br
  73 \- \fBvcard\fP VCard addressbook
  74 .br
  75 \- \fBcsv\fP comma separated values
  76 .br
  77 \- \fBpalmcsv\fP Palm comma separated values
  78 .br
  79 \- \fBelm\fP elm alias
  80 .br
  81 \- \fBtext\fP plain text
  82 .br
  83 \- \fBspruce\fP Spruce address book
  84 .br
  85 \- \fBwl\fP Wanderlust address book
  86 .br
  87 \- \fBbsdcal\fP BSD calendar
  88 .br
  89 \- \fBcustom\fP Custom output format, see below
  90 .TP
  91 \fB\-\-outformatstr\fP \fI<string>\fR
  92 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.
  93 .br
  94 A placeholder can be any of the standard fields names (see \fBabookrc\fP(5)) and must be encapsulated by curly brackets.
  95 .br
  96 The default value is "{nick} ({name}): {mobile}"
  97 .br
  98 If \fI<string>\fR starts with \fI!\fR only entries whose all fields from \fI<string>\fR are non\-NULL are included.
  99 .TP
 100 \fB\-\-add\-email\fP
 101 Read an e\-mail message from stdin and add the sender to the addressbook.
 102 .TP
 103 \fB\-\-add\-email\-quiet\fP
 104 Same as \-\-add\-email but doesn't confirm adding.
 105 .TP
 106 \fB\-\-formats\fP
 107 List available formats.
 108
 109 .SH COMMANDS DURING USE
 110 Press '\fB?\fP' during use to get a list of commands.
 111 .SH SEE ALSO
 112 .BR mutt (1),
 113 .BR abookrc (5)
 114 .br
 115 .SH AUTHOR
 116 This manual page was written by Alan Ford <alan@whirlnet.co.uk>,
 117 for the Debian GNU/Linux system (but may be used by others).
 118
 119 .br
 120 .B abook
 121 was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>