other versions
- wheezy 1.2.99.1-1.1
- wheezy-backports 1.4.99.4-2~bpo70+1
- jessie 1.4.99.4-3+b1
- testing 1.5.2-2
- unstable 1.5.2-2
SYNCEVOLUTION(1) | SYNCEVOLUTION(1) |
NAME¶
SyncEvolution - synchronize personal information management dataSYNOPSIS¶
- List databases:
- syncevolution --print-databases [<properties>] [<config> <source>]
- Show information about configuration(s):
- syncevolution --print-servers|--print-configs|--print-peers
- Show information about a specific configuration:
- syncevolution --print-config [--quiet] [--] <config> [main|<source> ...]
- List sessions:
- syncevolution --print-sessions [--quiet] [--] <config>
- Show information about SyncEvolution:
- syncevolution --help|-h|--version
- Run a synchronization as configured:
- syncevolution <config> [<source> ...]
- Run a synchronization with properties changed just for this run:
- syncevolution --run <options for run> [--] <config> [<source> ...]
- Restore data from the automatic backups:
- syncevolution --restore <session directory> --before|--after [--dry-run] [--] <config> <source> ...
- Create, update or remove a configuration:
- syncevolution --configure <options> [--]
<config> [<source> ...]
- List items:
- syncevolution --print-items [--] [<config> [<source>]]
- Export item(s):
- syncevolution [--delimiter <string>] --export <dir>|<file>|- [--] [<config> [<source> [<luid> ...]]]
- --luids <luid> ...
- Add item(s):
- syncevolution [--delimiter <string>|none] --import <dir>|<file>|- [--] [<config> [<source>]]
- --luids <luid> ...
- Update item(s):
- syncevolution --update <dir> [--] <config> <source>
- syncevolution [--delimiter <string>|none] --update <file>|- [--] <config> <source> <luid> ...
- --luids <luid> ...
- Remove item(s):
- syncevolution --delete-items [--] <config> <source> (<luid> ... | '*')
DESCRIPTION¶
This text explains the usage of the SyncEvolution command line.TERMINOLOGY¶
- peer
- A peer is the entity that data is synchronized with. This can be another device (like a phone), a server (like Google) or even the host itself (useful for synchronizing two different databases).
- host
- The device or computer that SyncEvolution runs on.
- database
- Each peer has one or more databases that get synchronized (Google Calendar, Google Contacts). Conceptually a database is a set of items where each item is independent of the others.
- data source
- A name for something that provides access to data. Primarily used for the configuration which combines backend and database settings, sometimes also instead of these two terms.
- local/remote
- Synchronization always happens between a pair of databases and thus has two sides. One database or side of a sync is remote (the one of the peer) or local (SyncEvolution). For the sake of consistency (and lack of better terms), these terms are used even if the peer is another instance of SyncEvolution and/or all data resides on the same storage.
- sync config
- A sync configuration defines how to access a peer: the
protocol which is to be used, how to find the peer, credentials, etc.
Peers might support more than one protocol, in which case multiple sync
configs have to be created.
- source config
- Each data source corresponds to a local database. A source
config defines how to access that database, like a sync config does for
peers. This information about a local database is independent of the peers
that the database might be synchronized with.
- •
- addressbook: a list of contacts
- •
- calendar: calendar events
- •
- memo: plain text notes
- •
- todo: task list
- •
- calendar+todo: a virtual source combining one local "calendar" and one "todo" source (required for synchronizing with some phones)
- backend
- Access to databases is provided by SyncEvolution backends. It does not matter where that data is stored. Some backends provide access to data outside of the host itself ( CalDAV and CardDAV, ActiveSync).
- configuration property
- Sync and source configs contain configuration properties.
Each property is a name/value pair. Sync properties are used in sync
configs, source properties in source configs. The names were chosen so
that they are unique, i.e., no sync property has the same name as a source
property.
- context
- Sync and source configs are defined inside a configuration context. Typically each context represents a certain set of sources. The values of shared properties are only shared inside their context. That way it is possible to define a second work context with a work calendar source using one database and use the implicit default context for a private calendar source with a different database.
- context config
- The shared and global properties of a certain context.
- configuration template
- Templates define the settings for specific peers. Some
templates are packaged together with SyncEvolution, others may be added by
packagers or users. Settings from templates are copied once into the sync
config when creating it. There is no permanent link back to the template,
so updating a template has no effect on configs created from it earlier.
- local sync
- Traditionally, a sync config specifies SyncML as the
synchronization protocol. The peer must support SyncML for this to work.
When the peer acts as SyncML server, conflict resolution happens on the
peer, outside of the control of SyncEvolution.
- target config
- In addition to the normal sync config, a local sync also uses a target config. This target config is a special kind of sync config. It defines sync properties that are necessary to access databases on the other side of the local sync. Sync configs can have arbitrary names while a target config must be named target-config.
COMMAND LINE CONVENTIONS¶
The <config> and the <source> strings in the command line synopsis are used to find the sync resp. source configs. Depending on which other parameters are given, different operations are executed.[<source>/]<name>[@<context>|@<peer>@<context>]=<value>
--run loglevel@default=1 loglevel@google-calendar=4 google-calendar@default
--configure "addressbook/database=My Addressbook" \ "calendar/database=My Calendar" \ @default addressbook calendar
--configure "database=My Addressbook" @default addressbook --configure "calendar/database=My Calendar" @default calendar
--configure --source-property addressbook/sync=none \ --source-property sync=two-way \ <sync config>
USAGE¶
syncevolution --print-databases [<properties>] [<config> <source>]
syncevolution <config>
syncevolution <config> <source> ...
syncevolution --configure <options for configuration> <config> [<source> ...]
syncevolution --remove <config>
syncevolution --run <options for run> <config> [<source> ...]
syncevolution --status <config> [<source> ...]
syncevolution --print-servers|--print-configs|--print-peers syncevolution --print-config [--quiet] <config> [main|<source> ...] syncevolution --print-sessions [--quiet] <config>
syncevolution --restore <session directory> --before|--after [--dry-run] <config> <source> ...
syncevolution --print-items <config> <source> syncevolution [--delimiter <string>] --export <dir>|<file>|- [<config> [<source> [<luid> ...]]] syncevolution [--delimiter <string>|none] --import <dir>|<file>|- [<config> <source>] syncevolution --update <dir> <config> <source> syncevolution [--delimiter <string>|none] --update <file>|- <config> <source> <luid> ... syncevolution --delete-items <config> <source> (<luid> ... | *)
syncevolution --print-items backend=evolution-contacts syncevolution --export - backend=evolution-contacts \ --luids pas-id-4E33F24300000006 pas-id-4E36DD7B00000007
OPTIONS¶
Here is a full description of all <options> that can be put in front of the server name. Whenever an option accepts multiple values, a question mark can be used to get the corresponding help text and/or a list of valid values.- --sync|-s <mode>|?
- Temporarily synchronize the active sources in that mode.
Useful for a refresh-from-local or refresh-from-remote sync
which clears all data at one end and copies all items from the other.
- --print-servers|--print-configs|--print-peers
- Prints the names of all configured peers to stdout. There is no difference between these options, the are just aliases.
- --print-servers|--print-configs|--print-peers|-p
- Prints the complete configuration for the selected <config> to stdout, including up-to-date comments for all properties. The format is the normal .ini format with source configurations in different sections introduced with [<source>] lines. Can be combined with --sync-property and --source-property to modify the configuration on-the-fly. When one or more sources are listed after the <config> name on the command line, then only the configs of those sources are printed. main selects the main configuration instead of source configurations. Using --quiet suppresses the comments for each property. When setting a --template, then the reference configuration for that peer is printed instead of an existing configuration.
- --print-sessions
- Prints information about previous synchronization sessions for the selected peer or context are printed. This depends on the logdir property. The information includes the log directory name (useful for --restore) and the synchronization report. In combination with --quiet, only the paths are listed.
- --configure|-c
- Modify the configuration files for the selected peer and/or
sources.
- use `--template none` or - specify all required sync and source properties that are normally in the templates on the command line (syncURL, backend, ...)
- --run|-r
- To prevent accidental sync runs when a configuration change was intended, but the --configure option was not used, --run must be specified explicitly when sync or source properties are selected on the command line and they are meant to be used during a sync session triggered by the invocation.
- --migrate
- In older SyncEvolution releases a different layout of
configuration files was used. Using --migrate will automatically migrate
to the new layout and rename the <config> into <config>.old to
prevent accidental use of the old configuration. WARNING: old
SyncEvolution releases cannot use the new configuration!
- --print-items
- Shows all existing items using one line per item using the format "<luid>[: <short description>]". Whether the description is available depends on the backend and the kind of data that it stores.
- --export
- Writes all items in the source or all items whose
<luid> is given into a directory if the --export parameter exists
and is a directory. The <luid> of each item is used as file name.
Otherwise it creates a new file under that name and writes the selected
items separated by the chosen delimiter string. stdout can be selected
with a dash.
- --import
- Adds all items found in the directory or input file to the source. When reading from a directory, each file is treated as one item. Otherwise the input is split at the chosen delimiter. "none" as delimiter disables splitting of the input.
- --update
- Overwrites the content of existing items. When updating from a directory, the name of each file is taken as its luid. When updating from file or stdin, the number of luids given on the command line must match with the number of items in the input.
- --delete-items
- Removes the specified items from the source. Most backends print some progress information about this, but besides that, no further output is produced. Trying to remove an item which does not exist typically leads to an ERROR message, but is not reflected in a non-zero result of the command line invocation itself because the situation is not reported as an error by backends (removal of non-existent items is not an error in SyncML). Use a star * instead or in addition to listing individual luids to delete all items.
- --sync-property|-y <property>=<value>|<property>=?|?
- Overrides a source-independent configuration property for the current synchronization run or permanently when --configure is used to update the configuration. Can be used multiple times. Specifying an unused property will trigger an error message.
- --source-property|-z <property>=<value>|<property>=?|?
- Same as --sync-property, but applies to the configuration of all active sources. --sync <mode> is a shortcut for --source-property sync=<mode>.
- --template|-l <peer name>|default|?<device>
- Can be used to select from one of the built-in default
configurations for known SyncML peers. Defaults to the <config>
name, so --template only has to be specified when creating multiple
different configurations for the same peer, or when using a template that
is named differently than the peer. default is an alias for
memotoo and can be used as the starting point for servers which do
not have a built-in template.
- --status|-t
- The changes made to local data since the last synchronization are shown without starting a new one. This can be used to see in advance whether the local data needs to be synchronized with the server.
- --quiet|-q
- Suppresses most of the normal output during a synchronization. The log file still contains all the information.
- --keyring[=<value>]|-k
- A legacy option, now the same as setting the global keyring sync property. When not specifying a value explicitly, "true" for "use some kind of keyring" is implied. See "--sync-property keyring" for details.
- --daemon[=yes/no]
- By default, the SyncEvolution command line is executed inside the syncevo-dbus-server process. This ensures that synchronization sessions started by the command line do not conflict with sessions started via some other means (GUI, automatically). For debugging purposes or very special use cases (running a local sync against a server which executes inside the daemon) it is possible to execute the operation without the daemon (--daemon=no).
- --help|-h
- Prints usage information.
- --version
- Prints the SyncEvolution version.
CONFIGURATION PROPERTIES¶
This section lists predefined properties. Backends can add their own properties at runtime if none of the predefined properties are suitable for a certain setting. Those additional properties are not listed here. Use --sync/source-property ? to get an up-to-date list.Sync properties¶
- syncURL (no default, unshared, required)
- Identifies how to contact the peer, best explained with
some examples.
http://my.funambol.com/sync http://sync.scheduleworld.com/funambol/ds https://m.google.com/syncml
obex-bt://00:0A:94:03:F3:7E
obex-bt://00:0A:94:03:F3:7E+16
obex-bt://00:0A:94:03:F3:7E obex-bt://00:01:02:03:04:05
- username (no default, unshared)
- user name used for authorization with the SyncML server
- password (no default, unshared)
- password used for authorization with the peer; in addition
to specifying it directly as plain text, it can also be read from the
standard input or from an environment variable of your choice:
plain text : password = <insert your password here> ask : password = - env variable: password = ${<name of environment variable>}
- logdir (no default, shared)
- full path to directory where automatic backups and logs are stored for all synchronizations; if unset, then "${XDG_CACHE_HOME}/syncevolution/<server>" (which usually expands to ${HOME}/.cache/...) will be used; if "none", then no backups of the databases are made and any output is printed directly to the screen
- loglevel (0, unshared)
- level of detail for log messages: - 0 (or unset) = INFO messages without log file, DEBUG with log file - 1 = only ERROR messages - 2 = also INFO messages - 3 = also DEBUG messages > 3 = increasing amounts of debug messages for developers
- notifyLevel (3, unshared)
- Level of detail for desktop notifications. Currently such
notifications are generated only for automatically started sync sessions.
- printChanges (TRUE, unshared)
- enables or disables the detailed (and sometimes slow) comparison of database content before and after a sync session
- dumpData (TRUE, unshared)
- enables or disables the automatic backup of database content before and after a sync session (always enabled if printChanges is enabled)
- maxlogdirs (10, shared)
- Unless this option is set, SyncEvolution will never delete anything in the "logdir". If set, the oldest directories and all their content will be removed after a successful sync to prevent the number of log directories from growing beyond the given limit.
- autoSync (0, unshared)
- Controls automatic synchronization. Currently, automatic synchronization is done by running a synchronization at regular intervals. This may drain the battery, in particular when using Bluetooth! Because a peer might be reachable via different transports at some point, this option provides detailed control over which transports may be used for automatic synchronization:
- 0
- don't do auto sync
- 1
- do automatic sync, using whatever transport
- is available
- http
- only via HTTP transport
- obex-bt
- only via Bluetooth transport
- http,obex-bt
- pick one of these
- autoSyncInterval (30M, unshared)
- This is the minimum number of seconds between two
synchronizations that has to pass before starting an automatic
synchronization. Can be specified using a 1h30m5s format.
- autoSyncDelay (5M, unshared)
- An automatic sync will not be started unless the peer has
been available for this duration, specified in seconds or 1h30m5s format.
- preventSlowSync (TRUE, unshared)
- During a slow sync, the SyncML server must match all items of the client with its own items and detect which ones it already has based on properties of the items. This is slow (client must send all its data) and can lead to duplicates (when the server fails to match correctly). It is therefore sometimes desirable to wipe out data on one side with a refresh-from-client/server sync instead of doing a slow sync. When this option is enabled, slow syncs that could cause problems are not allowed to proceed. Instead, the affected sources are skipped, allowing the user to choose a suitable sync mode in the next run (slow sync selected explicitly, refresh sync). The following situations are handled:
- •
- running as client with no local data => unproblematic, slow sync is allowed to proceed automatically
- •
- running as client with local data => client has no information about server, so slow sync might be problematic and is prevented
- •
- client has data, server asks for slow sync because all its data was deleted (done by Memotoo and Mobical, because they treat this as 'user wants to start from scratch') => the sync would recreate all the client's data, even if the user really wanted to have it deleted, therefore slow sync is prevented
- useProxy (FALSE, unshared)
- set to T to choose an HTTP proxy explicitly; otherwise the default proxy settings of the underlying HTTP transport mechanism are used; only relevant when contacting the peer via HTTP
- proxyHost (no default, unshared)
- proxy URL (http://<host>:<port>)
- proxyUsername (no default, unshared)
- authentication for proxy: username
- proxyPassword (no default, unshared)
- proxy password, can be specified in different ways, see SyncML server password for details
- clientAuthType (md5, unshared)
- •
- empty or "md5" for secure method (recommended)
- •
- "basic" for insecure method
- RetryDuration (5M, unshared)
- The total amount of time in seconds in which the SyncML
client tries to get a response from the server. During this time, the
client will resend messages in regular intervals (RetryInterval) if no
response is received or the message could not be delivered due to
transport problems. When this time is exceeded without a response, the
synchronization aborts without sending further messages to the server.
- RetryInterval (2M, unshared)
- The number of seconds between the start of SyncML message
sending and the start of the retransmission. If the interval has already
passed when a message send returns, the message is resent immediately.
Resending without any delay will never succeed and therefore specifying 0
disables retries.
- remoteIdentifier (no default, unshared)
- the identifier sent to the remote peer for a server initiated sync. if not set, deviceId will be used instead
- PeerIsClient (FALSE, unshared)
- Indicates whether this configuration is about a client peer or server peer.
- SyncMLVersion (no default, unshared)
- On a client, the latest commonly supported SyncML version
is used when contacting a server. one of '1.0/1.1/1.2' can be used to pick
a specific version explicitly.
- PeerName (no default, unshared)
- An arbitrary name for the peer referenced by this config. Might be used by a GUI. The command line tool always uses the the configuration name.
- deviceId (no default, shared)
- The SyncML server gets this string and will use it to keep track of changes that still need to be synchronized with this particular client; it must be set to something unique (like the pseudo-random string created automatically for new configurations) among all clients accessing the same server. myFUNAMBOL also requires that the string starts with sc-pim-
- remoteDeviceId (no default, unshared)
- SyncML ID of our peer, empty if unknown; must be set only
when the peer is a SyncML client contacting us via HTTP. Clients
contacting us via OBEX/Bluetooth can be identified either via this
remoteDeviceId property or by their MAC address, if that was set in the
syncURL property.
- enableWBXML (TRUE, unshared)
- use the more compact binary XML (WBXML) for messages between client and server; not applicable when the peer is a SyncML client, because then the client chooses the encoding
- enableRefreshSync (FALSE, unshared)
- Use the more advanced refresh-from-server sync mode to implement the refresh-from-remote operation. Some SyncML servers do not support this. Therefore the default is to delete local data before doing a slow sync, which has the same effect. However, some servers work better when they are told explicitly that the sync is a refresh sync. For example, Funambol's One Media server rejects too many slow syncs in a row with a 417 'retry later' error.
- maxMsgSize (150000, unshared), maxObjSize (4000000, unshared)
- The maximum size of each message can be set (maxMsgSize) and the peer can be told to never sent items larger than a certain threshold (maxObjSize). Presumably the peer has to truncate or skip larger items. Sizes are specified as number of bytes.
- SSLServerCertificates (/etc/ssl/certs/ca-certificates.crt:/etc/pki/tls/certs/ca-bundle.crt:/usr/share/ssl/certs/ca-bundle.crt, unshared)
- A string specifying the location of the certificates used
to authenticate the server. When empty, the system's default location will
be searched.
- SSLVerifyServer (TRUE, unshared)
- The client refuses to establish the connection unless the server presents a valid certificate. Disabling this option considerably reduces the security of SSL (man-in-the-middle attacks become possible) and is not recommended.
- SSLVerifyHost (TRUE, unshared)
- The client refuses to establish the connection unless the server's certificate matches its host name. In cases where the certificate still seems to be valid it might make sense to disable this option and allow such connections.
- WebURL (no default, unshared)
- The URL of a web page with further information about the server. Used only by the GUI.
- IconURI (no default, unshared)
- The URI of an icon representing the server graphically. Should be a 48x48 pixmap or a SVG (preferred). Used only by the GUI.
- ConsumerReady (FALSE, unshared)
- Set to true in a configuration template to indicate that the server works well enough and is available for normal users. Used by the GUI to limit the choice of configurations offered to users. Has no effect in a user's server configuration.
- peerType (no default, unshared)
- Defines what a configuration is meant to be used for. Used in templates and the resulting configs to tell a GUI that special handling may be necessary. GUIs should ignore unknown types. The traditional SyncML configs use an empty value. "WebDAV" is used for the WebDAV side in a local synchronization.
- defaultPeer (no default, global)
- the peer which is used by default in some frontends, like the sync-UI
- keyring (yes, global)
- Explicitly selects a certain safe password storage. Depending on how SyncEvolution was compiled and installed the following values are possible:
- GNOME
- GNOME Keyring
- KDE
- KWallet
- yes/true/1
- pick one automatically
- no/false/0
- store passwords in SyncEvolution config files
--keyring --configure proxyPassword=foo
Source properties¶
- sync (disabled, unshared, required)
- Requests a certain synchronization mode when initiating a sync:
- two-way
- only send/receive changes since last sync
- slow
- exchange all items
- refresh-from-remote
- discard all local items and replace with the items on the peer
- refresh-from-local
- discard all items on the peer and replace with the local items
- one-way-from-remote
- transmit changes from peer
- one-way-from-local
- transmit local changes
- disabled (or none)
- synchronization disabled
- uri (no default, unshared)
- this is appended to the server's URL to identify the server's database; if unset, the source name is used as fallback
- backend (select backend, shared)
- Specifies the SyncEvolution backend and thus the data which
is synchronized by this source. Each backend may support multiple
databases (see 'database' property), different formats inside that
database (see 'databaseFormat'), and different formats when talking to the
sync peer (see 'syncFormat' and 'forceSyncFormat').
- syncFormat (no default, unshared)
- When there are alternative formats for the same data, each side of a sync offers all that it supports and marks one as preferred. If set, this property overrides the format that would normally be marked as preferred by a backend.
- Valid values depend on the backend. Here are some examples:
- contacts - text/vcard = vCard 3.0 format
- text/x-vcard = legacy vCard 2.1 format
- calendar - text/calendar = iCalendar 2.0 format
- text/x-vcalendar = legacy vCalendar 1.0 format
- forceSyncFormat (FALSE, unshared)
- Some peers get confused when offered multiple choices for the sync format or pick the less optimal one. In such a case, setting this property enforces that the preferred format specified with 'syncFormat' is really used.
- database = evolutionsource (no default, shared)
- Picks one of the backend's databases: depending on the
backend, one can set the name and/or a unique identifier.
- databaseFormat (no default, shared)
- Defines the data format to be used by the backend for its own storage. Typically backends only support one format and ignore this property, but for example the file backend uses it. See the 'backend' property for more information.
- databaseUser = evolutionuser (no default, shared), databasePassword = evolutionpassword (no default, shared)
- authentication for backend data source; password can be
specified in multiple ways, see SyncML server password for details
EXAMPLES¶
List the known configuration templates:syncevolution --template ?
syncevolution --configure \ username=123456 \ "password=!@#ABcd1234" \ memotoo
syncevolution --print-configs
syncevolution --print-config memotoo
syncevolution memotoo
syncevolution --configure \ sync=none \ memotoo
syncevolution --configure \ --sync two-way \ memotoo addressbook
syncevolution --configure \ password=foo \ memotoo
syncevolution --configure \ username=joe \ password=foo \ --template memotoo \ memotoo_joe
syncevolution --configure \ username=123456 \ password=!@#ABcd1234" \ sync=none \ memotoo@other syncevolution --configure \ --source-property database=<name of other address book> \ @other addressbook syncevolution --configure \ sync=two-way \ memotoo@other addressbook syncevolution memotoo syncevolution memotoo@other
syncevolution --migrate memotoo
SYNCHRONIZATION BEYOND SYNCML¶
In the simple examples above, SyncEvolution exchanges data with servers via the SyncML protocol. Starting with release 1.2, SyncEvolution also supports other protocols like CalDAV and CardDAV.- •
- synchronize events with a CalDAV server and contacts with a CardDAV server
- •
- mirror a local database as items in a directory, with format conversion and one-way or two-way data transfer (export vs. true syncing)
Warning: because the client in the
local sync starts the sync, preventSlowSync=0 must be set in the target
config to have an effect.
CALDAV AND CARDDAV¶
This section explains how to use local syncing for CalDAV and CardDAV. Both protocols are based on WebDAV and are provided by the same backend. They share username/password/syncURL properties defined in their target config.Warning: the protocols do not uniquely
identify this default collection. The backend tries to make an educated guess,
but it might pick the wrong one if the server provides more than one address
book or calendar. It is safer to scan for collections manually with
--print-databases and then use the URL of the desired collection as
value of database.
syncevolution --print-databases \ backend=<caldav or carddav> \ username=<email address or user name> \ "password=!@#ABcd1234" \ syncURL=<base URL of server, if auto-discovery is not supported>
# configure target config syncevolution --configure \ --template webdav \ username=123456@example.com \ "password=!@#ABcd1234" \ target-config@webdav # configure sync config syncevolution --configure \ --template SyncEvolution_Client \ syncURL=local://@webdav \ username= \ password= \ webdav \ calendar addressbook # initial slow sync syncevolution --sync slow webdav # incremental sync syncevolution webdav
# A) Server has one URL as starting point instead of DNS auto-discovery. syncevolution --configure \ --template webdav \ username=123456 \ "password=!@#ABcd1234" \ syncURL=http://example.com \ target-config@webdav # B) Explicitly specify collections (from server documentation or --print-databases). # The 'calendar' and 'addressbook' names are the ones expected by the sync config # above, additional sources can also be configured and/or the names can be changed. syncevolution --configure \ username=123456 \ "password=!@#ABcd1234" \ addressbook/backend=carddav \ addressbook/database=http://example.com/addressbooks/123456/ \ calendar/backend=caldav \ calendar/database=http://example.com/calendar/123456/ \ target-config@webdav \ calendar addressbook
# configure sources syncevolution --configure \ databaseUser=123456 \ "databasePassword=!@#ABcd1234" \ addressbook/backend=carddav \ addressbook/database=http://example.com/addressbooks/123456/ \ calendar/backend=caldav \ calendar/database=http://example.com/calendar/123456/ \ @webdav \ calendar addressbook # configure one peer (Memotoo in this example): syncevolution --configure \ username=654321 \ password=^749@2524 \ memotoo@webdav # sync syncevolution --sync slow memotoo@webdav
NOTES¶
Exchanging Data¶
SyncEvolution transmits address book entries as vCard 2.1 or 3.0 depending on the sync format chosen in the configuration. Evolution uses 3.0 internally, so SyncEvolution converts between the two formats as needed. Calendar items and tasks can be sent and received in iCalendar 2.0 as well as vCalendar 1.0, but vCalendar 1.0 should be avoided if possible because it cannot represent all data that Evolution stores.- Note
- The Evolution backends are mentioned as examples; the same applies to other data sources.
- 1.
- synchronize the address book with the server
- 2.
- create a new address book in Evolution and view it in Evolution once (the second step is necessary in at least Evolution 2.0.4 to make the new address book usable in SyncEvolution)
- 3.
- add a configuration for that second address book and the same URI on the SyncML server, see EXAMPLES above
- 4.
- synchronize again, this time using the other data source
- •
- save the complete address books: mark all entries, save as vCard
- •
- invoke synccompare with two file names as arguments and it will normalize and compare them automatically
Item Changes and Data Changes¶
SyncML clients and servers consider each entry in a database as one item. Items can be added, removed or updated. This is the item change information that client and server exchange during a normal, incremental synchronization.Automatic Backups and Logging¶
To support recovery from a synchronization which damaged the local data or modified it in an unexpected way, SyncEvolution can create the following files during a synchronization:- •
- a dump of the data in a format which can be restored by SyncEvolution, usually a single file per item containing in a standard text format (VCARD/VCALENDAR)
- •
- a full log file with debug information
- •
- another dump of the data after the synchronization for automatic comparison of the before/after state with synccompare
ENVIRONMENT¶
The following environment variables control where SyncEvolution finds files and other aspects of its operations.- http_proxy
- Overrides the proxy settings temporarily. Setting it to an empty value disables the normal proxy settings.
- HOME/XDG_CACHE_HOME/XDG_CONFIG_HOME
- SyncEvolution follows the XDG desktop standard for its files. By default, $HOME/.config/syncevolution is the location for configuration files. $HOME/.cache/syncevolution holds session directories with log files and database dumps.
- SYNCEVOLUTION_DEBUG
- Setting this to any value disables the filtering of stdout and stderr that SyncEvolution employs to keep noise from system libraries out of the command line output.
- SYNCEVOLUTION_GNUTLS_DEBUG
- Enables additional debugging output when using the libsoup HTTP transport library.
- SYNCEVOLUTION_DATA_DIR
- Overrides the default path to the bluetooth device lookup table, normally /usr/lib/syncevolution/.
- SYNCEVOLUTION_BACKEND_DIR
- Overrides the default path to plugins, normally /usr/lib/syncevolution/backends.
- SYNCEVOLUTION_LIBEXEC_DIR
- Overrides the path where additional helper executables are found, normally /usr/libexec.
- SYNCEVOLUTION_TEMPLATE_DIR
- Overrides the default path to template files, normally /usr/share/syncevolution/templates.
- SYNCEVOLUTION_XML_CONFIG_DIR
- Overrides the default path to the Synthesis XML
configuration files, normally /usr/share/syncevolution/xml. These
files are merged into one configuration each time the Synthesis SyncML
engine is started as part of a sync session.
BUGS¶
See known issues and the support web page for more information.SEE ALSO¶
http://syncevolution.orgAUTHORS¶
- Main developer
- Patrick Ohly <patrick.ohly@intel.com>, http://www.estamos.de
- Contributors
- http://syncevolution.org/about/contributors
- To contact the project publicly (preferred)
- syncevolution@syncevolution.org
- Intel-internal team mailing list (confidential)
- syncevolution@lists.intel.com
2013-04-01 | 1.2.99.1 |