]> git.deb.at Git - pkg/abook.git/blobdiff - abookrc.5
Imported Upstream version 0.5.3
[pkg/abook.git] / abookrc.5
index 51ce9acfe21359256299b0ffef1a6b071472a20e..eaedf7d50f8b6fdc61b25e27ff0347a871ec7533 100644 (file)
--- a/abookrc.5
+++ b/abookrc.5
@@ -1,29 +1,30 @@
-.TH ABOOKRC 5 "Jan 2, 2001"
+.TH ABOOKRC 5 "Jun 4, 2003"
 .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 DESCRIPTION
 This manual page documents briefly the
-.B .abookrc
+.B abookrc
 file.
 .br
-.B .abookrc
+.B abookrc
 is the (optional) configuration file for use with the
 .B abook(1)
 address book program.
 
-.B .abookrc
-is stored in a user's $HOME directory. It follows a format of option=value.
+.B abookrc
+is stored in a user's $HOME/.abook directory. It follows a format of
+\(lq\fBset option=value\fP\(rq.
 The following information lists each of these options and the values they
 may take.
 
 If a variable is not set in 
-.B .abookrc
+.B abookrc
 , a sensible default, as 
 listed with the description below, will be used.
 
 Comments in 
-.B .abookrc
+.B abookrc
 are on lines beginning with '#'.
 
 .SH VARIABLES
@@ -42,9 +43,9 @@ 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 "phone" (Home Phone).
+Defines the field to display in the extra (third) column on the main list. Default is "phone" (Home Phone).
 .br
-The following strings are used to represent commonly used \fIfield\fPs:
+\fIfield\fP can be any of the following:
 .br
 -1                     disabled
 .br
@@ -56,7 +57,7 @@ fax                   Fax
 .br
 mobile         Mobile Phone
 .br
-nick                   Nick / Alias
+nick                   Nickname/Alias
 .br
 url                    URL
 .br
@@ -82,10 +83,6 @@ Defines whether to return all email addresses matching the search criteria to a
 \fBprint_command\fP=command
 Defines the command to used when printing the addressbook. Default is "lpr".
 
-.TP
-\fBfilesel_sort\fP=[true|false]
-Defines whether to sort the files in the fileselector in alphabetical order. Default is false.
-
 .TP
 \fBwww_command\fP=command
 Defines the command used to start the web browser to view a contact's URL. Default is "lynx".
@@ -98,6 +95,14 @@ Defines the style of address formatting to be used when exporting as text / prin
 \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.
 
+.TP
+\fBadd_email_prevent_duplicates\fP=[true|false]
+Defines whether to avoid adding addresses already in data. Default is false.
+
+.TP
+\fBsort_field\fP=field
+Defines the field to be used by the "sort by field" command. Default is "nick" (Nickname/Alias).
+
 .SH SAMPLE CONFIGURATION FILE
 
 .nf
@@ -105,51 +110,54 @@ This option allows you to force Abook use only ASCII characters. This option is
 #
 
 # Automatically save database on exit
-autosave=true
+set autosave=true
 
 # Show all email addresses in list
-show_all_emails=true
+set show_all_emails=true
 
 # Screen column for email field to start
-emailpos=25
+set emailpos=25
 
 # Field to be used in the extra column
-extra_column=phone
+set extra_column=phone
 # frequently used values:
-#      -1              disabled
-#      phone           Home Phone
-#      workphone       Work Phone
-#      fax             Fax
-#      mobile          Mobile Phone
-#      nick            Nick / Alias
-#      url             URL
+#      -1          disabled
+#      phone       Home Phone
+#      workphone   Work Phone
+#      fax         Fax
+#      mobile      Mobile Phone
+#      nick        Nickname/Alias
+#      url         URL
 
 #
-extra_alternative=-1
+set extra_alternative=-1
 
 # Screen column for the extra field to start
-extrapos=65
+set extrapos=65
 
 # Command used to start mutt
-mutt_command=mutt
+set mutt_command=mutt
 
 # Return all email addresses to a mutt query
-mutt_return_all_emails=true
+set mutt_return_all_emails=true
 
 # Command used to print
-print_command=lpr
-
-# Sort files in fileselector (alphabetic order)
-filesel_sort=false
+set print_command=lpr
 
 # Command used to start the web browser
-www_command=lynx
+set www_command=lynx
 
 # address style [eu|us|uk]
-address_style=eu
+set address_style=eu
 
 # use ASCII characters only
-use_ascii_only=false
+set use_ascii_only=false
+
+# Prevent double entry
+set add_email_prevent_duplicates=false
+
+# field to be used with "sort by field" command
+set sort_field=nick
 
 .fi