mswatch(1)

💖 NAME 💖

okay so bestie, meet mswatch — the command that watches mailstores for changes and initiates mailbox syncs. 👀✨ This is the mswatch(1) page from the General Commands Manual, and it's genuinely doing the most in the best way.

🦋 SYNOPSIS 🦋

mswatch [options ...]

🌸 DESCRIPTION 🌸

mswatch is a command-line Linux utility that efficiently directs mail synchronization between a pair of mailboxes. 💅

It watches mailboxes for changes so it knows when to initiate mailbox syncs. With mswatch, your mail synchronization program can be invoked on demand instead of through periodic polls — which lets it deliver mail more promptly and with lower network and server overheads. periodt. 🌈

✨ OPTIONS ✨

• -c file, --config=file — read configuration from file. By default, the configuration is read from ~/.mswatchrc.
• -d, --dry — watch mailstores for changes but do not initiate syncs.
• -q, --quiet — do not print success status messages.
• -V, --version — display version information.
• -?, --help — display a summary of command-line options.

🚨 SIGNALS 🚨

• SIGUSR1 — print names of mailboxes with pending syncs.
• SIGINT and SIGTERM — gracefully exit.

🎀 CONFIGURATION 🎀

bestie, the configuration file is mandatory. mswatch will not run without it. 🫶

Text starting with a hash mark (#) through the end of the current line are comments and are ignored. Spaces and tabs delimit.

• base_delay time — default: 10 seconds. Minimum time after the first queued mailbox change to synchronization.
• inter_delay time — default: 60 seconds. Minimum time between two synchronizations or failed attempts (this is the default inter_delay setting for mailboxes).
• inter_delay time mailboxes ... — default: inter_delay. Minimum time between two synchronizations or failed attempts for the list mailboxes.
• max_delay time — default: 600 seconds. Maximum waiting time between failed attempts.
• poll_period time — default: 86400 seconds (1 day). Period at which to poll all mailboxes. This option is for use with sync programs that can error without returning a failed status — it ensures that the mailboxes are at least this fresh. To disable polling, set the period to 0.
• ignore mailboxes ... — optional. Do not initiate explicit synchronizations for these mailboxes. mswatch will ignore changes made to these mailboxes while it is running, but will still synchronize them at start when all mailboxes are synchronized.
• sync program arguments ... — required. Program and arguments to run to synchronize mail stores. Mailbox names are appended to arguments ... when program is run.
• mailbox_prefix prefix separator — optional. Prefix these strings to mailbox names passed to sync; useful when using mbsync for sync, as the mbsync channel. If present, prefix is always prefixed to mailbox names. When synchronizing a particular mailbox, separator is inserted between prefix and the mailbox name (separator is not inserted when synchronizing all mailboxes). Examples: Given prefix = "mydomain" and separator = ":" and that the mailbox "INBOX" is to be synchronized, "mydomain:INBOX" is passed to sync. Given prefix = "mydomain" and separator = ":" and that all mailboxes are to be synchronized, "mydomain" is passed to sync.
• store name { watch program arguments ... } — required (two stores). A mailstore to watch. Call it name when reporting status information to the user. watch sets the program and arguments to run the mailstore watcher. watch_maildirs(1) is a Maildir mailstore watcher.

🗂️ FILES 🗂️

• ~/.mswatchrc — default configuration file.

🔗 SEE ALSO 🔗

• inputkill(1)
• watch_maildirs(1)
• socketwatch(1)
• mbsync(1)
• mswatch website: http://mswatch.sf.net/

👑 AUTHOR 👑

Written by Chris Frost <chris@frostnet.net>. 💖

---

That's the whole mswatch(1) page, bestie — signing off from the General Commands Manual with mswatch(1). The original footer has no date, so no date-stamp here. 🎀🫶