1 .TH ABOOKRC 5 "Oct 25, 2005"
4 \fB$HOME/.abook/abookrc\fP \- configuration file for abook address book program
6 This manual page documents briefly the
11 is the (optional) configuration file for use with the
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
21 If a variable is not set in
23 , a sensible default, as
24 listed with the description below, will be used.
28 are on lines beginning with '#'.
33 \fBset\fP \fIoption\fP = \fIvalue\fP
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'.
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.
49 address, address2, city, state, zip, country,
51 phone, workphone, fax, mobile,
53 nick, url, notes, anniversary
55 Note: if you don't define any view, abook will use a default display based
56 on the above standard fields.
62 \fBautosave\fP=[true|false]
63 Defines whether the addressbook is automatically saved on exit. Default is true.
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.
72 preserve any completely unknown field.
75 only preserve the standard fields (see a list in the
76 description of the \fBview\fP command) and the legacy
80 discards any unknown field.
83 Default is \fIstandard\fP.
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:
91 displays the \fIname\fP field with a maximal width of 22 characters.
93 \fI{phone:-12|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.
97 Default is \fI" {name:22} {email:40} {phone:12|workphone|mobile}"\fP
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.
111 \fBextra_alternative\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.
150 \fBuse_mouse\fP=[true|false]
151 Defines if navigation via the mouse is activated. Default is false.
154 \fBuse_colors\fP=[true|false]
155 Defines if the output of abook is colorized. Default is false.
159 \fBcolor_header_fg\fP=color
160 Foreground color for header bar
162 \fBcolor_header_bg\fP=color
163 Background color for header bar
165 \fBcolor_footer_fg\fP=color
166 Foreground color for footer bar
168 \fBcolor_footer_bg\fP=color
169 Background color for footer bar
171 \fBcolor_list_even_fg\fP=color
172 Foreground color for normal list entries with even index in the list (starting
175 \fBcolor_list_even_bg\fP=color
176 Background color for normal list entries with even index in the list (starting
179 \fBcolor_list_odd_fg\fP=color
180 Foreground color for normal list entries with odd index in the list (starting
183 \fBcolor_list_odd_bg\fP=color
184 Background color for normal list entries with odd index in the list (starting
187 \fBcolor_list_header_fg\fP=color
188 Foreground color for the list header
190 \fBcolor_list_header_bg\fP=color
191 Background color for the list header
193 \fBcolor_list_highlight_fg\fP=color
194 Foreground color for highlighted list entries
196 \fBcolor_list_highlight_bg\fP=color
197 Background color for highlighted list entries
199 \fBcolor_tab_border_fg\fP=color
200 Foreground color for tab borders on details page
202 \fBcolor_tab_border_bg\fP=color
203 Background color for tab borders on details page
205 \fBcolor_tab_label_fg\fP=color
206 Foreground color for tab labes on details page
208 \fBcolor_tab_label_bg\fP=color
209 Background color for tab labes on details page
211 \fBcolor_field_name_fg\fP=color
212 Foreground color for field names on details page
214 \fBcolor_field_name_bg\fP=color
215 Background color for field names on details page
217 \fBcolor_field_value_fg\fP=color
218 Foreground color for field values on details page
220 \fBcolor_field_value_bg\fP=color
221 Background color for field values on details page
223 Where \fBcolor\fP can be: default, black, red, green, yellow, blue, magenta, cyan, white
227 .SH SAMPLE CONFIGURATION FILE
230 # sample abook configuration file
233 # Declare a few custom fields
235 field address_lines = Address, list
236 field birthday = Birthday, date
238 # Define how fields should be displayed in tabs
239 view CONTACT = name, email
240 view ADDRESS = address_lines, city, state, zip, country
241 view PHONE = phone, workphone, pager, mobile, fax
242 view OTHER = url, birthday
245 # Preserve any unknown field while loading an abook database
246 set preserve_fields=all
248 # Automatically save database on exit
251 # Format of entries lines in list
252 set index_format=" {name:22} {email:40} {phone:12|workphone|mobile}"
254 # Show all email addresses in list
255 set show_all_emails=true
257 # Command used to start mutt
258 set mutt_command=mutt
260 # Return all email addresses to a mutt query
261 set mutt_return_all_emails=true
263 # Command used to print
264 set print_command=lpr
266 # Command used to start the web browser
269 # Address style [eu|us|uk]
272 # Use ASCII characters only
273 set use_ascii_only=false
275 # Prevent double entry
276 set add_email_prevent_duplicates=false
278 # Field to be used with "sort by field" command
281 # Show cursor in main display
282 set show_cursor=false
290 This manual page was written by Alan Ford <alan@whirlnet.co.uk> and
291 expanded by Cedric Duval <cedricduval@free.fr>.
295 was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>