-.TH ABOOKRC 5 "Jan 2, 2001"
+.TH ABOOKRC 5 "Oct 25, 2005"
.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 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
.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
.br
mobile Mobile Phone
.br
-nick Nick / Alias
+nick Nickname/Alias
.br
url URL
.br
\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".
\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).
+
+.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
-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
+
+# 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
projects / pkg / abook.git / blobdiff