.. Copyright 2025 Hugo Osvaldo Barrera
..
.. SPDX-License-Identifier: ISC

pimsync docs index
==================

.. toctree::
   :maxdepth: 2
   :hidden:

   self

**pimsync** is a command line tool to synchronise calendars and contacts
between different storages, including CalDAV and CardDAV. Pimsync is a
successor and reimplementation of vdirsyncer, and is free and open source
software.

.. toctree::
   :maxdepth: 2
   :caption: General documentation

   intro
   man
   changelog
   history
   search

Installation
------------

The `project README`_ contains documentation on compiling and installing from
source.

.. _project README: https://git.sr.ht/~whynothugo/pimsync#pimsync

Distributions packages are available on:

- Alpine Linux Edge, in the testing repositories.
- ArchLinux, via the Arch User Repositories.
- Nix, via nixpkgs unstable.

Other Resources
---------------

- `Source code repository <https://git.sr.ht/~whynothugo/pimsync>`_
- `Issue tracker <https://todo.sr.ht/~whynothugo/pimsync>`_
- `List for disussion and patches <https://git.sr.ht/~whynothugo/pimsync>`_
- pimsync is part of the `pimutils collection <https://pimutils.org>`_

Thanks
------

Development of this project is possible thanks to funding and support from the
`NLnet foundation <https://nlnet.nl/project/vdirsyncer/>`_ and the `NGI Zero
Entrust program <https://www.ngi.eu/ngi-projects/ngi-zero-entrust/>`_ of the
European Commission.

A security audit was completed by `Radically Open Security
<https://www.radicallyopensecurity.com/>`_ in September 2024.