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 .IP
  82 Default is \fIstandard\fP.
  83 .RE
  84
  85 .TP
  86 \fBshow_all_emails\fP=[true|false]
  87 Defines whether all email addresses for a contact are shown in the main list view. Default is true
  88
  89 .TP
  90 \fBemailpos\fP=column
  91 Defines the screen column on the main list where the email address is to begin. Default is 25.
  92
  93 .TP
  94 \fBextra_column\fP=field
  95 Defines the field to display in the extra (third) column on the main list. Default is "phone" (Home Phone).
  96 .IP
  97 \fIfield\fP can be any of the following:
  98 .br
  99 -1                      disabled
 100 .br
 101 phone           Home Phone
 102 .br
 103 workphone               Work Phone
 104 .br
 105 fax                     Fax
 106 .br
 107 mobile          Mobile Phone
 108 .br
 109 nick                    Nickname/Alias
 110 .br
 111 url                     URL
 112 .br
 113 notes           Notes
 114
 115 .TP
 116 \fBextra_alternative\fP=field
 117 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.
 118
 119 .TP
 120 \fBextrapos\fP=column
 121 Defines the screen column on the main list where the extra field is to begin. Default is 65.
 122
 123 .TP
 124 \fBmutt_command\fP=command
 125 Defines the command to start mutt. Default is "mutt".
 126
 127 .TP
 128 \fBmutt_return_all_emails\fP=[true|false]
 129 Defines whether to return all email addresses matching the search criteria to a mutt query. Default is true.
 130
 131 .TP
 132 \fBprint_command\fP=command
 133 Defines the command to used when printing the addressbook. Default is "lpr".
 134
 135 .TP
 136 \fBwww_command\fP=command
 137 Defines the command used to start the web browser to view a contact's URL. Default is "lynx".
 138
 139 .TP
 140 \fBaddress_style\fP=[eu|uk|us]
 141 Defines the style of address formatting to be used when exporting as text / printing the database (European, UK, or USA). Default is European ("eu").
 142
 143 .TP
 144 \fBuse_ascii_only\fP=[true|false]
 145 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.
 146
 147 .TP
 148 \fBadd_email_prevent_duplicates\fP=[true|false]
 149 Defines whether to avoid adding addresses already in data. Default is false.
 150
 151 .TP
 152 \fBsort_field\fP=field
 153 Defines the field to be used by the "sort by field" command. Default is "nick" (Nickname/Alias).
 154
 155 .TP
 156 \fBshow_cursor\fP=[true|false]
 157 Defines if the cursor is visible in main display. Default is false.
 158
 159 .SH SAMPLE CONFIGURATION FILE
 160
 161 .nf
 162 # sample abook configuration file
 163 #
 164
 165 # Declare a few custom fields
 166 field pager = Pager
 167 field address_lines = Address, list
 168 field birthday = Birthday, date
 169
 170 # Define how fields should be displayed in tabs
 171 view CONTACT = name, email
 172 view ADDRESS = address_lines, city, state, zip, country
 173 view PHONE = phone, workphone, pager, mobile, fax
 174 view OTHER = url, birthday
 175
 176
 177 # Preserve any unknown field while loading an abook database
 178 set preserve_fields=all
 179
 180 # Automatically save database on exit
 181 set autosave=true
 182
 183 # Show all email addresses in list
 184 set show_all_emails=true
 185
 186 # Screen column for email field to start
 187 set emailpos=25
 188
 189 # Field to be used in the extra column
 190 set extra_column=phone
 191 # frequently used values:
 192 #       -1          disabled
 193 #       phone       Home Phone
 194 #       workphone   Work Phone
 195 #       fax         Fax
 196 #       mobile      Mobile Phone
 197 #       nick        Nickname/Alias
 198 #       url         URL
 199
 200 #
 201 set extra_alternative=-1
 202
 203 # Screen column for the extra field to start
 204 set extrapos=65
 205
 206 # Command used to start mutt
 207 set mutt_command=mutt
 208
 209 # Return all email addresses to a mutt query
 210 set mutt_return_all_emails=true
 211
 212 # Command used to print
 213 set print_command=lpr
 214
 215 # Command used to start the web browser
 216 set www_command=lynx
 217
 218 # address style [eu|us|uk]
 219 set address_style=eu
 220
 221 # use ASCII characters only
 222 set use_ascii_only=false
 223
 224 # Prevent double entry
 225 set add_email_prevent_duplicates=false
 226
 227 # field to be used with "sort by field" command
 228 set sort_field=nick
 229
 230 # show cursor in main display
 231 set show_cursor=false
 232
 233 .fi
 234
 235 .SH SEE ALSO
 236 .BR abook (1).
 237 .br
 238 .SH AUTHORS
 239 This manual page was written by Alan Ford <alan@whirlnet.co.uk> and
 240 expanded by Cedric Duval <cedricduval@free.fr>.
 241
 242 .br
 243 .B abook
 244 was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>