From 40e67cb6338c0efa430b694a34bd77bd34ea96e3 Mon Sep 17 00:00:00 2001 From: Julian Mehne Date: Fri, 2 May 2014 12:03:00 +0200 Subject: [PATCH 1/2] Don't suggest that `name = value # A comment` is a valid definition. --- example.cfg | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/example.cfg b/example.cfg index 524cb62..685c761 100644 --- a/example.cfg +++ b/example.cfg @@ -38,9 +38,11 @@ b = bob_contacts_remote # collection each. collections = default,work -# conflict_resolution = None # abort when collisions occur (default) -# conflict_resolution = a wins # assume a's items to be more up-to-date -# conflict_resolution = b wins # assume b's items to be more up-to-date +# To resolve a conflict the following values are possible: +# `None` - abort when collisions occur (default) +# `a wins` - assume a's items to be more up-to-date +# `b wins` - assume b's items to be more up-to-date +#conflict_resolution = None [storage bob_contacts_local] # A storage references actual data on a remote server or on the local disk. @@ -48,15 +50,19 @@ collections = default,work type = filesystem path = ~/.contacts/ fileext = .vcf -#create = True # create directory if it doesn't exist +# Create the directory if it doesn't exist: `True` or `False` +#create = True #encoding = utf-8 [storage bob_contacts_remote] type = carddav url = https://owncloud.example.com/remote.php/carddav/addressbooks/bob/ -#auth = basic # basic|digest -#username = # for http auth, if empty, no auth will be used -#password = # can also be fetched from the system password storage or netrc +# There are two different authentication types: `basic` or `digest` +#auth = basic +# For http auth, if empty, no auth will be used +#username = +# The password can also be fetched from the system password storage or netrc +#password = #true: The NSA can spy on you with some effort #false: Everybody can spy on you with no effort From 17248012e45b5bf39da2284842874be45d86839d Mon Sep 17 00:00:00 2001 From: Julian Mehne Date: Fri, 2 May 2014 12:13:06 +0200 Subject: [PATCH 2/2] Add some information about the `verify` parameter. --- example.cfg | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/example.cfg b/example.cfg index 685c761..9a14d7d 100644 --- a/example.cfg +++ b/example.cfg @@ -64,9 +64,11 @@ url = https://owncloud.example.com/remote.php/carddav/addressbooks/bob/ # The password can also be fetched from the system password storage or netrc #password = -#true: The NSA can spy on you with some effort -#false: Everybody can spy on you with no effort -#path to SSL cert: People will call you paranoid +# SSL settings: +# `True` - The NSA can spy on you with some effort (use SSL) +# `False` - Everybody can spy on you with no effort (don't use SSL) +# `path/to/SSL/cert` - People will call you paranoid (if you use a self- +# signed certificate you need to copy it to this machine) #verify = True # CALDAV