1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
|
MCDS
====

`mcds` is a command line tool primarily used as a search query plugin
for mutt to query a CardDav server.
Prerequisites
-------------
+ [C compiler](https://gcc.gnu.org/)
+ [Curl](https://curl.se/libcurl/)
+ [LibXML2](https://gitlab.gnome.org/GNOME/libxml2/-/wikis/home)
+ Optionally [GPGME](https://www.gnupg.org/software/gpgme/index.html)
+ Optionally [Libsecret](https://wiki.gnome.org/Projects/Libsecret)
Building / Installation
-----------------------
### Building from the repository
If building from a source release package, e.g. the tarball shipped from
<https://github.com/t-brown/mcds/releases>, skip to the next section.
`mcds` relies on the GNU build system
[autoconf](https://www.gnu.org/software/autoconf/) and
[automake](https://www.gnu.org/software/automake/).
To use the autotools, invoke:
autoreconf -vi
This will recreate the `configure` script and other auxiliary files required
for the build.
Continue with the instructions in the next section.
### Building from a source release package
To install `mcds` with the default options (this includes GPGME support):
./configure
make
make install
This will install the binary tool in `/usr/local/bin` and man pages in
`/usr/local/man`. To specify a different installation prefix, use the
--prefix option to configure:
./configure --prefix=/opt
make
make install
Will install `mcds` in `/opt/{bin,man}`.
Usage
-----
The utility `mcds` queries a CardDav server. For example to query
all email address of people called Fred in your addressbook at the
URL https://example.org/addressbook:
mcds -u https://example.org/addressbook Fred
If you had an entry for Fred Smith it would return a result like:
fred.smith@example.org Fred Smith
mcds can make use of an rc file (`${HOME}/.mcdsrc`). Please read the
accompanying man page for more examples and the specifications of the
rc file.
### Typical URLs.
The typical URL to query for various CardDav servers.
+ [Davical](https://www.davical.org/)
`https://example.org/caldav.php/username/addresses`
+ [Owncloud](https://owncloud.org/)
`https://example.org/remote.php/carddav/addressbooks/username/contacts`
+ [Nextcloud](https://nextcloud.com/)
`https://example.org/remote.php/dav/addressbooks/users/username/contacts`
+ [Gmail](https://gmail.com/)
`https://www.googleapis.com/carddav/v1/principals/username@example.com/lists/default`
where one needs to subsitute your email address for `username@example.com`.
+ [Baikal](https://sabre.io/baikal/)
`https://example.org/dav.php/addressbooks/username/default/`
|