MAN page from PLD abook-0.6.0-0.pre2.2.i686.rpm

ABOOKRC

Section: File Formats (5)
Updated: Oct 25, 2005
Index

NAME

$HOME/.abook/abookrc - configuration file for abook address book program

DESCRIPTION

This manual page documents briefly theabookrcfile.
abookrcis the (optional) configuration file for use with theabook(1)address book program.

abookrcis stored in a user's $HOME/.abook directory. It follows a format of"set option=value".The following information lists each of these options and the values theymay take.

If a variable is not set in abookrc, a sensible default, as listed with the description below, will be used.

Comments in abookrcare on lines beginning with '#'.

COMMANDS

set option = value

field identifier = human_readable_name [ , type ]

Defines a new custom field. type can be one of 'string' (default), 'emails', 'list', or 'date'.

view view name = field1 [ , field2, ... ]

Defines a view/tab, with fieldN being the identifier of a fielddeclared with the field command, or the identifier of a standard field.

Standard fields:
       name, email,

       address, address2, city, state, zip, country,

       phone, workphone, fax, mobile,

       nick, url, notes, anniversary

Note: if you don't define any view, abook will use a default display basedon the above standard fields.

VARIABLES

autosave=[true|false]

Defines whether the addressbook is automatically saved on exit. Default is true.

preserve_fields=[all|standard|none]

Specifies how fields not declared with the field command nor in a viewshould be preserved while loading an abook database.

all: preserve any completely unknown field.
standard: only preserve the standard fields (see a list in the
description of the view command) and the legacy
'custom[1-5]' fields.
none: discards any unknown field.

Default is standard.

index_format=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:

{name:22}: displays the name field with a maximal width of 22 characters.
{phone:-12|workphone|mobile}: displays (right aligned within a width of 13 characters), either the phone, workphone or mobile field, whichever being the first to be non-empty.

Default is " {name:22} {email:40} {phone:12|workphone|mobile}"

show_all_emails=[true|false]

Defines whether all email addresses for a contact are shown in the main list view. Default is true.

emailpos

extra_column

extra_alternative

extraposObsoleted by index_format.

mutt_return_all_emails=[true|false]

Defines whether to return all email addresses matching the search criteria to a mutt query. Default is true.

print_command=command

Defines the command to used when printing the addressbook. Default is "lpr".

www_command=command

Defines the command used to start the web browser to view a contact's URL. Default is "lynx".

address_style=[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").

use_ascii_only=[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.

add_email_prevent_duplicates=[true|false]

Defines whether to avoid adding addresses already in data. Default is false.

sort_field=field

Defines the field to be used by the "sort by field" command. Default is "nick" (Nickname/Alias).

show_cursor=[true|false]

Defines if the cursor is visible in main display. Default is false.

use_mouse=[true|false]

Defines if navigation via the mouse is activated. Default is false.

use_colors=[true|false]

Defines if the output of abook is colorized. Default is false.

Color settings:

color_header_fg=colorForeground color for header bar

color_header_bg=colorBackground color for header bar

color_footer_fg=colorForeground color for footer bar

color_footer_bg=colorBackground color for footer bar

color_list_even_fg=colorForeground color for normal list entries with even index in the list (startingwith index 0)

color_list_even_bg=colorBackground color for normal list entries with even index in the list (startingwith index 0)

color_list_odd_fg=colorForeground color for normal list entries with odd index in the list (startingwith index 0)

color_list_odd_bg=colorBackground color for normal list entries with odd index in the list (startingwith index 0)

color_list_header_fg=colorForeground color for the list header

color_list_header_bg=colorBackground color for the list header

color_list_highlight_fg=colorForeground color for highlighted list entries

color_list_highlight_bg=colorBackground color for highlighted list entries

color_tab_border_fg=colorForeground color for tab borders on details page

color_tab_border_bg=colorBackground color for tab borders on details page

color_tab_label_fg=colorForeground color for tab labes on details page

color_tab_label_bg=colorBackground color for tab labes on details page

color_field_name_fg=colorForeground color for field names on details page

color_field_name_bg=colorBackground color for field names on details page

color_field_value_fg=colorForeground color for field values on details page

color_field_value_bg=colorBackground color for field values on details page

Where color can be: default, black, red, green, yellow, blue, magenta, cyan, white

SAMPLE CONFIGURATION FILE

# sample abook configuration file## Declare a few custom fieldsfield pager = Pagerfield address_lines = Address, listfield birthday = Birthday, date# Define how fields should be displayed in tabsview CONTACT = name, emailview ADDRESS = address_lines, city, state, zip, countryview PHONE = phone, workphone, pager, mobile, faxview OTHER = url, birthday# Preserve any unknown field while loading an abook databaseset preserve_fields=all# Automatically save database on exitset autosave=true# Format of entries lines in listset index_format=" {name:22} {email:40} {phone:12|workphone|mobile}"# Show all email addresses in listset show_all_emails=true# Command used to start muttset mutt_command=mutt# Return all email addresses to a mutt queryset mutt_return_all_emails=true# Command used to printset print_command=lpr# Command used to start the web browserset www_command=lynx# Address style [eu|us|uk]set address_style=eu# Use ASCII characters onlyset use_ascii_only=false# Prevent double entryset add_email_prevent_duplicates=false# Field to be used with "sort by field" commandset sort_field=nick# Show cursor in main displayset show_cursor=false

AUTHORS

This manual page was written by Alan Ford <alanAATTwhirlnet.co.uk> andexpanded by Cedric Duval <cedricduvalAATTfree.fr>.

abookwas written by Jaakko Heinonen <jheinonenAATTusers.sourceforge.net>

This document was created byman2html,using the manual pages.