darcs-monitor(1)

💖 darcs-monitor — the manual, but make it make sense 💖

okay bestie, gather round, because darcs-monitor is a Darcs add-on and its whole entire job is: it sends mail about newly pushed changes. that's it. that's the gig. she's a notifier and she ate. 💅

this page lives in the General Commands Manual, section 1. noted. moving on.

---

✨ SYNOPSIS ✨

darcs-monitor [ option ...  ] email recipient [ email recipient ...  ] [ repository ...  ]

darcs-monitor -h | --help

darcs-monitor --version

like. look at her. three modes. she contains multitudes. 🌈

---

🌸 DESCRIPTION 🌸

so here's the vibe: darcs-monitor reads one or more darcs(1) repositories and sends email about every change it has not previously sent an email about to the same address. she keeps receipts, she doesn't spam you twice, she's considerate. queen behavior fr fr.

🎀 the "run me on every push" setup

want her to run every single time somebody pushes to a repository? add these lines to _darcs/prefs/defaults:

apply posthook darcs-monitor --charset=charset email recipient [ email recipient ...  ]
apply run-posthook

okay so in that little snippet:

• charset — should be the MIME charset that the patches (including their metadata, yes, all of it) are in.
• recipient — should be the email address where the emails should be sent.

and you can specify more than one recipient by just... repeating the email parameter. iconic. 🫶

🦋 other ways to run her

you can also run darcs-monitor from crontab(1) or straight from the command line, bestie. in those cases it is easiest to specify the path to the repository on the command line after the other arguments. and honestly? you can specify more than one. go off. 💅

📧 how the mail actually goes out

by default, mail is sent by calling /usr/sbin/sendmail. if you've got another sendmail(1) binary you'd rather use, you can specify it with a command-line switch. no judgment, we all have our faves. ✨

🧚 customising the email (the template era)

you can customise the email by providing a template. drop your own template at _darcs/third-party/darcs-monitor/email-template — (you can use other files, but then you have to specify where it is, so like... your call). in the template you can use these substitutions:

• %RECIPIENT% — the email address to which email is sent
• %DIFF% — the Darcs-provided diff -u of the patch
• %CHANGES% — a Darcs-provided summary of changes
• %REPO% — the path to the repository
• %SHORTREPO% — the final component of the path to the repository
• %AUTHOR% — the patch author
• %DATE% — the patch date
• %HASH% — the patch Darcs hash
• %TITLE% — the patch name
• %COMMENT% — the patch comment

and also!! in the template, two percent signs in sequence (%%) start a comment that extends to the end of the current line. so you can annotate your own template like a lil diary. no cap. 📝

---

✨ OPTIONS ✨

every single one, bestie. we do not skip. skipping is not the vibe.

• -n, --dry-run — do not actually do anything... but do mark it done. yeah. she pretends. she commits to the bit. 😭
• --darcs-path=FILE — provide the location of the darcs(1) executable.
• --darcs-args=ARGS — provide additional arguments to darcs(1), separating arguments with commas.
• --use-sendmail[=FILE] — use sendmail(1) (either at /usr/sbin/sendmail or at FILE).
• -d, --max-diff=SIZE — only include the first SIZE bytes of the diff in the e-mail. truncation but make it fashion. ✂️
• --charset=CHARSET — specify the MIME name of the repository's character set.
• -h, --help — show usage.
• --version — show version.

---

💀 EXIT STATUS 💀

success is indicated by 0, failure by any other exit status. that's the whole thing. binary. she doesn't do maybes. periodt.

---

🍓 FILES 🍓

• /usr/share/darcs-monitor/default-template — the default email template. see above for the format. 👆

---

👑 AUTHOR 👑

darcs-monitor was written by Antti-Juhani Kaijanaho. thank you king. 🫡

---

🌈 SEE ALSO 🌈

• darcs(1)

---

and that's the whole page, bestie!! this came out of the General Commands Manual as darcs-monitor(1) — no version number or date stamped on the footer, just her name and the section, which is honestly very mysterious main character energy of her. go send some mail. mwah. 💖✨🎀