documentation update

[pkg/abook.git] / abookrc.5

diff --git a/abookrc.5 b/abookrc.5
index 33076d2ff4fe43c695be452ca8298594f1066835..d16c24d662135b2b5a693490351070fc67683ee4 100644 (file)
--- a/abookrc.5
+++ b/abookrc.5
@@ -1,7 +1,11 @@
 .TH ABOOKRC 5 "Jan 2, 2001"
 .nh
 .SH NAME
-\fB$HOME/.abookrc\fP \- configuration file for abook address book program
+\fB$HOME/.abook/abookrc\fP \- configuration file for abook address book program
+.SH WARNING
+This man page is not up to date with abook version 0.5. See sample.abookrc
+for abookrc syntax. It can be found on http://abook.sourceforge.net/sample.abookrc .
+Since the version 0.5.0 abookrc is stored in $HOME/abook/.
 .SH DESCRIPTION
 This manual page documents briefly the
 .B .abookrc
@@ -18,12 +22,12 @@ The following information lists each of these options and the values they
 may take.
 
 If a variable is not set in 
-.B .abook.conf
+.B .abookrc
 , a sensible default, as 
 listed with the description below, will be used.
 
 Comments in 
-.B .abook.conf 
+.B .abookrc
 are on lines beginning with '#'.
 
 .SH VARIABLES
@@ -42,29 +46,29 @@ Defines the screen column on the main list where the email address is to begin.
 
 .TP
 \fBextra_column\fP=field
-Defines the variable to display in the extra (third) column on the main list. Default is 7 (Home Phone).
+Defines the variable to display in the extra (third) column on the main list. Default is "phone" (Home Phone).
 .br
-The following numbers are used to represent commonly used \fIfield\fPs:
+The following strings are used to represent commonly used \fIfield\fPs:
 .br
--1 = disabled
+-1                     disabled
 .br
- 7 = Home Phone
+phone          Home Phone
 .br
- 8 = Work Phone
+workphone              Work Phone
 .br
- 9 = Fax
+fax                    Fax
 .br
-10 = Mobile Phone
+mobile         Mobile Phone
 .br
-11 = Nick / Alias
+nick                   Nick / Alias
 .br
-12 = URL
+url                    URL
 .br
-13 = Notes
+notes          Notes
 
 .TP
 \fBextra_alternative\fP=field
-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.
+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.
 
 .TP
 \fBextrapos\fP=column
@@ -94,6 +98,10 @@ Defines the command used to start the web browser to view a contact's URL. Defau
 \fBaddress_style\fP=[eu|uk|us]
 Defines the style of address formatting to be used when exporting as text / printing the database (European, UK, or USA). Default is European ("eu").
 
+.TP
+\fBuse_ascii_only\fP=[true|false]
+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.
+
 .SH SAMPLE CONFIGURATION FILE
 
 .nf
@@ -110,15 +118,15 @@ show_all_emails=true
 emailpos=25
 
 # Field to be used in the extra column
-extra_column=7
+extra_column=phone
 # frequently used values:
-#      -1 = disabled
-#      7 = Home Phone
-#      8 = Work Phone
-#      9 = Fax
-#      10 = Mobile Phone
-#      11 = Nick / Alias
-#      12 = URL
+#      -1              disabled
+#      phone           Home Phone
+#      workphone       Work Phone
+#      fax             Fax
+#      mobile          Mobile Phone
+#      nick            Nick / Alias
+#      url             URL
 
 #
 extra_alternative=-1
@@ -144,6 +152,9 @@ www_command=lynx
 # address style [eu|us|uk]
 address_style=eu
 
+# use ASCII characters only
+use_ascii_only=false
+
 .fi
 
 .SH SEE ALSO
@@ -154,4 +165,4 @@ This manual page was written by Alan Ford <alan@whirlnet.co.uk>.
 
 .br
 .B abook
-was written by Jaakko Heinonen <jheinonen@bigfoot.com>
+was written by Jaakko Heinonen <jheinonen@users.sourceforge.net>