Debian Codegraph @

upstream/debian-unstable/man5/warnquota.conf.5

raw
1 .TH WARNQUOTA.CONF 5
2 .SH NAME
3 warnquota.conf \- configuration for warnquota
4 .SH SYNOPSIS
5 .B /etc/warnquota.conf
6 .SH DESCRIPTION
7 The
8 .B warnquota.conf
9 file stores a configuration for
10 .BR warnquota (8)
11 tool which is used to notify a user or a group who exceeds its disk quota
12 limits.
13 .P
14 The syntax is an option name followed by an equal sign and the option value.
15 White space characters surrounding the option names and values are allowed.
16 .P
17 Empty lines or lines starting with a hash sign or a semicolon are ignored.
18 .P
19 An option value can but does not have to be quoted. The value can span
20 across multiple lines provided each previous line ends with a backslash.
21 .P
22 Some option values can contain formatting sequences which will be expanded to
23 their respective values. Following sequences are recognized:
24 .P
25 .PD 0
26 .TP 20
27 .B %d
28 domain name
29 .TP
30 .B %h
31 host name
32 .TP
33 .BR "%i" ", " "%s"
34 user or group name
35 .TP
36 .B %%
37 literal % character
38 .TP
39 .B |
40 new-line character
41 .PD
42 .SH OPTIONS
43 .PD 0
44 .TP 20
45 .B CC_BEFORE
46 Send to copy-carbon address only when a user has less than specified grace time
47 left. Value is a number followed by a time unit. Known units are
48 .IR seconds ,
49 .IR minutes ,
50 .IR hours ", and"
51 .IR days .
52 Example:
53 .I 5 days
54 .TP
55 .B CC_TO
56 An e-mail address to put into copy-carbon (CC:) recipient header. Default
57 value is
58 .IR root .
59 .TP
60 .B CHARSET
61 Defines character set for sent e-mails. Default value will be current locale
62 character set used when executing warnquota command, if locale is not either
63 .I C
64 or
65 .IR POSIX .
66 Otherwise no character set will be specified in the e-mails.
67 .TP
68 .B FROM
69 Defines From: e-email address. Default value is
70 .IR "support@localhost" .
71 .TP
72 .B GROUP_MESSAGE
73 A text sent as an e-mail body if a group exceeds its limits. This option
74 recognizes formatting sequences.
75 .TP
76 .B GROUP_SIGNATURE
77 A signature text appended to notification for a group. Default value is
78 a general explanation utilizing
79 .B SUPPORT
80 and
81 .B PHONE
82 values. This option recognizes formatting sequences.
83 .TP
84 .B LDAP_BASEDN
85 Base distinguished name for LDAP queries.
86 .TP
87 .B LDAP_BINDDN
88 Bind distinguished name for LDAP queries.
89 .TP
90 .B LDAP_BINDPW
91 Bind password for LDAP queries.
92 .TP
93 .B LDAP_DEFAULT_MAIL_DOMAIN
94 Default e-mail address domain of searched user if given LDAP attribute does
95 not specify any.
96 .TP
97 .B LDAP_HOST
98 LDAP server name to connect to if
99 .B LDAP_URI
100 is not defined.
101 .TP
102 .B LDAP_MAIL
103 A boolean controlling if LDAP has to be used to look up user's e-mail
104 address. Possible values are
105 .I true
106 and
107 .IR false .
108 Default value is
109 .IR false .
110 .TP
111 .B LDAP_MAIL_ATTRIBUTE
112 The LDAP attribute which holds user's e-mail address.
113 .TP
114 .B LDAP_PORT
115 LDAP server port number to connect to if
116 .B LDAP_URI
117 is not defined.
118 .TP
119 .B LDAP_SEARCH_ATTRIBUTE
120 The LDAP attribute which holds user's ID to look up.
121 .TP
122 .B LDAP_URI
123 The URL of LDAP server to use to search user's e-mail addresses. This option
124 takes preference over
125 .B LDAP_HOST
126 and
127 .BR LDAP_PORT .
128 Example:
129 .I ldaps://example.com:389/
130 .TP
131 .B MESSAGE
132 A beginning of text sent as an e-mail body if a user exceeds his limits. This
133 option recognizes formatting sequences.
134 .TP
135 .B MAIL_CMD
136 The command to execute to send an e-mail. The e-mail text including all
137 headers is passed to the standard input of the command. Default value is
138 .IR "/usr/lib/sendmail -t" .
139 .TP
140 .B MAILDEV
141 The device with disk quotas to exclude from sending notifications if there are
142 exceeded limits. This option should identify the device where mail boxes are
143 stored to prevent from bouncing the warnquota notification by local MDA due to
144 no space for storing new e-mails. Special value
145 .I any
146 denotes all devices.
147 .TP
148 .B PHONE
149 The telephone contact to the user support. Default value is
150 .IR "(xxx) xxx-xxxx or (yyy) yyy-yyyy" .
151 .TP
152 .B SIGNATURE
153 The end of e-mail body if a user exceeds its limits. Default value is
154 a general explanation utilizing
155 .B SUPPORT
156 and
157 .B PHONE
158 values. This option recognizes formatting sequences.
159 .TP
160 .B SUBJECT
161 The text to put into Subject: header. Default value is
162 .IR "Disk Quota usage on system" .
163 .TP
164 .B SUPPORT
165 The contact to the user support. Default value is
166 .IR "support@localhost" .
167 .SH EXAMPLE
168 .PP
169 # comment
170 .RS 0
171 FROM = [email protected]
172 .RS 0
173 SUPPORT = [email protected]
174 .RS 0
175 PHONE = 1234
176 .SH FILES
177 .PD 0
178 .TP 20
179 .B /etc/warnquota.conf
180 configuration for
181 .BR warnquota (8)
182 .PD
183 .SH SEE ALSO
184 .BR warnquota (8).