| Manual section: | 1 |
|---|---|
| Version: | 1.3.1 |
| Date: | 2012-10-20 |
syncevolution --configure <options> [--] <config> [<source> ...]
syncevolution --remove|--migrate <options> [--] <config>
syncevolution --update <dir> [--] <config> <source>
This text explains the usage of the SyncEvolution command line.
SyncEvolution synchronizes personal information management (PIM) data such as contacts, appointments, tasks and memos using the Synthesis sync engine, which provides support for the SyncML synchronization protocol.
SyncEvolution synchronizes with SyncML servers over HTTP and with SyncML capable phones locally over Bluetooth (new in 1.0). Plugins provide access to the data which is to be synchronized. Binaries are available for Linux desktops (synchronizing data in GNOME Evolution, with KDE supported indirectly already and Akonadi support in development), for MeeGo (formerly Moblin) and for Maemo 5/Nokia N900. The source code can be compiled for Unix-like systems and provides a framework to build custom SyncML clients or servers.
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.
Sync configs can be used to initiate a sync (like contacting a SyncML server) or to handle an incoming sync request (when acting as SyncML server which is contacted by the peer).
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.
Sync configs use these shared source configs and add additional, per-peer settings to each of them that define how that local database maps to a remote database in the peer. By default a source config is inactive inside a sync config and thus ignored. It must be activated by setting the unshared sync property to something other than none (aka disabled).
In SyncEvolution's predefined configuration templates, the following names for sources are used. Different names can be chosen for sources that are defined manually.
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.
A property can be unshared (has separate values for each peer, therefore sometimes also called per-peer; for example the uri property which defines the remote database), shared (same value for all peers; for example the database property for selecting the local database) or global (exactly one value).
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.
A template only contains unshared properties. Therefore it is possible to first set shared properties (for example, choosing which databases to synchronize in the default context), then add sync configs for different peers to that context without reseting the existing settings.
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.
In a so called local sync, SyncEvolution connects two of its own backends and runs all of the synchronization logic itself on the host.
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.
A config name has the format [<peer>][@<context>]. When the context is not specified explicitly, SyncEvolution first searches for an existing configuration with the given name. If not found, it uses the @default context as fallback. Thus the empty config name is an alias for @default.
The <peer> part identifies a specific sync or target config inside the context. It is optional and does not have to be specified when not needed, for example when configuring the shared settings of sources (--configure @default addressbook) or accessing items inside a source (--print-items @work calendar).
Listing sources on the command line limits the operation to those sources (called active sources below). If not given, all sources defined for the config are active. Some operations require the name of exactly one source.
Properties are set with key/value assignments and/or the --sync/source-property keywords. Those keywords are only needed for the hypothetical situation that a sync and source property share the same name (not normally the case). Without them, SyncEvolution automatically identifies which kind of property is meant based on the name.
A <property> assignment has the following format:
[<source>/]<name>[@<context>|@<peer>@<context>]=<value>
The optional <context> or <peer>@<context> suffix limits the scope of the value to that particular configuration. This is useful when running a local sync, which involves a sync and a target configuration. For example, the log level can be specified separately for both sides:
--run loglevel@default=1 loglevel@google-calendar=4 google-calendar@default
A string without a second @ sign inside is always interpreted as a context name, so in contrast to the <config> string, foo cannot be used to reference the foo@default configuration. Use the full name including the context for that.
When no config or context is specified explicitly, a value is changed in all active configs, typically the one given with <config>. The priority of multiple values for the same config is more specific definition wins, so <peer>@<context> overrides @<context>, which overrides no suffix given. Specifying some suffix which does not apply to the current operation does not trigger an error, so beware of typos.
Source properties can be specified with a <source>/ prefix. This allows limiting the value to the selected source. For example:
--configure "addressbook/database=My Addressbook" \
"calendar/database=My Calendar" \
@default addressbook calendar
Another way to achieve the same effect is to run the --configure operation twice, once for addressbook and once for calendar:
--configure "database=My Addressbook" @default addressbook --configure "calendar/database=My Calendar" @default calendar
If the same property is set both with and without a <source>/ prefix, then the more specific value with that prefix is used for that source, regardless of the order on the command line. The following command enables all sources except for the addressbook:
--configure --source-property addressbook/sync=none \
--source-property sync=two-way \
<sync config>
syncevolution --print-databases [<properties>] [<config> <source>]
If no additional arguments are given, then SyncEvolution will list all available backends and the databases that can be accessed through each backend. This works without existing configurations. However, some backends, like for example the CalDAV backend, need additional information (like credentials or URL of a remote server). This additional information can be provided on the command line with property assignments (username=...) or in an existing configuration.
When listing all databases of all active sources, the output starts with a heading that lists the values for the backend property which select the backend, followed by the databases. Each database has a name and a unique ID (in brackets). Typically both can be used as value of the 'database' property. One database might be marked as default. It will be used when database is not set explicitly.
When selecting an existing source configuration or specifying the backend property on the command line, only the databases for that backend are listed and the initial line shows how that backend was selected (<config>/<source> resp. backend value).
Some backends do not support listing of databases. For example, the 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 <config>
Without the optional list of sources, all sources which are enabled in their configuration file are synchronized.
syncevolution <config> <source> ...
Otherwise only the ones mentioned on the command line are active. It is possible to configure sources without activating their synchronization: if the synchronization mode of a source is set to disabled, the source will be ignored. Explicitly listing such a source will synchronize it in two-way mode once.
Progress and error messages are written into a log file that is preserved for each synchronization run. Details about that is found in the Automatic Backups and Logging section below. All errors and warnings are printed directly to the console in addition to writing them into the log file. Before quitting SyncEvolution will print a summary of how the local data was modified. This is done with the synccompare utility script described in the Exchanging Data section.
When the logdir property is enabled (since v0.9 done by default for new configurations), then the same comparison is also done before the synchronization starts.
In case of a severe error the synchronization run is aborted prematurely and SyncEvolution will return a non-zero value. Recovery from failed synchronization is done by forcing a full synchronization during the next run, i.e. by sending all items and letting the SyncML server compare against the ones it already knows. This is avoided whenever possible because matching items during a slow synchronization can lead to duplicate entries.
After a successful synchronization the server's configuration file is updated so that the next run can be done incrementally. If the configuration file has to be recreated e.g. because it was lost, the next run recovers from that by doing a full synchronization. The risk associated with this is that the server might not recognize items that it already has stored previously which then would lead to duplication of items.
syncevolution --configure <options for configuration> <config> [<source> ...]
Options in the configuration can be modified via the command line. Source properties are changed for all sources unless sources are listed explicitly. Some source properties have to be different for each source, in which case syncevolution must be called multiple times with one source listed in each invocation.
syncevolution --remove <config>
Deletes the configuration. If the <config> refers to a specific peer, only that peer's configuration is removed. If it refers to a context, that context and all peers inside it are removed.
Note that there is no confirmation question. Neither local data referenced by the configuration nor the content of log dirs are deleted.
syncevolution --run <options for run> <config> [<source> ...]
Options can also be overridden for just the current run, without changing the configuration. In order to prevent accidentally running a sync session when a configuration change was intended, either --configure or --run must be given explicitly if options are specified on the command line.
syncevolution --status <config> [<source> ...]
Prints what changes were made locally since the last synchronization. Depends on access to database dumps from the last run, so enabling the logdir property is recommended.
syncevolution --print-servers|--print-configs|--print-peers syncevolution --print-config [--quiet] <config> [main|<source> ...] syncevolution --print-sessions [--quiet] <config>
These commands print information about existing configurations. When printing a configuration a short version without comments can be selected with --quiet. When sources are listed, only their configuration is shown. Main instead or in combination with sources lists only the main peer configuration.
syncevolution --restore <session directory> --before|--after
[--dry-run] <config> <source> ...
This restores local data from the backups made before or after a synchronization session. The --print-sessions command can be used to find these backups. The source(s) have to be listed explicitly. There is intentionally no default, because as with --remove there is no confirmation question. With --dry-run, the restore is only simulated.
The session directory has to be specified explicitly with its path name (absolute or relative to current directory). It does not have to be one of the currently active log directories, as long as it contains the right database dumps for the selected sources.
A restore tries to minimize the number of item changes (see section Item Changes and Data Changes). This means that items that are identical before and after the change will not be transmitted anew to the peer during the next synchronization. If the peer somehow needs to get a clean copy of all local items, then use --sync refresh-from-local in the next run.
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> ... | *)
Restore depends on the specific format of the automatic backups created by SyncEvolution. Arbitrary access to item data is provided with additional options. <luid> here is the unique local identifier assigned to each item in the source, transformed so that it contains only alphanumeric characters, dash and underscore. A star * in --delete-items selects all items for deletion. There are two ways of specifying luids: either as additional parameters after the config and source parameters (which may be empty in this case, but must be given) or after the --luids keyword.
<config> and <source> may be given to define the database which is to be used. If not given or not refering to an existing configuration (which is not an error, due to historic reasons), the desired backend must be given via the backend property, like this:
syncevolution --print-items backend=evolution-contacts
syncevolution --export - backend=evolution-contacts \
--luids pas-id-4E33F24300000006 pas-id-4E36DD7B00000007
The desired backend database can be chosen via database=<identifier>. See --print-databases.
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.
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.
Warning: local is the data accessed via the sync config directly and remote is the data on the peer, regardless where the data is actually stored physically.
Modify the configuration files for the selected peer and/or sources.
If no such configuration exists, then a new one is created using one of the template configurations (see --template option). Choosing a template sets most of the relevant properties for the peer and the default set of sources (see above for a list of those). Anything specific to the user (like username/password) still has to be set manually.
When creating a new configuration and listing sources explicitly on the command line, only those sources will be set to active in the new configuration, i.e. syncevolution -c memotoo addressbook followed by syncevolution memotoo will only synchronize the address book. The other sources are created in a disabled state. When modifying an existing configuration and sources are specified, then the source properties of only those sources are modified.
By default, creating a config requires a template. Source names on the command line must match those in the template. This allows catching typos in the peer and source names. But it also prevents some advanced use cases. Therefore it is possible to disable these checks in two ways:
- use `--template none` or - specify all required sync and source properties that are normally in the templates on the command line (syncURL, backend, ...)
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!
The switch can also be used to migrate a configuration in the current configuration directory: this preserves all property values, discards obsolete properties and sets all comments exactly as if the configuration had been created from scratch. WARNING: custom comments in the configuration are not preserved.
--migrate implies --configure and can be combined with modifying properties.
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.
The default delimiter (two line breaks) matches a blank line. As a special case, it also matches a blank line with DOS line ending (line break, carriage return, line break). This works for vCard 3.0 and iCalendar 2.0, which never contain blank lines.
When exporting, the default delimiter will always insert two line breaks regardless whether the items contain DOS line ends. As a special case, the initial newline of a delimiter is skipped if the item already ends in a newline.
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.
A pseudo-random device ID is generated automatically. Therefore setting the deviceId sync property is only necessary when manually recreating a configuration or when a more descriptive name is desired.
The available templates for different known SyncML servers are listed when using a single question mark instead of template name. When using the ?<device> format, a fuzzy search for a template that might be suitable for talking to such a device is done. The matching works best when using <device> = <Manufacturer> <Model>. If you don't know the manufacturer, you can just keep it as empty. The output in this mode gives the template name followed by a short description and a rating how well the template matches the device (100% is best).
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.
The predefined properties may also be interpreted slightly differently by each backend and sync protocol. Sometimes this is documented in the comment for each property, sometimes in the documentation of the backend or sync protocol.
Properties are listed together with all recognized aliases (in those cases where a property was renamed at some point), its default value, sharing state (unshared/shared/global). Some properties must be defined, which is marked with the word required.
Identifies how to contact the peer, best explained with some examples.
HTTP(S) SyncML servers:
http://my.funambol.com/sync http://sync.scheduleworld.com/funambol/ds https://m.google.com/syncml
OBEX over Bluetooth uses the MAC address, with the channel chosen automatically:
obex-bt://00:0A:94:03:F3:7E
If the automatism fails, the channel can also be specified:
obex-bt://00:0A:94:03:F3:7E+16
For peers contacting us via Bluetooth, the MAC address is used to identify it before the sync starts. Multiple urls can be specified in one syncURL property:
obex-bt://00:0A:94:03:F3:7E obex-bt://00:01:02:03:04:05
In the future this might be used to contact the peer via one of several transports; right now, only the first one is tried.
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>}
Level of detail for desktop notifications. Currently such notifications are generated only for automatically started sync sessions.
0 - suppress all notifications 1 - show only errors 2 - show information about changes and errors (in practice currently the same as level 3) 3 - show all notifications, including starting a sync
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:
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.
Before reducing this interval, consider that it will increase resource consumption on the local and remote side. Some SyncML server operators only allow a certain number of sessions per day. The value 0 has the effect of only running automatic synchronization when changes are detected (not implemented yet, therefore it basically disables automatic synchronization).
An automatic sync will not be started unless the peer has been available for this duration, specified in seconds or 1h30m5s format.
This prevents running a sync when network connectivity is unreliable or was recently established for some other purpose. It is also a heuristic that attempts to predict how long connectivity be available in the future, because it should better be available long enough to complete the synchronization.
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:
This setting is only for debugging purpose and only has an effect during the initial sync of a client. Later it remembers the method that was supported by the server and uses that. When acting as server, clients contacting us can use both basic and md5 authentication.
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.
When acting as server, this setting controls how long a client is allowed to not send a message before the synchronization is aborted.
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.
Servers cannot resend messages, so this setting has no effect in that case.
The WebDAV backend also resends messages after a temporary network error. It uses exponential backoff to determine when the server is available again. This setting is divided by 24 to obtain the initial delay (default: 2m => 5s), which is then doubled for each retry.
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.
On a server, this option controls what kind of Server Alerted Notification is sent to the client to start a synchronization. By default, first the format from 1.2 is tried, then in case of failure, the older one from 1.1. 1.2/1.1 can be choosen explictely which disables the automatism
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.
If this property is empty and the peer synchronizes with this configuration chosen by some other means, then its ID is recorded here automatically and later used to verify that the configuration is not accidentally used by a different peer.
A string specifying the location of the certificates used to authenticate the server. When empty, the system's default location will be searched.
SSL support when acting as HTTP server is implemented by the HTTP server frontend, not with these properties.
Explicitly selects a certain safe password storage. Depending on how SyncEvolution was compiled and installed the following values are possible:
If unset, the default is to pick one automatically in the D-Bus server and not use any keyring in the command tool when running without that D-Bus server (because the keyring might not be usable without a desktop session). If support for only storage was compiled and installed, then that is the one which gets picked. Otherwise the default is to use GNOME Keyring (because distinguishing between KDE and GNOME sessions automatically is tricky).
Note that using this option applies to all passwords in a configuration and that the --keyring command line option is merely an alias for setting the global property, so setting a single password as follows sets both keyring and proxyPasswords, and also moves the other passwords into the keyring, even if they were not stored there already:
--keyring --configure proxyPassword=foo
When passwords were stored in the keyring, their value is set to a single hyphen ("-") in the configuration. This means that when running a synchronization without the --keyring argument, the password has to be entered interactively. The --print-config output always shows "-" instead of retrieving the password from the keyring.
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
refresh/one-way-from-server/client are also supported. Their use is discouraged because the direction of the data transfer depends on the role of the local side (can be server or client), which is not always obvious.
When accepting a sync session in a SyncML server (HTTP server), only sources with sync != disabled are made available to the client, which chooses the final sync mode based on its own configuration. When accepting a sync session in a SyncML client (local sync with the server contacting SyncEvolution on a device), the sync mode specified in the client is typically overriden by the server.
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').
A special 'virtual' backend combines several other data sources and presents them as one set of items to the peer. For example, Nokia phones typically exchange tasks and events as part of one set of calendar items.
Right now such a virtual backend is limited to combining one calendar source with events and one task source. They have to be specified in the database property, typically like this: calendar,todo
Different sources combined in one virtual source must have a common format. As with other backends, the preferred format can be influenced via the 'syncFormat' attribute.
Here's the full list of potentially supported backends, valid 'backend' values for each of them, and possible formats. Note that SyncEvolution installations usually support only a subset of the backends; that's why e.g. "addressbook" is unambiguous although there are multiple address book backends.
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.
Errors while starting to sync and parsing and/or storing items on either client or server can be caused by a mismatch between the sync format and uri at the peer.
Picks one of the backend's databases: depending on the backend, one can set the name and/or a unique identifier.
Most backends have a default database, like for example the system address book. Not setting this property selects that default database.
If the backend is a virtual data source, this field must contain comma seperated list of sub datasources actually used to store data. If your sub datastore has a comma in name, you must prevent taht comma from being mistaken as the separator by preceding it with a backslash, like this: database=Source1PartA\,PartB,Source2\\Backslash
To get a full list of available databases, run syncevolution --print-databases. The name is printed in front of the colon, followed by an identifier in brackets. Usually the name is unique and can be used to reference the data source. The default data source is marked with <default> at the end of the line, if there is a default.
authentication for backend data source; password can be specified in multiple ways, see SyncML server password for details
Warning: setting database user/password in cases where it is not needed, as for example with local Evolution calendars and addressbooks, can cause the Evolution backend to hang.
List the known configuration templates:
syncevolution --template ?
Create a new configuration, using the existing Memotoo template:
syncevolution --configure \
username=123456 \
"password=!@#ABcd1234" \
memotoo
Note that putting passwords into the command line, even for short-lived processes as the one above, is a security risk in shared environments, because the password is visible to everyone on the machine. To avoid this, remove the password from the command above, then add the password to the right config.ini file with a text editor. This command shows the directory containing the file:
syncevolution --print-configs
Review configuration:
syncevolution --print-config memotoo
Synchronize all sources:
syncevolution memotoo
Deactivate all sources:
syncevolution --configure \
sync=none \
memotoo
Activate address book synchronization again, using the --sync shortcut:
syncevolution --configure \
--sync two-way \
memotoo addressbook
Change the password for a configuration:
syncevolution --configure \
password=foo \
memotoo
Set up another configuration for under a different account, using the same default databases as above:
syncevolution --configure \
username=joe \
password=foo \
--template memotoo \
memotoo_joe
Set up another configuration using the same account, but different local databases (can be used to simulate synchronizing between two clients, see Exchanging Data:
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
Migrate a configuration from the <= 0.7 format to the current one and/or updates the configuration so that it looks like configurations created anew with the current syncevolution:
syncevolution --migrate memotoo
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.
These protocols are implemented in backends which look like data sources. SyncEvolution then synchronizes data between a pair of backends. Because the entire sync logic (matching of items, merging) is done locally by SyncEvolution, this mode of operation is called local sync.
Some examples of things that can be done with local sync:
Because local sync involves two sides, two configurations are needed. One is called the target config. By convention it must be called target-config@<some context name>, for example target-config@google-calendar. The target config holds properties which apply to all sources inside that context, like user name, password and URL for the server. Once configured, the target config can be used to list/import/export/update items via the SyncEvolution command line. It cannot be used for synchronization because it does not defined what the items are supposed to be synchronized with.
For synchronization, a second sync config is needed. This config has the same role as the traditional SyncML configs and is typically defined in the same implicit @default context as those configs. All configs in that context use the same local data. The sync config defines the database pairs and the sync mode (one-way, two-way, ...).
The first step is to select a target config with syncURL=local://@<some context name>. Multiple sync configs can access the same target config. In the second step, the uri of each source in the sync config must be set to the name of the corresponding source in the target config. The sync property in the sync config defines the direction of the data flow. It can be set temporarily when starting a synchronzation with the sync config.
Warning: because the client in the local sync starts the sync, preventSlowSync=0 must be set in the target config to have an effect.
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.
The credentials must be provided if the server is password protected. The syncURL is optional if the username is an email address and the server supports auto-discovery of its CalDAV and/or CardDAV services (using DNS SRV entries, .well-known URIs, properties of the current principal, ...).
Alternatively, credentials can also be set in the databaseUser and databasePassword properties of the source. The downside is that these values have to be set for each source and cannot be shared. The advantage is that, in combination with setting database, such sources can be used as part of a normal SyncML server or client sync config. SyncEvolution then reads and writes data directly from the server and exchanges it via SyncML with the peer that is defined in the sync config.
The database property of each source can be set to the URL of a specific collection (= database in WebDAV terminology). If not set, then the WebDAV backend first locates the server based on username or syncURL and then scans it for the default event resp. contact collection. This is done once in the initial synchronization. At the end of a successful synchroniation, the automatic choice is made permanent by setting the database property.
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.
To scan for collections, use:
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>
Configuration templates for Google Calendar, Yahoo Calendar and a generic CalDAV/CardDAV server are included in SyncEvolution. The Yahoo template also contains an entry for contact synchronization, but using it is not recommended due to known server-side issues.
The following commands set up synchronization with a generic WebDAV server that supports CalDAV, CardDAV and auto-discovery. For Google and Yahoo, replace webdav with google-calendar resp. yahoo and remove the addressbook source when setting up the sync config.
# 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
Here are some alternative ways of configuring the target config:
# 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
Finally, here is how the @webdav context needs to be configured so that SyncML clients or servers can be added to it:
# 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
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.
How the server stores the items depends on its implementation and configuration. To check which data is preserved, one can use this procedure (described for contacts, but works the same way for calendars and tasks):
Now one can either compare the address books in Evolution or do that automatically, described here for contacts:
Normalizing is necessary because the order of cards and their properties as well as other minor formatting aspects may be different. The output comes from a side-by-side comparison, but is augmented by the script so that the context of each change is always the complete item that was modified. Lines or items following a ">" on the right side were added, those on the left side followed by a "<" were removed, and those with a "|" between text on the left and right side were modified.
The automatic unit testing (see HACKING) contains a testItems test which verifies the copying of special entries using the same method.
Modifying one of the address books or even both at the same time and then synchronizing back and forth can be used to verify that SyncEvolution works as expected. If you do not trust SyncEvolution or the server, then it is prudent to run these checks with a copy of the original address book. Make a backup of the .evolution/addressbook directory.
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.
If an item is saved, removed locally, and reimported, then this is usually reported to a peer as "one item removed, one added" because the information available to SyncEvolution is not sufficient to determine that this is in fact the same item. One exception are iCalendar 2.0 items with their globally unique ID: the modification above will be reported to the server as "one item updated".
That is better, but still not quite correct because the content of the item has not changed, only the meta information about it which is used to detect changes. This cannot be avoided without creating additional overhead for normal synchronizations.
SyncEvolution reports item changes (the number of added, removed and updated items) as well as data changes. These data changes are calculated by comparing database dumps using the synccompare tool. Because this data comparison ignores information about which data belongs to which item, it is able to detect that re-adding an item that was removed earlier does not change the data, in contrast to the item changes. On the other hand, removing one item and adding a different one may look like updating just one item.
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:
If the sync configuration property logdir is set, then a new directory will be created for each synchronization in that directory, using the format <peer>-<yyyy>-<mm>-<dd>-<hh>-<mm>[-<seq>] with the various fields filled in with the time when the synchronization started. The sequence suffix will only be used when necessary to make the name unique. By default, SyncEvolution will never delete any data in that log directory unless explicitly asked to keep only a limited number of previous log directories.
This is done by setting the maxlogdirs limit to something different than the empty string and 0. If a limit is set, then SyncEvolution will only keep that many log directories and start removing the "less interesting" ones when it reaches the limit. Less interesting are those where no data changed and no error occurred.
To avoid writing any additional log file or database dumps during a synchronization, the logdir can be set to none. To reduce the verbosity of the log, set loglevel. If not set or 0, then the verbosity is set to 3 = DEBUG when writing to a log file and 2 = INFO when writing to the console directly. To debug issues involving data conversion, level 4 also dumps the content of items into the log.
The following environment variables control where SyncEvolution finds files and other aspects of its operations.
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.
Note that in addition to this directory, SyncEvolution also always searches for configuration files inside $HOME/.config/syncevolution-xml. Files with the same relative path and name as in /usr/share/syncevolution/xml override those files, others extend the final configuration.
See known issues and the support web page for more information.
| 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 | |