]> git.deb.at Git - pkg/abook.git/blob - abookrc.5
Revert "Add fix_spelling_error_in_binary.diff patch"
[pkg/abook.git] / abookrc.5
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.
14
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.
20
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.
25
26 Comments in 
27 .B abookrc
28 are on lines beginning with '#'.
29
30 .SH COMMANDS
31
32 .TP
33 \fBset\fP \fIoption\fP = \fIvalue\fP
34
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'.
39
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.
57
58
59 .SH VARIABLES
60
61 .TP
62 \fBautosave\fP=[true|false]
63 Defines whether the addressbook is automatically saved on exit. Default is true.
64
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.
84
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:\-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.
95 .RE
96 .IP
97 Default is \fI" {name:22} {email:40} {phone:12|workphone|mobile}"\fP
98
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.
102
103 .TP
104 .PD 0
105 \fBemailpos\fP
106 .TP
107 .PD 0
108 \fBextra_column\fP
109 .TP
110 .PD 0
111 \fBextra_alternative\fP
112 .TP
113 .PD
114 \fBextrapos\fP
115 Obsoleted by \fBindex_format\fP.
116
117 .TP
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.
120
121 .TP
122 \fBprint_command\fP=command
123 Defines the command to used when printing the addressbook. Default is "lpr".
124
125 .TP
126 \fBwww_command\fP=command
127 Defines the command used to start the web browser to view a contact's URL. Default is "lynx".
128
129 .TP
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").
132
133 .TP
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.
136
137 .TP
138 \fBadd_email_prevent_duplicates\fP=[true|false]
139 Defines whether to avoid adding addresses already in data. Default is false.
140
141 .TP
142 \fBsort_field\fP=field
143 Defines the field to be used by the "sort by field" command. Default is "nick" (Nickname/Alias).
144
145 .TP
146 \fBshow_cursor\fP=[true|false]
147 Defines if the cursor is visible in main display. Default is false.
148
149 .TP
150 \fBuse_mouse\fP=[true|false]
151 Defines if navigation via the mouse is activated. Default is false. Most terminals can also inhibit ncurses mouse events at runtime by holding the Shift key (restoring mouse\-selection behavior).
152
153 .TP
154 \fBscroll_speed\fP=lines
155 Defines the number of lines the address list is scrolled by on a mouse wheel
156 action. This option only takes effect if use_mouse is enabled. Default is 2.
157
158 .TP
159 \fBuse_colors\fP=[true|false]
160 Defines if the output of abook is colorized. Default is false.
161
162 .TP
163 Color settings:
164 \fBcolor_header_fg\fP=color
165 Foreground color for header bar
166
167 \fBcolor_header_bg\fP=color
168 Background color for header bar
169
170 \fBcolor_footer_fg\fP=color
171 Foreground color for footer bar
172
173 \fBcolor_footer_bg\fP=color
174 Background color for footer bar
175
176 \fBcolor_list_even_fg\fP=color
177 Foreground color for normal list entries with even index in the list (starting
178 with index 0)
179
180 \fBcolor_list_even_bg\fP=color
181 Background color for normal list entries with even index in the list (starting
182 with index 0)
183
184 \fBcolor_list_odd_fg\fP=color
185 Foreground color for normal list entries with odd index in the list (starting
186 with index 0)
187
188 \fBcolor_list_odd_bg\fP=color
189 Background color for normal list entries with odd index in the list (starting
190 with index 0)
191
192 \fBcolor_list_header_fg\fP=color
193 Foreground color for the list header
194
195 \fBcolor_list_header_bg\fP=color
196 Background color for the list header
197
198 \fBcolor_list_highlight_fg\fP=color
199 Foreground color for highlighted list entries
200
201 \fBcolor_list_highlight_bg\fP=color
202 Background color for highlighted list entries
203
204 \fBcolor_tab_border_fg\fP=color
205 Foreground color for tab borders on details page
206
207 \fBcolor_tab_border_bg\fP=color
208 Background color for tab borders on details page
209
210 \fBcolor_tab_label_fg\fP=color
211 Foreground color for tab labes on details page
212
213 \fBcolor_tab_label_bg\fP=color
214 Background color for tab labes on details page
215
216 \fBcolor_field_name_fg\fP=color
217 Foreground color for field names on details page
218
219 \fBcolor_field_name_bg\fP=color
220 Background color for field names on details page
221
222 \fBcolor_field_value_fg\fP=color
223 Foreground color for field values on details page
224
225 \fBcolor_field_value_bg\fP=color
226 Background color for field values on details page
227
228 Where \fBcolor\fP can be: default, black, red, green, yellow, blue, magenta, cyan, white
229
230
231
232 .SH SAMPLE CONFIGURATION FILE
233
234 .nf
235 # sample abook configuration file
236 #
237
238 # Declare a few custom fields
239 field pager = Pager
240 field address_lines = Address, list
241 field birthday = Birthday, date
242
243 # Define how fields should be displayed in tabs
244 view CONTACT = name, email
245 view ADDRESS = address_lines, city, state, zip, country
246 view PHONE = phone, workphone, pager, mobile, fax
247 view OTHER = url, birthday
248
249
250 # Preserve any unknown field while loading an abook database
251 set preserve_fields=all
252
253 # Automatically save database on exit
254 set autosave=true
255
256 # Format of entries lines in list
257 set index_format=" {name:22} {email:40} {phone:12|workphone|mobile}"
258
259 # Show all email addresses in list
260 set show_all_emails=true
261
262 # Command used to start mutt
263 set mutt_command=mutt
264
265 # Return all email addresses to a mutt query
266 set mutt_return_all_emails=true
267
268 # Command used to print
269 set print_command=lpr
270
271 # Command used to start the web browser
272 set www_command=lynx
273
274 # Address style [eu|us|uk]
275 set address_style=eu
276
277 # Use ASCII characters only
278 set use_ascii_only=false
279
280 # Prevent double entry
281 set add_email_prevent_duplicates=false
282
283 # Field to be used with "sort by field" command
284 set sort_field=nick
285
286 # Show cursor in main display
287 set show_cursor=false
288
289 .fi
290
291 .SH SEE ALSO
292 .BR abook (1).
293 .br
294 .SH AUTHORS
295 This manual page was written by Alan Ford <alan@whirlnet.co.uk> and
296 expanded by Cedric Duval <cedricduval@free.fr>.
297
298 .br
299 .B abook
300 was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>