]> git.deb.at Git - pkg/abook.git/blob - abook.1
man page updated
[pkg/abook.git] / abook.1
1 .TH ABOOK 1 "March 18, 2000"
2 .nh
3 .SH NAME
4 abook \- text-based address book program
5 .SH SYNOPSIS
6 .B abook
7 [ \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 ] 
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\-\-help\fP
22 Show usage.
23 .TP
24 \fB\-\-datafile\fP <filename>
25 Use an alternative addressbook file (default is $HOME/.abook.addressbook).
26 .TP
27 \fB\-\-mutt-query\fP <string>
28 Make a query for mutt (search the addressbook for <string>).
29 .br
30 The \fB\-\-datafile\fP option, as documented above, may be used BEFORE this
31 option to search a different addressbook file.
32 .TP
33 \fB\-\-convert\fP <inputformat> <inputfile> <outputformat> <outputfile>
34 Converts <inputfile> in <inputformat> to <outputfile> in <outputformat>
35
36 .br
37 The following \fBinputformats\fP are supported:
38 .br
39 - \fBabook\fP abook native format
40 .br
41 - \fBldif\fP ldif / Netscape addressbook
42 .br
43 - \fBmutt\fP mutt alias
44 .br
45 - \fBpine\fP pine addressbook
46 .br
47 - \fBcsv\fP comma separated values
48
49 .br
50 The following \fBoutputformats\fP are supported:
51 .br
52 - \fBabook\fP abook native format
53 .br
54 - \fBldif\fP ldif / Netscape addressbook (.4ld)
55 .br
56 - \fBmutt\fP mutt alias
57 .br
58 - \fBhtml\fP html document
59 .br
60 - \fBpine\fP pine addressbook
61 .br
62 - \fBgcrd\fP GnomeCard (VCard) addressbook
63 .br
64 - \fBcsv\fP comma separated values
65 .br
66 - \fBelm\fP elm alias
67 .br
68 - \fBtext\fP plain text
69 .br
70 - \fBspruce\fP Spruce address book
71 .TP
72 \fB\-\-add-email\fP
73 Read an e-mail message from stdin and add the sender to the addressbook.
74 .TP
75 \fB\-\-add-email-quiet\fP
76 Same as --add-email but doesn't confirm adding.
77
78 .SH COMMANDS DURING USE
79 Press '\fB?\fP' during use to get a list of commands.
80 .SH SEE ALSO
81 .BR mutt (1),
82 .BR abookrc (5)
83 .br
84 .SH AUTHOR
85 This manual page was written by Alan Ford <alan@whirlnet.co.uk>,
86 for the Debian GNU/Linux system (but may be used by others).
87
88 .br
89 .B abook
90 was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>