WARNQUOTA.CONF(5)

🎀 NAME 🎀

okay bestie, so warnquota.conf is literally the configuration file for warnquota — that's it, that's the whole job description 💅

✨ SYNOPSIS ✨

/etc/warnquota.conf

that's the path, she lives at /etc, no notes 💖

🌸 DESCRIPTION 🌸

so warnquota.conf stores the configuration for the warnquota(8) tool, which is the little icon that goes and tells a user or a group "hey girl, you're over your disk quota limits" 😭 it's a notifier, it's giving customer service.

The syntax is so simple — it's an option name, then an equal sign, then the option value. And yes, white space characters hanging around the option names and values are totally allowed, she's not picky 🫶

Empty lines? Ignored. Lines starting with a hash sign or a semicolon? Also ignored. They're background characters, we don't see them ✨

An option value can be quoted, but honestly it doesn't have to be. It's flexible like that. And the value can span across multiple lines — the only catch is that each previous line has to end with a backslash \, no exceptions bestie.

Some option values can contain formatting sequences, which get expanded to their respective values. Here's the whole lineup, and yes, you need all of them:

• %d — domain name
• %h — host name
• %i, %s — user or group name
• %% — literal % character
• | — new-line character

👑 OPTIONS 👑

• CC_BEFORE — sends to the copy-carbon address only when a user has less than the specified grace time left. The value is a number followed by a time unit. Known units are seconds, minutes, hours, and days. Example: 5 days
• CC_TO — an e-mail address to put into the copy-carbon (CC:) recipient header. Default value is root.
• CHARSET — defines the character set for sent e-mails. Default value will be the current locale character set used when executing the warnquota command, if the locale is not either C or POSIX. Otherwise no character set will be specified in the e-mails. periodt.
• FROM — defines the From: e-email address. Default value is support@localhost.
• GROUP_MESSAGE — a text sent as an e-mail body if a group exceeds its limits. This option recognizes formatting sequences.
• GROUP_SIGNATURE — a signature text appended to the notification for a group. Default value is a general explanation utilizing SUPPORT and PHONE values. This option recognizes formatting sequences.
• LDAP_BASEDN — base distinguished name for LDAP queries.
• LDAP_BINDDN — bind distinguished name for LDAP queries.
• LDAP_BINDPW — bind password for LDAP queries.
• LDAP_DEFAULT_MAIL_DOMAIN — default e-mail address domain of the searched user if the given LDAP attribute does not specify any.
• LDAP_HOST — LDAP server name to connect to if LDAP_URI is not defined.
• LDAP_MAIL — a boolean controlling if LDAP has to be used to look up the user's e-mail address. Possible values are true and false. Default value is false.
• LDAP_MAIL_ATTRIBUTE — the LDAP attribute which holds the user's e-mail address.
• LDAP_PORT — LDAP server port number to connect to if LDAP_URI is not defined.
• LDAP_SEARCH_ATTRIBUTE — the LDAP attribute which holds the user's ID to look up.
• LDAP_URI — the URL of the LDAP server to use to search the user's e-mail addresses. This option takes preference over LDAP_HOST and LDAP_PORT. Example: ldaps://example.com:389/
• MESSAGE — a beginning of text sent as an e-mail body if a user exceeds his limits. This option recognizes formatting sequences.
• MAIL_CMD — the command to execute to send an e-mail. The e-mail text including all headers is passed to the standard input of the command. Default value is /usr/lib/sendmail -t.
• MAILDEV — the device with disk quotas to exclude from sending notifications if there are exceeded limits. This option should identify the device where mail boxes are stored, to prevent bouncing the warnquota notification by local MDA due to no space for storing new e-mails. Special value any denotes all devices. 👀
• PHONE — the telephone contact to the user support. Default value is (xxx) xxx-xxxx or (yyy) yyy-yyyy.
• SIGNATURE — the end of the e-mail body if a user exceeds its limits. Default value is a general explanation utilizing SUPPORT and PHONE values. This option recognizes formatting sequences.
• SUBJECT — the text to put into the Subject: header. Default value is Disk Quota usage on system.
• SUPPORT — the contact to the user support. Default value is support@localhost.

🌈 EXAMPLE 🌈

here's the vibe, copy-paste away:

# comment
FROM = root@example.com
SUPPORT = support@example.com
PHONE = 1234

🦋 FILES 🦋

• /etc/warnquota.conf — configuration for warnquota(8)

💜 SEE ALSO 💜

• warnquota(8).

no cap, every single one of these options is doing the absolute most and you should read them all before you touch the config 🙈

and that's the whole page bestie, we ate 💅 this one lives in the File Formats Manual section under WARNQUOTA.CONF(5) — signed, sealed, delivered 🎀✨💖