MCDS(1)

💖 MCDS(1) — the mutt CardDAV query bestie 💖

okay so this is a page from the General Commands Manual, and it's all about a lil utility called mcds. Grab a snack, we're doing this. 🍓

---

✨ NAME ✨

mcds — mutt CardDAV query 🦋

---

🌸 SYNOPSIS 🌸

mcds [-c config_file] [-hVvp] [-q a | e | n | t] [-S] [-s a | e | n | t]
     [-u URL] term

---

💅 DESCRIPTION 💅

The mcds utility queries a CardDAV server for whatever info you're asking for. Its main character job is being the address query command for mutt(1). That's the whole vibe. 👑

The options are as follows:

• -c config_file — tells it to use a different config file. The default one is ~/.mcdsrc. (Like, the og one. ✨)
• -h — prints help text to standard output and then exits. bye bestie 🫶
• -p — prompts you for a password. yes, like that.
• -q a | e | n | t — the term you're querying against. The known terms are:
  • a — query for the address field.
  • e — query for the email field. This is the default. ⭐
  • n — query for the full-name field.
  • t — query for the telephone field.
• -S — saves the password. 💾
• -s a | e | n | t — the search term you want returned. The known terms are:
  • a — query for the address field.
  • e — query for the email field. This is the default. ⭐
  • n — query for the full-name field.
  • t — query for the telephone field.
• -u URL — the URL of the CardDAV server. 🔗
• -V — prints the version number and license info of mcds to standard output, then exits. 💜
• -v — turns on verbose mode. This forces mcds to print debugging messages about its progress. so chatty, love that for it 🗣️

---

🎀 FILES 🎀

• ~/.mcdsrc — the configuration file. It's used to set default values for mcds, but command-line arguments can override it. It's formatted as a list of “key = value” pairs separated by newlines.

The keys are as follows:

• url = URL — the URL of the CardDAV server. 🔗
• verify = [yes | no] — verify the server certificate if you're connecting over HTTPS. Disabled by default. ⚠️
• netrc = [yes | no] — enables reading the ~/.netrc file. Disabled by default. ⚠️
• username = USERNAME — the username to log in to the CardDAV server with. Heads up: if a username is specified, mcds will not use the ~/.netrc file. 🚫
• password_file = password.gpg — the GPG encrypted file containing the password for the CardDAV server. 🔐
• libsecret = [yes | no] — use the library “libsecret” to store and retrieve the password. 🗝️

• ~/.netrc — used to grab your username and password when authenticating with the CardDAV server, if you haven't specified your username and password file in ~/.mcdsrc. 🧚

---

🌈 EXIT STATUS 🌈

The mcds utility exits 0 on success, and >0 if an error occurs. simple as that, no cap 💀

---

👑 EXAMPLES 👑

Query a CardDAV server for email addresses corresponding to “Ben”:

$ mcds -u https://localhost/caldav.php/username/addressbook/ Ben
ben@example.net        Ben Smith
...

To use mcds with mutt, add the following to your muttrc(5):

set query_command="mcds -u https://localhost/caldav.php/username/addressbook/ '%s'"

This query can be simplified by putting the relevant values in ~/.mcdsrc:

url = https://localhost/caldav.php/username/addressbook/
verify = no
netrc = yes

Now the query command can be shortened to:

set query_command="mcds '%s'"

When compiled against libsecret and after enabling libsecret in the configuration file, mcds can save passwords provided at the password prompt. To set, replace or clear the password, run

mcds -pS

---

🦋 SEE ALSO 🦋

curl(1), gpg2(1), mutt(1), muttrc(5), netrc(5)

---

💜 AUTHORS 💜

The mcds utility is maintained by Timothy Brown <tbrown@freeshell.org> 🫶

---

and that's the whole page, bestie!! this one shipped from <strong>Debian</strong> on <strong>November 5, 2024</strong> — ty for reading, mwah 💋✨