]> git.deb.at Git - pkg/abook.git/blob - abookrc.5
- mbswidth change to avoid empty translation unit warnings
[pkg/abook.git] / abookrc.5
1 .TH ABOOKRC 5 "Jun 4, 2003"
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 VARIABLES
31
32 .TP
33 \fBautosave\fP=[true|false]
34 Defines whether the addressbook is automatically saved on exit. Default is true.
35
36 .TP
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
39
40 .TP
41 \fBemailpos\fP=column
42 Defines the screen column on the main list where the email address is to begin. Default is 25.
43
44 .TP
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).
47 .br
48 \fIfield\fP can be any of the following:
49 .br
50 -1                      disabled
51 .br
52 phone           Home Phone
53 .br
54 workphone               Work Phone
55 .br
56 fax                     Fax
57 .br
58 mobile          Mobile Phone
59 .br
60 nick                    Nickname/Alias
61 .br
62 url                     URL
63 .br
64 notes           Notes
65
66 .TP
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.
69
70 .TP
71 \fBextrapos\fP=column
72 Defines the screen column on the main list where the extra field is to begin. Default is 65.
73
74 .TP
75 \fBmutt_command\fP=command
76 Defines the command to start mutt. Default is "mutt".
77
78 .TP
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.
81
82 .TP
83 \fBprint_command\fP=command
84 Defines the command to used when printing the addressbook. Default is "lpr".
85
86 .TP
87 \fBwww_command\fP=command
88 Defines the command used to start the web browser to view a contact's URL. Default is "lynx".
89
90 .TP
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").
93
94 .TP
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.
97
98 .TP
99 \fBadd_email_prevent_duplicates\fP=[true|false]
100 Defines whether to avoid adding addresses already in data. Default is false.
101
102 .TP
103 \fBsort_field\fP=field
104 Defines the field to be used by the "sort by field" command. Default is "nick" (Nickname/Alias).
105
106 .TP
107 \fBshow_cursor\fP=[true|false]
108 Defines if the cursor is visible in main display. Default is false.
109
110 .SH SAMPLE CONFIGURATION FILE
111
112 .nf
113 # sample abook configuration file
114 #
115
116 # Automatically save database on exit
117 set autosave=true
118
119 # Show all email addresses in list
120 set show_all_emails=true
121
122 # Screen column for email field to start
123 set emailpos=25
124
125 # Field to be used in the extra column
126 set extra_column=phone
127 # frequently used values:
128 #       -1          disabled
129 #       phone       Home Phone
130 #       workphone   Work Phone
131 #       fax         Fax
132 #       mobile      Mobile Phone
133 #       nick        Nickname/Alias
134 #       url         URL
135
136 #
137 set extra_alternative=-1
138
139 # Screen column for the extra field to start
140 set extrapos=65
141
142 # Command used to start mutt
143 set mutt_command=mutt
144
145 # Return all email addresses to a mutt query
146 set mutt_return_all_emails=true
147
148 # Command used to print
149 set print_command=lpr
150
151 # Command used to start the web browser
152 set www_command=lynx
153
154 # address style [eu|us|uk]
155 set address_style=eu
156
157 # use ASCII characters only
158 set use_ascii_only=false
159
160 # Prevent double entry
161 set add_email_prevent_duplicates=false
162
163 # field to be used with "sort by field" command
164 set sort_field=nick
165
166 # show cursor in main display
167 set show_cursor=false
168
169 .fi
170
171 .SH SEE ALSO
172 .BR abook (1).
173 .br
174 .SH AUTHOR
175 This manual page was written by Alan Ford <alan@whirlnet.co.uk>.
176
177 .br
178 .B abook
179 was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>