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
  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 .TP
  37 \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 ]
  38 Converts \fI<inputfile>\fR in \fI<inputformat>\fR to \fI<outputfile>\fR in \fI<outputformat>\fR
  39 (defaults are \fBabook\fP, \fBstdin\fP, \fBtext\fP and \fBstdout\fP).
  40
  41 .br
  42 The following \fIinputformats\fR are supported:
  43 .br
  44 - \fBabook\fP abook native format
  45 .br
  46 - \fBldif\fP ldif / Netscape addressbook
  47 .br
  48 - \fBmutt\fP mutt alias
  49 .br
  50 - \fBpine\fP pine addressbook
  51 .br
  52 - \fBcsv\fP comma separated values
  53 .br
  54 - \fBpalmcsv\fP Palm comma separated values
  55 .br
  56 - \fBvcard\fP VCard addressbook
  57
  58 .br
  59 The following \fIoutputformats\fR are supported:
  60 .br
  61 - \fBabook\fP abook native format
  62 .br
  63 - \fBldif\fP ldif / Netscape addressbook (.4ld)
  64 .br
  65 - \fBmutt\fP mutt alias
  66 .br
  67 - \fBhtml\fP html document
  68 .br
  69 - \fBpine\fP pine addressbook
  70 .br
  71 - \fBvcard\fP VCard addressbook
  72 .br
  73 - \fBcsv\fP comma separated values
  74 .br
  75 - \fBpalmcsv\fP Palm comma separated values
  76 .br
  77 - \fBelm\fP elm alias
  78 .br
  79 - \fBtext\fP plain text
  80 .br
  81 - \fBspruce\fP Spruce address book
  82 .br
  83 - \fBwl\fP Wanderlust address book
  84 .br
  85 - \fBbsdcal\fP BSD calendar
  86 .br
  87 - \fBcustom\fP Custom output format, see below
  88 .TP
  89 \fB\-\-outformatstr\fP \fI<string>\fR
  90 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.
  91 A placeholder can be any of the standard fields names (see \fBabookrc\fP(5)) and must be
  92 encapsulated by curly brackets.
  93 The default value is "{nick} ({name}): {mobile}"
  94 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.
  95 .TP
  96 \fB\-\-add-email\fP
  97 Read an e-mail message from stdin and add the sender to the addressbook.
  98 .TP
  99 \fB\-\-add-email-quiet\fP
 100 Same as --add-email but doesn't confirm adding.
 101 .TP
 102 \fB\-\-formats\fP
 103 List available formats.
 104
 105 .SH COMMANDS DURING USE
 106 Press '\fB?\fP' during use to get a list of commands.
 107 .SH SEE ALSO
 108 .BR mutt (1),
 109 .BR abookrc (5)
 110 .br
 111 .SH AUTHOR
 112 This manual page was written by Alan Ford <alan@whirlnet.co.uk>,
 113 for the Debian GNU/Linux system (but may be used by others).
 114
 115 .br
 116 .B abook
 117 was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>