abookrc.5

   1 .TH ABOOKRC 5 "Jan 2, 2001"
   2 .nh
   3 .SH NAME
   4 \fB$HOME/.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 directory. It follows a format of option=value.
  17 The following information lists each of these options and the values they
  18 may take.
  19
  20 If a variable is not set in
  21 .B .abookrc
  22 , a sensible default, as
  23 listed with the description below, will be used.
  24
  25 Comments in
  26 .B .abookrc
  27 are on lines beginning with '#'.
  28
  29 .SH VARIABLES
  30
  31 .TP
  32 \fBautosave\fP=[true|false]
  33 Defines whether the addressbook is automatically saved on exit. Default is true.
  34
  35 .TP
  36 \fBshow_all_emails\fP=[true|false]
  37 Defines whether all email addresses for a contact are shown in the main list view. Default is true
  38
  39 .TP
  40 \fBemailpos\fP=column
  41 Defines the screen column on the main list where the email address is to begin. Default is 25.
  42
  43 .TP
  44 \fBextra_column\fP=field
  45 Defines the variable to display in the extra (third) column on the main list. Default is 7 (Home Phone).
  46 .br
  47 The following numbers are used to represent commonly used \fIfield\fPs:
  48 .br
  49 -1 = disabled
  50 .br
  51  7 = Home Phone
  52 .br
  53  8 = Work Phone
  54 .br
  55  9 = Fax
  56 .br
  57 10 = Mobile Phone
  58 .br
  59 11 = Nick / Alias
  60 .br
  61 12 = URL
  62 .br
  63 13 = Notes
  64
  65 .TP
  66 \fBextra_alternative\fP=field
  67 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 numerical codes 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.
  68
  69 .TP
  70 \fBextrapos\fP=column
  71 Defines the screen column on the main list where the extra field is to begin. Default is 65.
  72
  73 .TP
  74 \fBmutt_command\fP=command
  75 Defines the command to start mutt. Default is "mutt".
  76
  77 .TP
  78 \fBmutt_return_all_emails\fP=[true|false]
  79 Defines whether to return all email addresses matching the search criteria to a mutt query. Default is true.
  80
  81 .TP
  82 \fBprint_command\fP=command
  83 Defines the command to used when printing the addressbook. Default is "lpr".
  84
  85 .TP
  86 \fBfilesel_sort\fP=[true|false]
  87 Defines whether to sort the files in the fileselector in alphabetical order. Default is false.
  88
  89 .TP
  90 \fBwww_command\fP=command
  91 Defines the command used to start the web browser to view a contact's URL. Default is "lynx".
  92
  93 .TP
  94 \fBaddress_style\fP=[eu|uk|us]
  95 Defines the style of address formatting to be used when exporting as text / printing the database (European, UK, or USA). Default is European ("eu").
  96
  97 .TP
  98 \fBuse_ascii_only\fP=[true|false]
  99 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.
 100
 101 .SH SAMPLE CONFIGURATION FILE
 102
 103 .nf
 104 # sample abook configuration file
 105 #
 106
 107 # Automatically save database on exit
 108 autosave=true
 109
 110 # Show all email addresses in list
 111 show_all_emails=true
 112
 113 # Screen column for email field to start
 114 emailpos=25
 115
 116 # Field to be used in the extra column
 117 extra_column=7
 118 # frequently used values:
 119 #       -1 = disabled
 120 #       7 = Home Phone
 121 #       8 = Work Phone
 122 #       9 = Fax
 123 #       10 = Mobile Phone
 124 #       11 = Nick / Alias
 125 #       12 = URL
 126
 127 #
 128 extra_alternative=-1
 129
 130 # Screen column for the extra field to start
 131 extrapos=65
 132
 133 # Command used to start mutt
 134 mutt_command=mutt
 135
 136 # Return all email addresses to a mutt query
 137 mutt_return_all_emails=true
 138
 139 # Command used to print
 140 print_command=lpr
 141
 142 # Sort files in fileselector (alphabetic order)
 143 filesel_sort=false
 144
 145 # Command used to start the web browser
 146 www_command=lynx
 147
 148 # address style [eu|us|uk]
 149 address_style=eu
 150
 151 # use ASCII characters only
 152 use_ascii_only=false
 153
 154 .fi
 155
 156 .SH SEE ALSO
 157 .BR abook (1).
 158 .br
 159 .SH AUTHOR
 160 This manual page was written by Alan Ford <alan@whirlnet.co.uk>.
 161
 162 .br
 163 .B abook
 164 was written by Jaakko Heinonen <jheinonen@bigfoot.com>