use automake 1.11, autoconf 2.65
[abook.git] / abook.1
blobbb7ed4e831e4e93b158a9d8c2b12823be58d58aa
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).
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
56 .br
57 The following \fIoutputformats\fR are supported:
58 .br
59 - \fBabook\fP abook native format
60 .br
61 - \fBldif\fP ldif / Netscape addressbook (.4ld)
62 .br
63 - \fBmutt\fP mutt alias
64 .br
65 - \fBhtml\fP html document
66 .br
67 - \fBpine\fP pine addressbook
68 .br
69 - \fBgcrd\fP GnomeCard (VCard) addressbook
70 .br
71 - \fBcsv\fP comma separated values
72 .br
73 - \fBpalmcsv\fP Palm comma separated values
74 .br
75 - \fBelm\fP elm alias
76 .br
77 - \fBtext\fP plain text
78 .br
79 - \fBspruce\fP Spruce address book
80 .br
81 - \fBwl\fP Wanderlust address book
82 .br
83 - \fBbsdcal\fP BSD calendar
84 .TP
85 \fB\-\-add-email\fP
86 Read an e-mail message from stdin and add the sender to the addressbook.
87 .TP
88 \fB\-\-add-email-quiet\fP
89 Same as --add-email but doesn't confirm adding.
90 .TP
91 \fB\-\-formats\fP
92 List available formats.
94 .SH COMMANDS DURING USE
95 Press '\fB?\fP' during use to get a list of commands.
96 .SH SEE ALSO
97 .BR mutt (1),
98 .BR abookrc (5)
99 .br
100 .SH AUTHOR
101 This manual page was written by Alan Ford <alan@whirlnet.co.uk>,
102 for the Debian GNU/Linux system (but may be used by others).
105 .B abook
106 was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>