use automake 1.11, autoconf 2.65
[abook.git] / abookrc.5
blob638b36fc752bafe54f4656cc6098db6788c12f12
1 .TH ABOOKRC 5 "Oct 25, 2005"
2 .nh
3 .SH NAME
4 \fB$HOME/.abook/abookrc\fP \- configuration file for abook address book program
5 .SH DESCRIPTION
6 This manual page documents briefly the
7 .B abookrc
8 file.
9 .br
10 .B abookrc
11 is the (optional) configuration file for use with the
12 .B abook(1)
13 address book program.
15 .B abookrc
16 is stored in a user's $HOME/.abook directory. It follows a format of
17 \(lq\fBset option=value\fP\(rq.
18 The following information lists each of these options and the values they
19 may take.
21 If a variable is not set in 
22 .B abookrc
23 , a sensible default, as 
24 listed with the description below, will be used.
26 Comments in 
27 .B abookrc
28 are on lines beginning with '#'.
30 .SH COMMANDS
32 .TP
33 \fBset\fP \fIoption\fP = \fIvalue\fP
35 .TP
36 \fBfield\fP \fIidentifier\fP = \fIhuman_readable_name\fP [ , \fItype\fP ]
37 Defines a new custom field. \fItype\fP can be one of 'string' (default)
38 , 'emails', 'list', or 'date'.
40 .TP
41 \fBview\fP \fIview name\fP = \fIfield1\fP [ , \fIfield2\fP, ... ]
42 Defines a view/tab, with \fIfieldN\fP being the identifier of a field
43 declared with the \fBfield\fP command, or the identifier of a standard field.
44 .IP
45 Standard fields:
46 .br
47         name, email,
48 .br
49         address, address2, city, state, zip, country,
50 .br
51         phone, workphone, fax, mobile,
52 .br
53         nick, url, notes, anniversary
54 .IP
55 Note: if you don't define any view, abook will use a default display based
56 on the above standard fields.
59 .SH VARIABLES
61 .TP
62 \fBautosave\fP=[true|false]
63 Defines whether the addressbook is automatically saved on exit. Default is true.
65 .TP
66 \fBpreserve_fields\fP=[all|standard|none]
67 Specifies how fields not declared with the \fBfield\fP command nor in a view
68 should be preserved while loading an abook database.
69 .RS
70 .TP
71 .B all
72 preserve any completely unknown field.
73 .TP
74 .B standard
75 only preserve the standard fields (see a list in the
76   description of the \fBview\fP command) and the legacy
77   'custom[1-5]' fields.
78 .TP
79 .B none
80 discards any unknown field.
81 .RE
82 .IP
83 Default is \fIstandard\fP.
85 .TP
86 \fBindex_format\fP=format_string
87 Defines the way entries are displayed in the main list. This is a string containing field names enclosed between braces, with an optional width limit specified by a number (right alignment if negative) after the field name and a colon, and an arbitrary number of alternative fields (first with non empty content is to be displayed) separated by vertical bars. For instance:
88 .RS
89 .TP
90 \fI{name:22}\fP
91 displays the \fIname\fP field with a maximal width of 22 characters.
92 .TP
93 \fI{phone:-13|workphone|mobile}\fP
94 displays (right aligned within a width of 13 characters), either the \fIphone\fP, \fIworkphone\fP or \fImobile\fP field, whichever being the first to be non-empty.
95 .RE
96 .IP
97 Default is \fI" {name:22} {email:40} {phone:12|workphone|mobile}"\fP
99 .TP
100 \fBshow_all_emails\fP=[true|false]
101 Defines whether all email addresses for a contact are shown in the main list view. Default is true.
104 .PD 0
105 \fBemailpos\fP
107 .PD 0
108 \fBextra_column\fP
110 .PD 0
111 \fBextra_alternative\fP
114 \fBextrapos\fP
115 Obsoleted by \fBindex_format\fP.
118 \fBmutt_return_all_emails\fP=[true|false]
119 Defines whether to return all email addresses matching the search criteria to a mutt query. Default is true.
122 \fBprint_command\fP=command
123 Defines the command to used when printing the addressbook. Default is "lpr".
126 \fBwww_command\fP=command
127 Defines the command used to start the web browser to view a contact's URL. Default is "lynx".
130 \fBaddress_style\fP=[eu|uk|us]
131 Defines the style of address formatting to be used when exporting as text / printing the database (European, UK, or USA). Default is European ("eu").
134 \fBuse_ascii_only\fP=[true|false]
135 This option allows you to force Abook use only ASCII characters. This option is useful if your terminal doesn't support non-ASCII characters. Default is false.
138 \fBadd_email_prevent_duplicates\fP=[true|false]
139 Defines whether to avoid adding addresses already in data. Default is false.
142 \fBsort_field\fP=field
143 Defines the field to be used by the "sort by field" command. Default is "nick" (Nickname/Alias).
146 \fBshow_cursor\fP=[true|false]
147 Defines if the cursor is visible in main display. Default is false.
149 .SH SAMPLE CONFIGURATION FILE
152 # sample abook configuration file
155 # Declare a few custom fields
156 field pager = Pager
157 field address_lines = Address, list
158 field birthday = Birthday, date
160 # Define how fields should be displayed in tabs
161 view CONTACT = name, email
162 view ADDRESS = address_lines, city, state, zip, country
163 view PHONE = phone, workphone, pager, mobile, fax
164 view OTHER = url, birthday
167 # Preserve any unknown field while loading an abook database
168 set preserve_fields=all
170 # Automatically save database on exit
171 set autosave=true
173 # Format of entries lines in list
174 set index_format=" {name:22} {email:40} {phone:12|workphone|mobile}"
176 # Show all email addresses in list
177 set show_all_emails=true
179 # Command used to start mutt
180 set mutt_command=mutt
182 # Return all email addresses to a mutt query
183 set mutt_return_all_emails=true
185 # Command used to print
186 set print_command=lpr
188 # Command used to start the web browser
189 set www_command=lynx
191 # Address style [eu|us|uk]
192 set address_style=eu
194 # Use ASCII characters only
195 set use_ascii_only=false
197 # Prevent double entry
198 set add_email_prevent_duplicates=false
200 # Field to be used with "sort by field" command
201 set sort_field=nick
203 # Show cursor in main display
204 set show_cursor=false
208 .SH SEE ALSO
209 .BR abook (1).
211 .SH AUTHORS
212 This manual page was written by Alan Ford <alan@whirlnet.co.uk> and
213 expanded by Cedric Duval <cedricduval@free.fr>.
216 .B abook
217 was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>