-.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
-.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 .
+\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
-
-.TP
-\fBautosave\fP=[true|false]
-Defines whether the addressbook is automatically saved on exit. Default is true.
+.SH COMMANDS
.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
+\fBset\fP \fIoption\fP = \fIvalue\fP
.TP
-\fBemailpos\fP=column
-Defines the screen column on the main list where the email address is to begin. Default is 25.
+\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 'date'.
.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:
-.br
--1 disabled
-.br
-phone Home Phone
-.br
-workphone Work Phone
+\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
-fax Fax
+ name, email,
.br
-mobile Mobile Phone
+ address, address2, city, state, zip, country,
.br
-nick Nick / Alias
+ phone, workphone, fax, mobile,
.br
-url URL
-.br
-notes Notes
+ 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
-\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 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.
+\fBautosave\fP=[true|false]
+Defines whether the addressbook is automatically saved on exit. Default is true.
.TP
-\fBextrapos\fP=column
-Defines the screen column on the main list where the extra field is to begin. Default is 65.
+\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.
+.RE
+.IP
+Default is \fIstandard\fP.
.TP
-\fBmutt_command\fP=command
-Defines the command to start mutt. Default is "mutt".
+\fBindex_format\fP=format_string
+Defines the way entries are displayed in the main list. This is a string containing field names enclosed between braces, with an optional width limit specified by a number (right alignment if negative) after the field name and a colon, and an arbitrary number of alternative fields (first with non empty content is to be displayed) separated by vertical bars. For instance:
+.RS
+.TP
+\fI{name:22}\fP
+displays the \fIname\fP field with a maximal width of 22 characters.
+.TP
+\fI{phone:-12|workphone|mobile}\fP
+displays (right aligned within a width of 13 characters), either the \fIphone\fP, \fIworkphone\fP or \fImobile\fP field, whichever being the first to be non-empty.
+.RE
+.IP
+Default is \fI" {name:22} {email:40} {phone:12|workphone|mobile}"\fP
+
+.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
+.PD 0
+\fBemailpos\fP
+.TP
+.PD 0
+\fBextra_column\fP
+.TP
+.PD 0
+\fBextra_alternative\fP
+.TP
+.PD
+\fBextrapos\fP
+Obsoleted by \fBindex_format\fP.
.TP
\fBmutt_return_all_emails\fP=[true|false]
\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.
+
+.TP
+\fBuse_mouse\fP=[true|false]
+Defines if navigation via the mouse is activated. Default is false.
+
+.TP
+\fBuse_colors\fP=[true|false]
+Defines if the output of abook is colorized. Default is false.
+
+.TP
+Color settings:
+\fBcolor_header_fg\fP=color
+Foreground color for header bar
+
+\fBcolor_header_bg\fP=color
+Background color for header bar
+
+\fBcolor_footer_fg\fP=color
+Foreground color for footer bar
+
+\fBcolor_footer_bg\fP=color
+Background color for footer bar
+
+\fBcolor_list_even_fg\fP=color
+Foreground color for normal list entries with even index in the list (starting
+with index 0)
+
+\fBcolor_list_even_bg\fP=color
+Background color for normal list entries with even index in the list (starting
+with index 0)
+
+\fBcolor_list_odd_fg\fP=color
+Foreground color for normal list entries with odd index in the list (starting
+with index 0)
+
+\fBcolor_list_odd_bg\fP=color
+Background color for normal list entries with odd index in the list (starting
+with index 0)
+
+\fBcolor_list_header_fg\fP=color
+Foreground color for the list header
+
+\fBcolor_list_header_bg\fP=color
+Background color for the list header
+
+\fBcolor_list_highlight_fg\fP=color
+Foreground color for highlighted list entries
+
+\fBcolor_list_highlight_bg\fP=color
+Background color for highlighted list entries
+
+\fBcolor_tab_border_fg\fP=color
+Foreground color for tab borders on details page
+
+\fBcolor_tab_border_bg\fP=color
+Background color for tab borders on details page
+
+\fBcolor_tab_label_fg\fP=color
+Foreground color for tab labes on details page
+
+\fBcolor_tab_label_bg\fP=color
+Background color for tab labes on details page
+
+\fBcolor_field_name_fg\fP=color
+Foreground color for field names on details page
+
+\fBcolor_field_name_bg\fP=color
+Background color for field names on details page
+
+\fBcolor_field_value_fg\fP=color
+Foreground color for field values on details page
+
+\fBcolor_field_value_bg\fP=color
+Background color for field values on details page
+
+Where \fBcolor\fP can be: default, black, red, green, yellow, blue, magenta, cyan, white
+
+
+
.SH SAMPLE CONFIGURATION FILE
.nf
# sample abook configuration file
#
-# Automatically save database on exit
-autosave=true
+# Declare a few custom fields
+field pager = Pager
+field address_lines = Address, list
+field birthday = Birthday, date
-# Show all email addresses in list
-show_all_emails=true
-
-# Screen column for email field to start
-emailpos=25
-
-# Field to be used in the extra column
-extra_column=phone
-# frequently used values:
-# -1 disabled
-# phone Home Phone
-# workphone Work Phone
-# fax Fax
-# mobile Mobile Phone
-# nick Nick / Alias
-# url URL
+# 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
-#
-extra_alternative=-1
-# Screen column for the extra field to start
-extrapos=65
+# Preserve any unknown field while loading an abook database
+set preserve_fields=all
+
+# Automatically save database on exit
+set autosave=true
+
+# Format of entries lines in list
+set index_format=" {name:22} {email:40} {phone:12|workphone|mobile}"
+
+# Show all email addresses in list
+set show_all_emails=true
# 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]
+set address_style=eu
+
+# Use ASCII characters only
+set use_ascii_only=false
+
+# Prevent double entry
+set add_email_prevent_duplicates=false
-# address style [eu|us|uk]
-address_style=eu
+# Field to be used with "sort by field" command
+set sort_field=nick
-# use ASCII characters only
-use_ascii_only=false
+# 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