X-Git-Url: https://git.deb.at/w?a=blobdiff_plain;f=abookrc.5;h=7c24bafb728f4fcc640dd63c87d14cdd02997708;hb=a7b46a66b2265d69776ec28d9f643eb4f1506439;hp=2251d34d98bfe22d5f271c80e0115194531f6836;hpb=f7cb3bcd08cc57ff3c00cf28c45d2dd1959a432a;p=pkg%2Fabook.git

diff --git a/abookrc.5 b/abookrc.5
index 2251d34..7c24baf 100644
--- a/abookrc.5
+++ b/abookrc.5
@@ -1,4 +1,4 @@
-.TH ABOOKRC 5 "Jun 4, 2003"
+.TH ABOOKRC 5 "Oct 25, 2005"
 .nh
 .SH NAME
 \fB$HOME/.abook/abookrc\fP \- configuration file for abook address book program
@@ -27,12 +27,61 @@ Comments in
 .B abookrc
 are on lines beginning with '#'.
 
+.SH COMMANDS
+
+.TP
+\fBset\fP \fIoption\fP = \fIvalue\fP
+
+.TP
+\fBfield\fP \fIidentifier\fP = \fIhuman_readable_name\fP [ , \fItype\fP ]
+Defines a new custom field. \fItype\fP can be one of 'string' (default)
+, 'emails', 'list', or 'day'.
+
+.TP
+\fBview\fP \fIview name\fP = \fIfield1\fP [ , \fIfield2\fP, ... ]
+Defines a view/tab, with \fIfieldN\fP being the identifier of a field
+declared with the \fBfield\fP command, or the identifier of a standard field.
+.IP
+Standard fields:
+.br
+	name, email,
+.br
+	address, address2, city, state, zip, country,
+.br
+	phone, workphone, fax, mobile,
+.br
+	nick, url, notes, anniversary
+.IP
+Note: if you don't define any view, abook will use a default display based
+on the above standard fields.
+
+
 .SH VARIABLES
 
 .TP
 \fBautosave\fP=[true|false]
 Defines whether the addressbook is automatically saved on exit. Default is true.
 
+.TP
+\fBpreserve_fields\fP=[all|standard|none]
+Specifies how fields not declared with the \fBfield\fP command nor in a view
+should be preserved while loading an abook database.
+.RS
+.TP
+.B all
+preserve any completely unknown field.
+.TP
+.B standard
+only preserve the standard fields (see a list in the
+  description of the \fBview\fP command) and the legacy
+  'custom[1-5]' fields.
+.TP
+.B none
+discards any unknown field.
+.IP
+Default is \fIstandard\fP.
+.RE
+
 .TP
 \fBshow_all_emails\fP=[true|false]
 Defines whether all email addresses for a contact are shown in the main list view. Default is true
@@ -43,9 +92,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).
-.br
-The following strings are used to represent commonly used \fIfield\fPs:
+Defines the field to display in the extra (third) column on the main list. Default is "phone" (Home Phone).
+.IP
+\fIfield\fP can be any of the following:
 .br
 -1			disabled
 .br
@@ -57,7 +106,7 @@ fax			Fax
 .br
 mobile		Mobile Phone
 .br
-nick			Nick / Alias
+nick			Nickname/Alias
 .br
 url			URL
 .br
@@ -99,12 +148,35 @@ This option allows you to force Abook use only ASCII characters. This option is
 \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).
+
+.TP
+\fBshow_cursor\fP=[true|false]
+Defines if the cursor is visible in main display. Default is false.
+
 .SH SAMPLE CONFIGURATION FILE
 
 .nf
 # sample abook configuration file
 #
 
+# Declare a few custom fields
+field pager = Pager
+field address_lines = Address, list
+field birthday = Birthday, day
+
+# Define how fields should be displayed in tabs
+view CONTACT = name, email
+view ADDRESS = address_lines, city, state, zip, country
+view PHONE = phone, workphone, pager, mobile, fax
+view OTHER = url, birthday
+
+
+# Preserve any unknown field while loading an abook database
+set preserve_fields=all
+
 # Automatically save database on exit
 set autosave=true
 
@@ -117,13 +189,13 @@ set emailpos=25
 # Field to be used in the extra column
 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
 
 #
 set extra_alternative=-1
@@ -152,13 +224,20 @@ 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
+
+# show cursor in main display
+set show_cursor=false
+
 .fi
 
 .SH SEE ALSO
 .BR abook (1).
 .br
-.SH AUTHOR
-This manual page was written by Alan Ford <alan@whirlnet.co.uk>.
+.SH AUTHORS
+This manual page was written by Alan Ford <alan@whirlnet.co.uk> and
+expanded by Cedric Duval <cedricduval@free.fr>.
 
 .br
 .B abook