Skip to content

Commit

Permalink
Fix cupsd.conf man page defaults (Issue #1086)
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelrsweet committed Nov 5, 2024
1 parent a3d6efe commit 4e3aaa5
Show file tree
Hide file tree
Showing 49 changed files with 334 additions and 334 deletions.
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Changes in CUPS v2.5b1 (TBA)
- Added support for specifying permissions with the `cupsFileOpen` API.
- Added new `cupsGetClock` API.
- Added new `cupsParseOptions2` API with "end" argument.
- Updated documentation (Issue #984)
- Updated documentation (Issue #984, Issue #1086)
- Updated the configure script to default to installing to /usr/local.
- Updated CUPS to require TLS support - OpenSSL, GNUTLS and LibreSSL are
supported.
Expand Down
18 changes: 9 additions & 9 deletions doc/help/man-backend.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<meta name="creator" content="mantohtml v2.0.1">
<meta name="creator" content="mantohtml v2.0.2">
<title>backend(7)</title>
</head>
<body>
Expand Down Expand Up @@ -47,7 +47,7 @@ <h2 id="backend-7.synopsis">Synopsis</h2>
</pre>
<h2 id="backend-7.description">Description</h2>
<p>Backends are a special type of
<strong>filter</strong>(7)
<a href="filter.html"><strong>filter</strong>(7)</a>

which is used to send print data to and discover different devices on the system.
</p>
Expand Down Expand Up @@ -179,10 +179,10 @@ <h2 id="backend-7.exit-status">Exit Status</h2>
</p>
<h2 id="backend-7.environment">Environment</h2>
<p>In addition to the environment variables listed in
<strong>cups</strong>(1)
<a href="cups.html"><strong>cups</strong>(1)</a>

and
<strong>filter</strong>(7),
<a href="filter.html"><strong>filter</strong>(7),</a>

CUPS backends can expect the following environment variable:
</p>
Expand All @@ -203,24 +203,24 @@ <h2 id="backend-7.notes">Notes</h2>
</p>
<p>Unless you are a developer and know what you are doing, please do not run backends directly.
Instead, use the
<strong>lp</strong>(1)
<a href="lp.html"><strong>lp</strong>(1)</a>

or
<strong>lpr</strong>(1)
<a href="lpr.html"><strong>lpr</strong>(1)</a>

programs to send print jobs or
<strong>lpinfo</strong>(8)
<a href="lpinfo.html"><strong>lpinfo</strong>(8)</a>

to query for available printers using the backend.
The one exception is the SNMP backend - see
<strong>cups-snmp</strong>(8)
<a href="cups-snmp.html"><strong>cups-snmp</strong>(8)</a>

for more information.
</p>
<h2 id="backend-7.notes">Notes</h2>
<p>CUPS printer drivers and backends are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
<strong>ippeveprinter</strong>(1).
<a href="ippeveprinter.html"><strong>ippeveprinter</strong>(1).</a>

</p>
<h2 id="backend-7.see-also">See Also</h2>
Expand Down
12 changes: 6 additions & 6 deletions doc/help/man-cancel.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<meta name="creator" content="mantohtml v2.0.1">
<meta name="creator" content="mantohtml v2.0.2">
<title>cancel(1)</title>
</head>
<body>
Expand Down Expand Up @@ -89,18 +89,18 @@ <h2 id="cancel-1.notes">Notes</h2>

options require administrative access.
These restrictions are part of the operation policies defined in the
<strong>cupsd.conf</strong>(5)
<a href="cupsd.conf.html"><strong>cupsd.conf</strong>(5)</a>

file for the &quot;Cancel-Jobs&quot; and &quot;Cancel-My-Jobs&quot; operations, respectively.
</p>
<h2 id="cancel-1.see-also">See Also</h2>
<p><strong>cupsd.conf</strong>(5),
<a href="cupsd.conf.html"><p><strong>cupsd.conf</strong>(5),</a>

<strong>lp</strong>(1),
<a href="lp.html"><strong>lp</strong>(1),</a>

<strong>lpmove</strong>(8),
<a href="lpmove.html"><strong>lpmove</strong>(8),</a>

<strong>lpstat</strong>(1),
<a href="lpstat.html"><strong>lpstat</strong>(1),</a>

CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
</p>
Expand Down
16 changes: 8 additions & 8 deletions doc/help/man-classes.conf.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<meta name="creator" content="mantohtml v2.0.1">
<meta name="creator" content="mantohtml v2.0.2">
<title>classes.conf(5)</title>
</head>
<body>
Expand All @@ -12,7 +12,7 @@ <h2 id="classes.conf-5.name">Name</h2>
<h2 id="classes.conf-5.description">Description</h2>
<p>The <strong>classes.conf</strong> file defines the local printer classes that are available.
It is normally located in the <em>/etc/cups</em> directory and is maintained by the
<strong>cupsd</strong>(8)
<a href="cupsd.html"><strong>cupsd</strong>(8)</a>

program.
This file is not intended to be edited or managed manually.
Expand All @@ -21,17 +21,17 @@ <h2 id="classes.conf-5.notes">Notes</h2>
<p>The name, location, and format of this file are an implementation detail that will change in future releases of CUPS.
</p>
<h2 id="classes.conf-5.see-also">See Also</h2>
<p><strong>cupsd</strong>(8),
<a href="cupsd.html"><p><strong>cupsd</strong>(8),</a>

<strong>cupsd.conf</strong>(5),
<a href="cupsd.conf.html"><strong>cupsd.conf</strong>(5),</a>

<strong>mime.convs</strong>(5),
<a href="mime.convs.html"><strong>mime.convs</strong>(5),</a>

<strong>mime.types</strong>(5),
<a href="mime.types.html"><strong>mime.types</strong>(5),</a>

<strong>printers.conf</strong>(5),
<a href="printers.conf.html"><strong>printers.conf</strong>(5),</a>

<strong>subscriptions.conf</strong>(5),
<a href="subscriptions.conf.html"><strong>subscriptions.conf</strong>(5),</a>

CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
</p>
Expand Down
4 changes: 2 additions & 2 deletions doc/help/man-client.conf.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<meta name="creator" content="mantohtml v2.0.1">
<meta name="creator" content="mantohtml v2.0.2">
<title>client.conf(5)</title>
</head>
<body>
Expand Down Expand Up @@ -128,7 +128,7 @@ <h2 id="client.conf-5.notes">Notes</h2>
<p>On Linux and other systems using GNU TLS, the <em>/etc/cups/ssl/site.crl</em> file, if present, provides a list of revoked X.509 certificates and is used when validating certificates.
</p>
<h2 id="client.conf-5.see-also">See Also</h2>
<p><strong>cups</strong>(1),
<a href="cups.html"><p><strong>cups</strong>(1),</a>

<strong>default</strong>(1),

Expand Down
4 changes: 2 additions & 2 deletions doc/help/man-cups-config.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<meta name="creator" content="mantohtml v2.0.1">
<meta name="creator" content="mantohtml v2.0.2">
<title>cups-config(1)</title>
</head>
<body>
Expand Down Expand Up @@ -112,7 +112,7 @@ <h2 id="cups-config-1.deprecated-options">Deprecated Options</h2>
Formerly used to add the CUPS imaging library to the list of libraries.
</p>
<h2 id="cups-config-1.see-also">See Also</h2>
<p><strong>cups</strong>(1),
<a href="cups.html"><p><strong>cups</strong>(1),</a>

<strong>pkg-config</strong>(1),

Expand Down
22 changes: 11 additions & 11 deletions doc/help/man-cups-files.conf.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<meta name="creator" content="mantohtml v2.0.1">
<meta name="creator" content="mantohtml v2.0.2">
<title>cups-files.conf(5)</title>
</head>
<body>
Expand All @@ -11,7 +11,7 @@ <h2 id="cups-files.conf-5.name">Name</h2>
</p>
<h2 id="cups-files.conf-5.description">Description</h2>
<p>The <strong>cups-files.conf</strong> file configures the files and directories used by the CUPS scheduler,
<strong>cupsd</strong>(8).
<a href="cupsd.html"><strong>cupsd</strong>(8).</a>

It is normally located in the <em>/etc/cups</em> directory.
</p>
Expand All @@ -22,7 +22,7 @@ <h2 id="cups-files.conf-5.description">Description</h2>
</p>
<h3 id="cups-files.conf-5.description.directives">Directives</h3>
<p>The following directives are understood by
<strong>cupsd</strong>(8):
<a href="cupsd.html"><strong>cupsd</strong>(8):</a>

</p>
<p style="margin-left: 2.5em; text-indent: -2.5em;"><strong>AccessLog</strong><br>
Expand Down Expand Up @@ -260,21 +260,21 @@ <h2 id="cups-files.conf-5.notes">Notes</h2>
command is used instead.
</p>
<h2 id="cups-files.conf-5.see-also">See Also</h2>
<p><strong>classes.conf</strong>(5),
<a href="classes.conf.html"><p><strong>classes.conf</strong>(5),</a>

<strong>cups</strong>(1),
<a href="cups.html"><strong>cups</strong>(1),</a>

<strong>cupsd</strong>(8),
<a href="cupsd.html"><strong>cupsd</strong>(8),</a>

<strong>cupsd.conf</strong>(5),
<a href="cupsd.conf.html"><strong>cupsd.conf</strong>(5),</a>

<strong>mime.convs</strong>(5),
<a href="mime.convs.html"><strong>mime.convs</strong>(5),</a>

<strong>mime.types</strong>(5),
<a href="mime.types.html"><strong>mime.types</strong>(5),</a>

<strong>printers.conf</strong>(5),
<a href="printers.conf.html"><strong>printers.conf</strong>(5),</a>

<strong>subscriptions.conf</strong>(5),
<a href="subscriptions.conf.html"><strong>subscriptions.conf</strong>(5),</a>

CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
</p>
Expand Down
6 changes: 3 additions & 3 deletions doc/help/man-cups-lpd.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<meta name="creator" content="mantohtml v2.0.1">
<meta name="creator" content="mantohtml v2.0.2">
<title>cups-lpd(8)</title>
</head>
<body>
Expand Down Expand Up @@ -120,9 +120,9 @@ <h2 id="cups-lpd-8.example">Example</h2>
service using the corresponding control program.
</p>
<h2 id="cups-lpd-8.see-also">See Also</h2>
<p><strong>cups</strong>(1),
<a href="cups.html"><p><strong>cups</strong>(1),</a>

<strong>cupsd</strong>(8),
<a href="cupsd.html"><strong>cupsd</strong>(8),</a>

<strong>inetd</strong>(8),

Expand Down
8 changes: 4 additions & 4 deletions doc/help/man-cups-snmp.conf.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<meta name="creator" content="mantohtml v2.0.1">
<meta name="creator" content="mantohtml v2.0.2">
<title>snmp.conf(5)</title>
</head>
<body>
Expand All @@ -16,7 +16,7 @@ <h2 id="snmp.conf-5.description">Description</h2>
Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
</p>
<p>The Community and DebugLevel directives are used by all backends. The remainder apply only to the SNMP backend -
<strong>cups-snmp</strong>(8).
<a href="cups-snmp.html"><strong>cups-snmp</strong>(8).</a>

</p>
<h2 id="snmp.conf-5.directives">Directives</h2>
Expand Down Expand Up @@ -60,11 +60,11 @@ <h2 id="snmp.conf-5.directives">Directives</h2>
<h2 id="snmp.conf-5.notes">Notes</h2>
<p>CUPS backends are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
<strong>ippeveprinter</strong>(1).
<a href="ippeveprinter.html"><strong>ippeveprinter</strong>(1).</a>

</p>
<h2 id="snmp.conf-5.see-also">See Also</h2>
<p><strong>cups-snmp</strong>(8),
<a href="cups-snmp.html"><p><strong>cups-snmp</strong>(8),</a>

CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
</p>
Expand Down
12 changes: 6 additions & 6 deletions doc/help/man-cups-snmp.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<meta name="creator" content="mantohtml v2.0.1">
<meta name="creator" content="mantohtml v2.0.2">
<title>cups-snmp(8)</title>
</head>
<body>
Expand Down Expand Up @@ -30,7 +30,7 @@ <h2 id="cups-snmp-8.description">Description</h2>
This can be used for programs that need to configure print queues where the user has supplied an address but nothing else.
</p>
<p>In the second form, the SNMP backend is run indirectly using the
<strong>lpinfo</strong>(8)
<a href="lpinfo.html"><strong>lpinfo</strong>(8)</a>

command.
The output provides all printers detected via SNMP on the configured
Expand All @@ -54,13 +54,13 @@ <h2 id="cups-snmp-8.conforming-to">Conforming To</h2>
<p>The CUPS SNMP backend uses the information from the Host, Printer, and Port Monitor MIBs along with some vendor private MIBs and intelligent port probes to determine the correct device URI and make and model for each printer.
</p>
<h2 id="cups-snmp-8.see-also">See Also</h2>
<p><strong>backend</strong>(7),
<a href="backend.html"><p><strong>backend</strong>(7),</a>

<strong>cups-snmp.conf</strong>(5),
<a href="cups-snmp.conf.html"><strong>cups-snmp.conf</strong>(5),</a>

<strong>cupsd</strong>(8),
<a href="cupsd.html"><strong>cupsd</strong>(8),</a>

<strong>lpinfo</strong>(8),
<a href="lpinfo.html"><strong>lpinfo</strong>(8),</a>

CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
</p>
Expand Down
32 changes: 16 additions & 16 deletions doc/help/man-cups.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<meta name="creator" content="mantohtml v2.0.1">
<meta name="creator" content="mantohtml v2.0.2">
<title>cups(1)</title>
</head>
<body>
Expand Down Expand Up @@ -44,10 +44,10 @@ <h3 id="cups-1.description.where-do-i-begin">Where Do I Begin?</h3>
<p>Once you have added the printer, you can print to it from any application. You can also choose Print Test Page from the maintenance menu to print a simple test page and verify that everything is working properly.
</p>
<p>You can also use the
<strong>lpadmin</strong>(8)
<a href="lpadmin.html"><strong>lpadmin</strong>(8)</a>

and
<strong>lpinfo</strong>(8)
<a href="lpinfo.html"><strong>lpinfo</strong>(8)</a>

commands to add printers to
<strong>CUPS</strong>.
Expand Down Expand Up @@ -129,33 +129,33 @@ <h2 id="cups-1.conforming-to">Conforming To</h2>
<h2 id="cups-1.notes">Notes</h2>
<p>CUPS printer drivers, backends, and PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
<strong>ippeveprinter</strong>(1).
<a href="ippeveprinter.html"><strong>ippeveprinter</strong>(1).</a>

</p>
<h2 id="cups-1.see-also">See Also</h2>
<p><strong>cancel</strong>(1),
<a href="cancel.html"><p><strong>cancel</strong>(1),</a>

<strong>client.conf</strong>(5),
<a href="client.conf.html"><strong>client.conf</strong>(5),</a>

<strong>cupsctl</strong>(8),
<a href="cupsctl.html"><strong>cupsctl</strong>(8),</a>

<strong>cupsd</strong>(8),
<a href="cupsd.html"><strong>cupsd</strong>(8),</a>

<strong>lp</strong>(1),
<a href="lp.html"><strong>lp</strong>(1),</a>

<strong>lpadmin</strong>(8),
<a href="lpadmin.html"><strong>lpadmin</strong>(8),</a>

<strong>lpinfo</strong>(8),
<a href="lpinfo.html"><strong>lpinfo</strong>(8),</a>

<strong>lpoptions</strong>(1),
<a href="lpoptions.html"><strong>lpoptions</strong>(1),</a>

<strong>lpr</strong>(1),
<a href="lpr.html"><strong>lpr</strong>(1),</a>

<strong>lprm</strong>(1),
<a href="lprm.html"><strong>lprm</strong>(1),</a>

<strong>lpq</strong>(1),
<a href="lpq.html"><strong>lpq</strong>(1),</a>

<strong>lpstat</strong>(1),
<a href="lpstat.html"><strong>lpstat</strong>(1),</a>

CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>),
OpenPrinting CUPS Web Site (<a href="https://openprinting.github.io/cups">https://openprinting.github.io/cups</a>),
Expand Down
Loading

0 comments on commit 4e3aaa5

Please sign in to comment.