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

COMMANDS

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

VARIABLES

50       autosave=[true|false]
51              Defines whether the addressbook is automatically saved on  exit.
52              Default is true.
53
54
55       preserve_fields=[all|standard|none]
56              Specifies  how fields not declared with the field command nor in
57              a view should be preserved while loading an abook database.
58
59              all    preserve any completely unknown field.
60
61              standard
62                     only preserve the standard fields (see a list in the
63                       description of the view command) and the legacy
64                       'custom[1-5]' fields.
65
66              none   discards any unknown field.
67
68              Default is standard.
69
70
71       index_format=format_string
72              Defines the way entries are displayed in the main list. This  is
73              a string containing field names enclosed between braces, with an
74              optional width limit specified by a number (right  alignment  if
75              negative)  after  the  field  name and a colon, and an arbitrary
76              number of alternative fields (first with non empty content is to
77              be displayed) separated by vertical bars. For instance:
78
79              {name:22}
80                     displays  the  name  field  with  a  maximal  width of 22
81                     characters.
82
83              {phone:-13|workphone|mobile}
84                     displays (right aligned within a width of 13 characters),
85                     either  the  phone,  workphone or mobile field, whichever
86                     being the first to be non-empty.
87
88              Default is " {name:22} {email:40} {phone:12|workphone|mobile}"
89
90
91       show_all_emails=[true|false]
92              Defines whether all email addresses for a contact are  shown  in
93              the main list view. Default is true.
94
95
96       emailpos
97       extra_column
98       extra_alternative
99       extrapos
100              Obsoleted by index_format.
101
102
103       mutt_return_all_emails=[true|false]
104              Defines  whether  to  return  all  email  addresses matching the
105              search criteria to a mutt query. Default is true.
106
107
108       print_command=command
109              Defines the command  to  used  when  printing  the  addressbook.
110              Default is "lpr".
111
112
113       www_command=command
114              Defines  the  command  used  to  start the web browser to view a
115              contact's URL. Default is "lynx".
116
117
118       address_style=[eu|uk|us]
119              Defines  the  style  of  address  formatting  to  be  used  when
120              exporting  as  text  /  printing  the database (European, UK, or
121              USA). Default is European ("eu").
122
123
124       use_ascii_only=[true|false]
125              This option allows you to force Abook use only ASCII characters.
126              This option is useful if your terminal doesn't support non-ASCII
127              characters. Default is false.
128
129
130       add_email_prevent_duplicates=[true|false]
131              Defines whether to  avoid  adding  addresses  already  in  data.
132              Default is false.
133
134
135       sort_field=field
136              Defines  the  field  to  be used by the "sort by field" command.
137              Default is "nick" (Nickname/Alias).
138
139
140       show_cursor=[true|false]
141              Defines if the cursor is visible in  main  display.  Default  is
142              false.
143
144

SAMPLE CONFIGURATION FILE

146       # sample abook configuration file
147       #
148
149       # Declare a few custom fields
150       field pager = Pager
151       field address_lines = Address, list
152       field birthday = Birthday, date
153
154       # Define how fields should be displayed in tabs
155       view CONTACT = name, email
156       view ADDRESS = address_lines, city, state, zip, country
157       view PHONE = phone, workphone, pager, mobile, fax
158       view OTHER = url, birthday
159
160
161       # Preserve any unknown field while loading an abook database
162       set preserve_fields=all
163
164       # Automatically save database on exit
165       set autosave=true
166
167       # Format of entries lines in list
168       set index_format=" {name:22} {email:40} {phone:12|workphone|mobile}"
169
170       # Show all email addresses in list
171       set show_all_emails=true
172
173       # Command used to start mutt
174       set mutt_command=mutt
175
176       # Return all email addresses to a mutt query
177       set mutt_return_all_emails=true
178
179       # Command used to print
180       set print_command=lpr
181
182       # Command used to start the web browser
183       set www_command=lynx
184
185       # Address style [eu|us|uk]
186       set address_style=eu
187
188       # Use ASCII characters only
189       set use_ascii_only=false
190
191       # Prevent double entry
192       set add_email_prevent_duplicates=false
193
194       # Field to be used with "sort by field" command
195       set sort_field=nick
196
197       # Show cursor in main display
198       set show_cursor=false
199
200
201

SEE ALSO

203       abook(1).
204

AUTHORS

206       This  manual  page  was  written by Alan Ford <alan@whirlnet.co.uk> and
207       expanded by Cedric Duval <cedricduval@free.fr>.
208
209       abook was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>
210
211
212
213                                 Oct 25, 2005                       ABOOKRC(5)
Impressum