Remove no-op collections from the plan
Clear stale mappings from the status database
vdirsyncer: improve error output
Source | Issues | Patches | Chat
This is the repository for pimsync
, the rewrite and successor of vdirsyncer.
Compiling pimsync requires:
Running pimsync requires:
Use make build
to compile pimsync. The build process uses Cargo to produce a
binary and scdoc to compile documentation.
The compiled binary is placed in ./target/release/pimsync
. It can be executed
directly, or copied into your $PATH
.
Use make install
to install to /usr/local/
.
End user documentation is provided as man pages. Please see man pimsync
and
man pimsync.conf
as starting points.
Manual pages are built when running make build
. They can also be built
independently using make man
. These same man pages can be rendered as HTML
pages by using make html
.
The underlying synchronisation implementation is implemented in the vstorage
library, which is part of this repository. If you want to make a different user
interface based on pimsync, then you'll want to use this library. Pimsync itself
merely parses a configuration file and executes the algorithms implemented in
vstorage
.
The following libraries were also developed as part of this project:
libdav
: CalDav and CardDav client implementations.
Repository, documentation.davcli
: CalDav and CardDav command line tool. Repository.vparser
: Non-validating flexible parser for iCalendar and vCard data.
Repository, documentation.Documentation for the vstorage
library can be built locally with cargo doc
.
The documentation also reflects the design and further technical details on
pimsync's algorithm.
The documentation for the latest commits made to this repository are published at:
See [HACKING.md].
Special thanks to the NLnet foundation that helped receive financial support from the NGI Zero Entrust program of the European Commission since early 2023.
Copyright 2023-2024 Hugo Osvaldo Barrera
Licensed under the EUPL, Version 1.2 only
SPDX-License-Identifier: EUPL-1.2