Skip to content

Commit ce5ea6b

Browse files
committed
Update documentation (related to #1086)
1 parent 3a80247 commit ce5ea6b

9 files changed

Lines changed: 17 additions & 13 deletions

CHANGES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ CHANGES - OpenPrinting CUPS
55
Changes in CUPS v2.4.13 (YYYY-MM-DD)
66
------------------------------------
77

8+
- Updated documentation (Issue #1086)
89
- Updated IPP backend to try a sanitized user name if the printer/server does
910
not like the value (Issue #1145)
1011
- Updated the scheduler to send the "printer-added" or "printer-modified" events

doc/help/man-cups-files.conf.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
207207
<a href="man-subscriptions.conf.html?TOPIC=Man+Pages"><b>subscriptions.conf</b>(5),</a>
208208
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
209209
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
210-
Copyright &copy; 2020-2023 by OpenPrinting.
210+
Copyright &copy; 2020-2024 by OpenPrinting.
211211

212212
</body>
213213
</html>

doc/help/man-cups-lpd.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
106106
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>),
107107
RFC 2569
108108
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
109-
Copyright &copy; 2020-2023 by OpenPrinting.
109+
Copyright &copy; 2020-2024 by OpenPrinting.
110110

111111
</body>
112112
</html>

doc/help/man-cupsd.conf.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,11 +129,11 @@ <h3><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h3>
129129
is run on-demand (e.g., with <b>-l</b>).
130130
<dt><a name="JobKillDelay"></a><b>JobKillDelay </b><i>seconds</i>
131131
<dd style="margin-left: 5.0em">Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
132-
The default is "30".
132+
The default is "300".
133133
<dt><a name="JobRetryInterval"></a><b>JobRetryInterval </b><i>seconds</i>
134134
<dd style="margin-left: 5.0em">Specifies the interval between retries of jobs in seconds.
135135
This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job".
136-
The default is "30".
136+
The default is "300".
137137
<dt><a name="JobRetryLimit"></a><b>JobRetryLimit </b><i>count</i>
138138
<dd style="margin-left: 5.0em">Specifies the number of retries that are done for jobs.
139139
This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job".

doc/help/man-mime.types.html

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,11 @@ <h3><a name="RULES">Rules</a></h3>
3636
<dt><b>match("</b><i>pattern</i><b>")</b>
3737
<dd style="margin-left: 5.0em">True if the filename matches the given shell wildcard <i>pattern</i>.
3838
<dt><b>ascii(</b><i>offset</i><b>,</b><i>length</i><b>)</b>
39-
<dd style="margin-left: 5.0em">True if the <i>length</i> bytes starting at <i>offset</i> are valid printable ASCII (CR, NL, TAB, BS, 32-126). <i>length</i> cannot exceed 8192 bytes.
39+
<dd style="margin-left: 5.0em">True if the <i>length</i> bytes starting at <i>offset</i> are valid printable ASCII (CR, NL, TAB, BS, 32-126).
40+
<i>length</i> cannot exceed 8192 bytes.
4041
<dt><b>printable(</b><i>offset</i><b>,</b><i>length</i><b>)</b>
41-
<dd style="margin-left: 5.0em">True if the <i>length</i> bytes starting at <i>offset</i> are printable 8-bit chars (CR, NL, TAB, BS, 32-126, 128-254). <i>length</i> cannot exceed 8192 bytes.
42+
<dd style="margin-left: 5.0em">True if the <i>length</i> bytes starting at <i>offset</i> are printable 8-bit chars (CR, NL, TAB, BS, 32-126, 128-254).
43+
<i>length</i> cannot exceed 8192 bytes.
4244
<dt><b>priority(</b><i>number</i><b>)</b>
4345
<dd style="margin-left: 5.0em">Specifies the relative priority of this MIME media type.
4446
The default priority is 100.
@@ -56,7 +58,8 @@ <h3><a name="RULES">Rules</a></h3>
5658
<dt><b>locale("</b><i>string</i><b>")</b>
5759
<dd style="margin-left: 5.0em">True if current locale matches <i>string</i>.
5860
<dt><b>contains(</b><i>offset</i><b>,</b><i>length</i><b>,"</b><i>string</i><b>")</b>
59-
<dd style="margin-left: 5.0em">True if the bytes starting at <i>offset</i> for <i>length</i> bytes contains <i>string</i>. <i>length</i> cannot exceed 8192 bytes.
61+
<dd style="margin-left: 5.0em">True if the bytes starting at <i>offset</i> for <i>length</i> bytes contains <i>string</i>.
62+
<i>length</i> cannot exceed 8192 bytes.
6063
</dl>
6164
<h3><a name="STRING_CONSTANTS">String Constants</a></h3>
6265
String constants can be specified inside quotes ("") for strings containing whitespace and angle brackets (&lt;>) for hexadecimal strings.

man/client.conf.5

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,4 +142,4 @@ On Linux and other systems using GNU TLS, the \fI/etc/cups/ssl/site.crl\fR file,
142142
.BR default (1),
143143
CUPS Online Help (http://localhost:631/help)
144144
.SH COPYRIGHT
145-
Copyright \[co] 2020-2024 by OpenPrinting.
145+
Copyright \[co] 2020-2025 by OpenPrinting.

man/cups-files.conf.5

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,9 +212,9 @@ Specifies the directory to use for PID and local certificate files.
212212
The default is "/var/run/cups" or "/etc/cups" depending on the platform.
213213
.\"#StripUserDomain
214214
.TP 5
215-
\StripUserDomain Yes\fR
215+
\fBStripUserDomain Yes\fR
216216
.TP 5
217-
\StripUserDomain No\fR
217+
\fBStripUserDomain No\fR
218218
Specifies whether to remove domain from user name during local user authentication (e.g., "user@example.com" –> "user").
219219
This practice can be beneficial for maintaining compatibility with older versions of Kerberos.
220220
However, enabling this option can have negative consequences.

man/cupsd.conf.5

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,13 +187,13 @@ is run on-demand (e.g., with \fB-l\fR).
187187
.TP 5
188188
\fBJobKillDelay \fIseconds\fR
189189
Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job.
190-
The default is "30".
190+
The default is "300".
191191
.\"#JobRetryInterval
192192
.TP 5
193193
\fBJobRetryInterval \fIseconds\fR
194194
Specifies the interval between retries of jobs in seconds.
195195
This is typically used for fax queues but can also be used with normal print queues whose error policy is "retry-job".
196-
The default is "30".
196+
The default is "300".
197197
.\"#JobRetryLimit
198198
.TP 5
199199
\fBJobRetryLimit \fIcount\fR

man/lpstat.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Shows the ranking of print jobs.
8282
Specifies an alternate username.
8383
.TP 5
8484
\fB\-W \fIwhich-jobs\fR
85-
Specifies which jobs to show, "all, "successful", "completed" or "not-completed" (the default).
85+
Specifies which jobs to show, "all", "successful", "completed" or "not-completed" (the default).
8686
This option \fImust\fR appear before the \fI-o\fR option and/or any printer names, otherwise the default ("not-completed") value will be used in the request to the scheduler.
8787
.TP 5
8888
\fB\-a \fR[\fIprinter(s)\fR]

0 commit comments

Comments
 (0)