Imported Upstream version 0.5.6+cvs1

[pkg/abook.git] / sample.abookrc

diff --git a/sample.abookrc b/sample.abookrc
index 086235f8185bc465ca628cbb2c676b609c19f3b9..315192d13dbc3db7678394b10e8caa80ae10a42c 100644 (file)
--- a/sample.abookrc
+++ b/sample.abookrc
@@ -1,9 +1,75 @@
 # sample abook configuration file
 # see abookrc(5) for detailed explanation
 
+##
+##  Commands
+## ==========
+
+
+#  Setting a variable
+# --------------------
+#
+# syntax: set <option> = <value>
+# 
+# See below for the list of available variables.
+
+
+#  Defining a new custom field
+# -----------------------------
+#
+# syntax: field <identifier> = <human readable name> [ , <type> ]
+#
+# with <type> being one of 'string' (default), 'emails', 'list', or 'day'
+#
+# Example of field definitions:
+field pager = Pager
+field address_lines = Address, list
+field birthday = Birthday, day
+
+
+#  Defining a view/tab
+# ---------------------
+#
+# view <view name> = <field1> [ , <field2>, ... ]
+#
+# with <fieldN> being the identifier of a field declared 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 based
+#       on the above standard fields.
+#
+# Example of views:
+view CONTACT = name, email
+view ADDRESS = address_lines, city, state, zip, country
+view PHONE = phone, workphone, pager, mobile, fax
+view OTHER = url, birthday
+
+
+
+##
+##  Variables
+## ===========
+
 # Automatically save database on exit
 set autosave=true
 
+# Specify how fields not declared with the 'field' command nor
+# in a view should be preserved while loading an abook database.
+#
+# It must be one of 'all', 'standard' (default), or 'none'.
+#   * '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.
+set preserve_fields=standard
+
 # Show all email addresses in list
 set show_all_emails=true
 
@@ -55,11 +121,3 @@ set sort_field=nick
 # show cursor in main display
 set show_cursor=false
 
-# custom fields
-
-#customfield 1 Name1
-#customfield 2 Name2
-#customfield 3 Name3
-#customfield 4 Name4
-#customfield 5 Name5
-