abookrc.5

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