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