.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'.
+, 'emails', 'list', or 'date'.
.TP
\fBview\fP \fIview name\fP = \fIfield1\fP [ , \fIfield2\fP, ... ]
.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.
+ 'custom[1\-5]' fields.
.TP
.B none
discards any unknown field.
+.RE
.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
-
+\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
-\fBemailpos\fP=column
-Defines the screen column on the main list where the email address is to begin. Default is 25.
-
+\fI{name:22}\fP
+displays the \fIname\fP field with a maximal width of 22 characters.
.TP
-\fBextra_column\fP=field
-Defines the field to display in the extra (third) column on the main list. Default is "phone" (Home Phone).
+\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
-\fIfield\fP can be any of the following:
-.br
--1 disabled
-.br
-phone Home Phone
-.br
-workphone Work Phone
-.br
-fax Fax
-.br
-mobile Mobile Phone
-.br
-nick Nickname/Alias
-.br
-url URL
-.br
-notes Notes
+Default is \fI" {name:22} {email:40} {phone:12|workphone|mobile}"\fP
.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.
+\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
-\fBextrapos\fP=column
-Defines the screen column on the main list where the extra field is to begin. Default is 65.
-
+.PD 0
+\fBemailpos\fP
+.TP
+.PD 0
+\fBextra_column\fP
.TP
-\fBmutt_command\fP=command
-Defines the command to start mutt. Default is "mutt".
+.PD 0
+\fBextra_alternative\fP
+.TP
+.PD
+\fBextrapos\fP
+Obsoleted by \fBindex_format\fP.
.TP
\fBmutt_return_all_emails\fP=[true|false]
.TP
\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.
+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]
\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. Most terminals can also inhibit ncurses mouse events at runtime by holding the Shift key (restoring mouse\-selection behavior).
+
+.TP
+\fBscroll_speed\fP=lines
+Defines the number of lines the address list is scrolled by on a mouse wheel
+action. This option only takes effect if use_mouse is enabled. Default is 2.
+
+.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
# Declare a few custom fields
field pager = Pager
field address_lines = Address, list
-field birthday = Birthday, day
+field birthday = Birthday, date
# Define how fields should be displayed in tabs
view CONTACT = name, email
# 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
-# Screen column for email field to start
-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 Nickname/Alias
-# url URL
-
-#
-set extra_alternative=-1
-
-# Screen column for the extra field to start
-set extrapos=65
-
# Command used to start mutt
set mutt_command=mutt
# Command used to start the web browser
set www_command=lynx
-# address style [eu|us|uk]
+# Address style [eu|us|uk]
set address_style=eu
-# use ASCII characters only
+# Use ASCII characters only
set use_ascii_only=false
# Prevent double entry
set add_email_prevent_duplicates=false
-# field to be used with "sort by field" command
+# Field to be used with "sort by field" command
set sort_field=nick
-# show cursor in main display
+# Show cursor in main display
set show_cursor=false
.fi
projects / pkg / abook.git / blobdiff