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