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 'day'.
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.
82 Default is \fIstandard\fP.
86 \fBshow_all_emails\fP=[true|false]
87 Defines whether all email addresses for a contact are shown in the main list view. Default is true
91 Defines the screen column on the main list where the email address is to begin. Default is 25.
94 \fBextra_column\fP=field
95 Defines the field to display in the extra (third) column on the main list. Default is "phone" (Home Phone).
97 \fIfield\fP can be any of the following:
116 \fBextra_alternative\fP=field
117 This is an optional setting that allows you to specify an alternative field to be displayed in the extra (third) column if there is no data for the field specified in extra_column for a particular item. The strings for the fields are the same as above. Please note that the data shown where the alternative field has been used will NOT be marked differently in any way from the rest of the extra column. There is no default.
120 \fBextrapos\fP=column
121 Defines the screen column on the main list where the extra field is to begin. Default is 65.
124 \fBmutt_command\fP=command
125 Defines the command to start mutt. Default is "mutt".
128 \fBmutt_return_all_emails\fP=[true|false]
129 Defines whether to return all email addresses matching the search criteria to a mutt query. Default is true.
132 \fBprint_command\fP=command
133 Defines the command to used when printing the addressbook. Default is "lpr".
136 \fBwww_command\fP=command
137 Defines the command used to start the web browser to view a contact's URL. Default is "lynx".
140 \fBaddress_style\fP=[eu|uk|us]
141 Defines the style of address formatting to be used when exporting as text / printing the database (European, UK, or USA). Default is European ("eu").
144 \fBuse_ascii_only\fP=[true|false]
145 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.
148 \fBadd_email_prevent_duplicates\fP=[true|false]
149 Defines whether to avoid adding addresses already in data. Default is false.
152 \fBsort_field\fP=field
153 Defines the field to be used by the "sort by field" command. Default is "nick" (Nickname/Alias).
156 \fBshow_cursor\fP=[true|false]
157 Defines if the cursor is visible in main display. Default is false.
159 .SH SAMPLE CONFIGURATION FILE
162 # sample abook configuration file
165 # Declare a few custom fields
167 field address_lines = Address, list
168 field birthday = Birthday, day
170 # Define how fields should be displayed in tabs
171 view CONTACT = name, email
172 view ADDRESS = address_lines, city, state, zip, country
173 view PHONE = phone, workphone, pager, mobile, fax
174 view OTHER = url, birthday
177 # Preserve any unknown field while loading an abook database
178 set preserve_fields=all
180 # Automatically save database on exit
183 # Show all email addresses in list
184 set show_all_emails=true
186 # Screen column for email field to start
189 # Field to be used in the extra column
190 set extra_column=phone
191 # frequently used values:
194 # workphone Work Phone
196 # mobile Mobile Phone
197 # nick Nickname/Alias
201 set extra_alternative=-1
203 # Screen column for the extra field to start
206 # Command used to start mutt
207 set mutt_command=mutt
209 # Return all email addresses to a mutt query
210 set mutt_return_all_emails=true
212 # Command used to print
213 set print_command=lpr
215 # Command used to start the web browser
218 # address style [eu|us|uk]
221 # use ASCII characters only
222 set use_ascii_only=false
224 # Prevent double entry
225 set add_email_prevent_duplicates=false
227 # field to be used with "sort by field" command
230 # show cursor in main display
231 set show_cursor=false
239 This manual page was written by Alan Ford <alan@whirlnet.co.uk> and
240 expanded by Cedric Duval <cedricduval@free.fr>.
244 was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>