1 .TH ABOOKRC 5 "Jun 4, 2003"
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 \fBautosave\fP=[true|false]
34 Defines whether the addressbook is automatically saved on exit. Default is true.
37 \fBshow_all_emails\fP=[true|false]
38 Defines whether all email addresses for a contact are shown in the main list view. Default is true
42 Defines the screen column on the main list where the email address is to begin. Default is 25.
45 \fBextra_column\fP=field
46 Defines the field to display in the extra (third) column on the main list. Default is "phone" (Home Phone).
48 \fIfield\fP can be any of the following:
67 \fBextra_alternative\fP=field
68 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.
72 Defines the screen column on the main list where the extra field is to begin. Default is 65.
75 \fBmutt_command\fP=command
76 Defines the command to start mutt. Default is "mutt".
79 \fBmutt_return_all_emails\fP=[true|false]
80 Defines whether to return all email addresses matching the search criteria to a mutt query. Default is true.
83 \fBprint_command\fP=command
84 Defines the command to used when printing the addressbook. Default is "lpr".
87 \fBwww_command\fP=command
88 Defines the command used to start the web browser to view a contact's URL. Default is "lynx".
91 \fBaddress_style\fP=[eu|uk|us]
92 Defines the style of address formatting to be used when exporting as text / printing the database (European, UK, or USA). Default is European ("eu").
95 \fBuse_ascii_only\fP=[true|false]
96 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.
99 \fBadd_email_prevent_duplicates\fP=[true|false]
100 Defines whether to avoid adding addresses already in data. Default is false.
103 \fBsort_field\fP=field
104 Defines the field to be used by the "sort by field" command. Default is "nick" (Nickname/Alias).
106 .SH SAMPLE CONFIGURATION FILE
109 # sample abook configuration file
112 # Automatically save database on exit
115 # Show all email addresses in list
116 set show_all_emails=true
118 # Screen column for email field to start
121 # Field to be used in the extra column
122 set extra_column=phone
123 # frequently used values:
126 # workphone Work Phone
128 # mobile Mobile Phone
129 # nick Nickname/Alias
133 set extra_alternative=-1
135 # Screen column for the extra field to start
138 # Command used to start mutt
139 set mutt_command=mutt
141 # Return all email addresses to a mutt query
142 set mutt_return_all_emails=true
144 # Command used to print
145 set print_command=lpr
147 # Command used to start the web browser
150 # address style [eu|us|uk]
153 # use ASCII characters only
154 set use_ascii_only=false
156 # Prevent double entry
157 set add_email_prevent_duplicates=false
159 # field to be used with "sort by field" command
168 This manual page was written by Alan Ford <alan@whirlnet.co.uk>.
172 was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>