Merge remote-tracking branch 'upstream/master' into upstream

[pkg/abook.git] / abookrc.5

diff --git a/abookrc.5 b/abookrc.5
index 04e51493c0314fdc59a1da6698c79113de9b8e21..88e05f6bc94cd8738395a86a9055bf72f7d82fb7 100644 (file)
--- a/abookrc.5
+++ b/abookrc.5
@@ -74,7 +74,7 @@ preserve any completely unknown field.
 .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.
@@ -90,8 +90,8 @@ Defines the way entries are displayed in the main list. This is a string contain
 \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.
+\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
@@ -132,7 +132,7 @@ Defines the style of address formatting to be used when exporting as text / prin
 
 .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]
@@ -146,6 +146,89 @@ Defines the field to be used by the "sort by field" command. Default is "nick" (
 \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