summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorPatrick Ohly <patrick.ohly@intel.com>2012-09-13 18:02:07 +0200
committerPatrick Ohly <patrick.ohly@intel.com>2012-10-25 16:43:46 +0200
commit849c5408e582189e92d920176109e97111ced043 (patch)
treef9e3423d6483f0e3fea1eec4d9a871e125b47d46 /README.rst
parenta4cc410b317c17b3c2060f8e487e3b65a5c506a4 (diff)
command line: implement --create/remove-database
Creating a database is only possible with a chosen name. The UID is chosen automatically by the storage. A new property would be needed to also specify the UID. There are no command line tests for the new functionality because support for it in backends is limited.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst23
1 files changed, 21 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index a3dedeb6..02585f4e 100644
--- a/README.rst
+++ b/README.rst
@@ -13,8 +13,8 @@ synchronize personal information management data
SYNOPSIS
========
-List databases:
- syncevolution --print-databases [<properties>] [<config> <source>]
+List and manipulate databases:
+ syncevolution --print-databases|--create-database|--remove-database [<properties>] [<config> <source>]
Show information about configuration(s):
syncevolution --print-servers|--print-configs|--print-peers
@@ -317,6 +317,25 @@ file backend synchronizes directories with one file per item and
always needs an explicit ``database`` property because it cannot guess
which directory it is meant to use. ::
+ syncevolution --create-database [<properties>] [<config> <source>]
+
+Creates a new database for the selected ``backend``, using the
+information given in the ``database`` property. As with
+``--print-databases``, it is possible to give the properties directly
+without configuring a source first.
+
+The interpretation of the ``database`` property depends on the
+backend. Not all backends support this operation.
+
+The EDS backend uses the value of the ``database`` as name of the new
+database and assigns a unique URI automatically. ::
+
+ syncevolution --remove-database [<properties>] [<config> <source>]
+
+Looks up the database based on the ``database`` property (depending
+on the backend, both name and a URI are valid), then deletes the data.
+Note that source configurations using the database are not removed. ::
+
syncevolution <config>
Without the optional list of sources, all sources which are enabled in