1ABOOKRC(5)                    File Formats Manual                   ABOOKRC(5)
2
3
4

NAME

6       $HOME/.abook/abookrc  -  configuration  file  for  abook  address  book
7       program
8

DESCRIPTION

10       abookrc is the (optional) configuration file for use with the  abook(1)
11       address book program.
12
13       abookrc  is  stored  in  a  user's $HOME/.abook directory. It follows a
14       format of “set option=value”.  The following information lists each  of
15       these options and the values they may take.
16
17       If  a  variable  is  not set in abookrc , a sensible default, as listed
18       with the description below, will be used.
19
20       Comments in abookrc are on lines beginning with '#'.
21
22

COMMANDS

24       set option = value
25
26
27       field identifier = human_readable_name [ , type ]
28              Defines a  new  custom  field.  type  can  be  one  of  'string'
29              (default) , 'emails', 'list', or 'date'.
30
31
32       view view name = field1 [ , field2, ... ]
33              Defines  a view/tab, with fieldN being the identifier of a field
34              declared with the field command, or the identifier of a standard
35              field.
36
37              Standard fields:
38                   name, email,
39                   address, address2, city, state, zip, country,
40                   phone, workphone, fax, mobile,
41                   nick, url, notes, anniversary
42
43              Note:  if  you  don't  define any view, abook will use a default
44              display based on the above standard fields.
45
46
47

VARIABLES

49       autosave=[true|false]
50              Defines whether the addressbook is automatically saved on  exit.
51              Default is true.
52
53
54       preserve_fields=[all|standard|none]
55              Specifies  how fields not declared with the field command nor in
56              a view should be preserved while loading an abook database.
57
58              all    preserve any completely unknown field.
59
60              standard
61                     only preserve the standard fields (see a list in the
62                       description of the view command) and the legacy
63                       'custom[1-5]' fields.
64
65              none   discards any unknown field.
66
67              Default is all.
68
69
70       index_format=format_string
71              Defines the way entries are displayed in the main list. This  is
72              a string containing field names enclosed between braces, with an
73              optional width limit specified by a number (right  alignment  if
74              negative)  after  the  field  name and a colon, and an arbitrary
75              number of alternative fields (first with non empty content is to
76              be displayed) separated by vertical bars. For instance:
77
78              {name:22}
79                     displays  the  name  field  with  a  maximal  width of 22
80                     characters.
81
82              {phone:-12|workphone|mobile}
83                     displays (right aligned within a width of 13 characters),
84                     either  the  phone,  workphone or mobile field, whichever
85                     being the first to be non-empty.
86
87              Default is " {name:22} {email:40} {phone:12|workphone|mobile}"
88
89
90       show_all_emails=[true|false]
91              Defines whether all email addresses for a contact are  shown  in
92              the main list view. Default is true.
93
94
95       emailpos
96       extra_column
97       extra_alternative
98       extrapos
99              Obsoleted by index_format.
100
101
102       mutt_return_all_emails=[true|false]
103              Defines  whether  to  return  all  email  addresses matching the
104              search criteria to a mutt query. Default is true.
105
106
107       print_command=command
108              Defines the command  to  used  when  printing  the  addressbook.
109              Default is "lpr".
110
111
112       www_command=command
113              Defines  the  command  used  to  start the web browser to view a
114              contact's URL. Default is "lynx".
115
116
117       address_style=[eu|uk|us]
118              Defines  the  style  of  address  formatting  to  be  used  when
119              exporting  as  text  /  printing  the database (European, UK, or
120              USA). Default is European ("eu").
121
122
123       use_ascii_only=[true|false]
124              This option allows you to force Abook use only ASCII characters.
125              This option is useful if your terminal doesn't support non-ASCII
126              characters. Default is false.
127
128
129       add_email_prevent_duplicates=[true|false]
130              Defines whether to  avoid  adding  addresses  already  in  data.
131              Default is false.
132
133
134       sort_field=field
135              Defines  the  field  to  be used by the "sort by field" command.
136              Default is "nick" (Nickname/Alias).
137
138
139       show_cursor=[true|false]
140              Defines if the cursor is visible in  main  display.  Default  is
141              false.
142
143
144       use_mouse=[true|false]
145              Defines  if  navigation  via  the mouse is activated. Default is
146              false. Most terminals can also inhibit ncurses mouse  events  at
147              runtime  by  holding  the  Shift  key (restoring mouse-selection
148              behavior).
149
150
151       scroll_speed=lines
152              Defines the number of lines the address list is scrolled by on a
153              mouse  wheel  action. This option only takes effect if use_mouse
154              is enabled. Default is 2.
155
156
157       use_colors=[true|false]
158              Defines if the output of abook is colorized. Default is false.
159
160
161       Color settings:
162              color_header_fg=color Foreground color for header bar
163
164              color_header_bg=color Background color for header bar
165
166              color_footer_fg=color Foreground color for footer bar
167
168              color_footer_bg=color Background color for footer bar
169
170              color_list_even_fg=color  Foreground  color  for   normal   list
171              entries with even index in the list (starting with index 0)
172
173              color_list_even_bg=color   Background   color  for  normal  list
174              entries with even index in the list (starting with index 0)
175
176              color_list_odd_fg=color Foreground color for normal list entries
177              with odd index in the list (starting with index 0)
178
179              color_list_odd_bg=color Background color for normal list entries
180              with odd index in the list (starting with index 0)
181
182              color_list_header_fg=color Foreground color for the list header
183
184              color_list_header_bg=color Background color for the list header
185
186              color_list_highlight_fg=color Foreground color  for  highlighted
187              list entries
188
189              color_list_highlight_bg=color  Background  color for highlighted
190              list entries
191
192              color_tab_border_fg=color Foreground color for  tab  borders  on
193              details page
194
195              color_tab_border_bg=color  Background  color  for tab borders on
196              details page
197
198              color_tab_label_fg=color  Foreground  color  for  tab  labes  on
199              details page
200
201              color_tab_label_bg=color  Background  color  for  tab  labes  on
202              details page
203
204              color_field_name_fg=color Foreground color for  field  names  on
205              details page
206
207              color_field_name_bg=color  Background  color  for field names on
208              details page
209
210              color_field_value_fg=color Foreground color for field values  on
211              details page
212
213              color_field_value_bg=color  Background color for field values on
214              details page
215
216              Where color can be: default, black, red,  green,  yellow,  blue,
217              magenta, cyan, white
218
219
220
221

SAMPLE CONFIGURATION FILE

223       # sample abook configuration file
224       #
225
226       # Declare a few custom fields
227       field pager = Pager
228       field address_lines = Address, list
229       field birthday = Birthday, date
230
231       # Define how fields should be displayed in tabs
232       view CONTACT = name, email
233       view ADDRESS = address_lines, city, state, zip, country
234       view PHONE = phone, workphone, pager, mobile, fax
235       view OTHER = url, birthday
236
237
238       # Preserve any unknown field while loading an abook database
239       set preserve_fields=all
240
241       # Automatically save database on exit
242       set autosave=true
243
244       # Format of entries lines in list
245       set index_format=" {name:22} {email:40} {phone:12|workphone|mobile}"
246
247       # Show all email addresses in list
248       set show_all_emails=true
249
250       # Command used to start mutt
251       set mutt_command=mutt
252
253       # Return all email addresses to a mutt query
254       set mutt_return_all_emails=true
255
256       # Command used to print
257       set print_command=lpr
258
259       # Command used to start the web browser
260       set www_command=lynx
261
262       # Address style [eu|us|uk]
263       set address_style=eu
264
265       # Use ASCII characters only
266       set use_ascii_only=false
267
268       # Prevent double entry
269       set add_email_prevent_duplicates=false
270
271       # Field to be used with "sort by field" command
272       set sort_field=nick
273
274       # Show cursor in main display
275       set show_cursor=false
276
277
278

SEE ALSO

280       abook(1).
281

AUTHORS

283       This  manual  page  was  written by Alan Ford <alan@whirlnet.co.uk> and
284       expanded by Cedric Duval <cedricduval@free.fr>.
285
286       abook was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>
287
288
289
290                                 Oct 25, 2005                       ABOOKRC(5)
Impressum