backend(7)

From: Michael R Sweet Date: Tue, 2 Apr 2024 23:50:26 +0000 (-0400) Subject: Update default destination documentation (Issue #819) X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3371c87e8980ed512afc15002dde00b7fb8f0d7d;p=thirdparty%2Fcups.git Update default destination documentation (Issue #819) --- diff --git a/CHANGES.md b/CHANGES.md index c273e3d888..1441b2e091 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -24,6 +24,7 @@ Changes in CUPS v2.5b1 (TBA) not used (Issue #674) - Updated `cups_enum_dests()` timeout for listing available IPP printers (Issue #751) +- Updated default destination documentation (Issue #819) - Updated `httpAddrConnect2()` to handle `POLLHUP` together with `POLLIN` or `POLLOUT` (Issue #839) - Updated the policies help document with the correct `Order` directive to deny diff --git a/doc/help/man-backend.html b/doc/help/man-backend.html index a5eb12e04e..81ba0318b2 100644 --- a/doc/help/man-backend.html +++ b/doc/help/man-backend.html @@ -1,7 +1,7 @@ - + backend(7) @@ -47,7 +47,7 @@

Description

Backends are a special type of -filter(7) +filter(7) which is used to send print data to and discover different devices on the system.

@@ -179,10 +179,10 @@ The scheduler will retry the job immediately without allowing intervening jobs.

Environment

In addition to the environment variables listed in -cups(1) +cups(1) and -filter(7), +filter(7), CUPS backends can expect the following environment variable:

@@ -203,24 +203,24 @@ Backends can also be installed with restricted permissions (0500 or 0700) that t

Unless you are a developer and know what you are doing, please do not run backends directly. Instead, use the -lp(1) +lp(1) or -lpr(1) +lpr(1) programs to send print jobs or -lpinfo(8) +lpinfo(8) to query for available printers using the backend. The one exception is the SNMP backend - see -cups-snmp(8) +cups-snmp(8) for more information.

Notes

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 -ippeveprinter(1). +ippeveprinter(1).

Notes

Administrators wishing to prevent unauthorized cancellation of jobs via the -u option should require authentication for Cancel-Jobs operations in -cupsd.conf(5). +cupsd.conf(5).

Description

The classes.conf file defines the local printer classes that are available. It is normally located in the /etc/cups directory and is maintained by the -cupsd(8) +cupsd(8) program. This file is not intended to be edited or managed manually. @@ -21,17 +21,17 @@ This file is not intended to be edited or managed manually.

The name, location, and format of this file are an implementation detail that will change in future releases of CUPS.

Description

The cups-files.conf file configures the files and directories used by the CUPS scheduler, -cupsd(8). +cupsd(8). It is normally located in the /etc/cups directory.

@@ -22,7 +22,7 @@ Comment lines start with the # character.

Directives

The following directives are understood by -cupsd(8): +cupsd(8):

AccessLog
@@ -246,21 +246,21 @@ command, while on macOS the command is used instead.

Directives

@@ -60,11 +60,11 @@ The default is 120 seconds (2 minutes).

Notes

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 -ippeveprinter(1). +ippeveprinter(1).

Notes

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 -ippeveprinter(1). +ippeveprinter(1).

Description

The cupsd-helper programs perform long-running operations on behalf of the scheduler, -cupsd(8). +cupsd(8). The cups-deviced helper program runs each CUPS -backend(7) +backend(7) with no arguments in order to discover the available printers.

@@ -77,27 +77,27 @@ program or placed in compressed archives to further reduce their size.

Driver information files must conform to the format defined in -ppdcfile(5). +ppdcfile(5).

Notes

Description

cupsd(8) +

cupsd(8) normally maintains three log files: access_log to track requests that are submitted to the scheduler, error_log to track progress and errors, and page_log to track pages that are printed. Configuration directives in -cupsd.conf(5) +cupsd.conf(5) and -cups-files.conf(5) +cups-files.conf(5) control what information is logged and where it is stored.

@@ -119,7 +119,7 @@ For POST requests the bytes field contains the number of bytes of non-IPP data t

Error Log File Format

The error_log file lists messages from the scheduler - errors, warnings, etc. The LogLevel directive in the -cupsd.conf(5) +cupsd.conf(5) file controls which messages are logged:

@@ -195,7 +195,7 @@ By default, each line contains the following information:

The PageLogFormat directive in the -cupsd.conf(5) +cupsd.conf(5) file can be used to change this information.

@@ -222,11 +222,11 @@ The format of this field is identical to the data-time field in the access_l
The sides field contains a copy of the sides attribute provided with the IPP Create-Job or Print-Job requests or "-" if none was provided.

See Also
-
cupsd(8), +
cupsd(8), -cupsd.conf(5), +cupsd.conf(5), -cups-files.conf(5), +cups-files.conf(5), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-cupsd.conf.html b/doc/help/man-cupsd.conf.html index 838b40b37d..5b3b1e67d3 100644 --- a/doc/help/man-cupsd.conf.html +++ b/doc/help/man-cupsd.conf.html @@ -1,7 +1,7 @@ - + cupsd.conf(5) @@ -13,7 +13,7 @@
The cupsd.conf file configures the CUPS scheduler, -cupsd(8). +cupsd(8). It is normally located in the /etc/cups @@ -25,7 +25,7 @@ Comment lines start with the # character.

Top-Level Directives

The following top-level directives are understood by -cupsd(8): +cupsd(8):

AccessLogLevel config
@@ -156,7 +156,7 @@ The default is 0.
HostNameLookups Double
Specifies whether to do reverse lookups on connecting clients. The "Double" setting causes -cupsd(8) +cupsd(8) to verify that the hostname resolved from the address matches one of the addresses returned for that hostname. Double lookups also prevent clients with unregistered addresses from connecting to your server. @@ -167,7 +167,7 @@ Only set this option to "On" or "Double" if absolutely requi Specifies the length of time to wait before shutting down due to inactivity. The default is "60" seconds. Note: Only applicable when -cupsd(8) +cupsd(8) is run on-demand (e.g., with -l).
@@ -433,7 +433,7 @@ The default is "No".

Http Method Names

The following HTTP methods are supported by -cupsd(8): +cupsd(8):

GET
@@ -453,7 +453,7 @@ Used by a client to upload configuration files.

Ipp Operation Names

The following IPP operations are supported by -cupsd(8): +cupsd(8):

CUPS-Accept-Jobs
@@ -590,7 +590,7 @@ Validates options for a new job.

Location Paths

The following paths are commonly used when configuring -cupsd(8): +cupsd(8):

/
@@ -712,7 +712,7 @@ Specifies that an authenticated user must be a member of one of the named groups
Require user {user-name|@group-name} ...
Specifies that an authenticated user must match one of the named users or be a member of one of the named groups. The group name "@SYSTEM" corresponds to the list of groups defined by the SystemGroup directive in the -cups-files.conf(5) +cups-files.conf(5) file. The group name "@OWNER" corresponds to the owner of the resource, for example the person that submitted a print job. @@ -741,7 +741,7 @@ The "default" access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. "@OWNER" maps to the job's owner. "@SYSTEM" maps to the groups listed for the SystemGroup directive in the -cups-files.conf(5) +cups-files.conf(5) file.
@@ -765,7 +765,7 @@ The "default" access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. "@OWNER" maps to the job's owner. "@SYSTEM" maps to the groups listed for the SystemGroup directive in the -cups-files.conf(5) +cups-files.conf(5) file.
@@ -827,7 +827,7 @@ Use "%{job-impressions-completed}" to insert the number of pages (side

Notes

File, directory, and user configuration directives that used to be allowed in the cupsd.conf file are now stored in the -cups-files.conf(5) +cups-files.conf(5) file instead in order to prevent certain types of privilege escalation attacks.
@@ -868,19 +868,19 @@ often belongs to a different set of subnets from its clients. </Location>
See Also
-
classes.conf(5), +
classes.conf(5), -cups-files.conf(5), +cups-files.conf(5), -cupsd(8), +cupsd(8), -mime.convs(5), +mime.convs(5), -mime.types(5), +mime.types(5), -printers.conf(5), +printers.conf(5), -subscriptions.conf(5), +subscriptions.conf(5), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-cupsd.html b/doc/help/man-cupsd.html index 6fe2c3617d..aaa8077181 100644 --- a/doc/help/man-cupsd.html +++ b/doc/help/man-cupsd.html @@ -1,7 +1,7 @@ - + cupsd(8) @@ -115,31 +115,31 @@ in the foreground with a test configuration file called
See Also
-
backend(7), +
backend(7), -classes.conf(5), +classes.conf(5), -cups(1), +cups(1), -cups-files.conf(5), +cups-files.conf(5), -cups-lpd(8), +cups-lpd(8), -cupsd.conf(5), +cupsd.conf(5), -cupsd-helper(8), +cupsd-helper(8), cupsd-logs(8), -filter(7), +filter(7), launchd(8), -mime.convs(5), +mime.convs(5), -mime.types(5), +mime.types(5), -printers.conf(5), +printers.conf(5), systemd(8), diff --git a/doc/help/man-cupsenable.html b/doc/help/man-cupsenable.html index 2142c34738..996d32d4a3 100644 --- a/doc/help/man-cupsenable.html +++ b/doc/help/man-cupsenable.html @@ -1,7 +1,7 @@ - + cupsenable(8) @@ -90,17 +90,17 @@ built-in commands of the same names. This differs from the System V versions which require the root user to execute these commands.

See Also
-
cupsaccept(8), +
cupsaccept(8), cupsreject(8), -cancel(1), +cancel(1), -lp(1), +lp(1), -lpadmin(8), +lpadmin(8), -lpstat(1), +lpstat(1), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-cupsfilter.html b/doc/help/man-cupsfilter.html index 5eb8bc9089..9049c6f3f3 100644 --- a/doc/help/man-cupsfilter.html +++ b/doc/help/man-cupsfilter.html @@ -1,7 +1,7 @@ - + cupsfilter(8) @@ -107,7 +107,7 @@ returns a non-zero exit status on any error.

Environment

All of the standard -cups(1) +cups(1) environment variables affect the operation of cupsfilter. @@ -123,7 +123,7 @@ environment variables affect the operation of
Notes

CUPS printer drivers, filters, 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 -ippeveprinter(1). +ippeveprinter(1).

Unlike when printing, filters run using the @@ -137,9 +137,9 @@ command use the current user and security session. This may result in different cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf
See Also
-
cups(1), +
cups(1), -cupsd.conf(5), +cupsd.conf(5), filter(7), diff --git a/doc/help/man-cupstestppd.html b/doc/help/man-cupstestppd.html index 201db603da..586ad907f5 100644 --- a/doc/help/man-cupstestppd.html +++ b/doc/help/man-cupstestppd.html @@ -1,7 +1,7 @@ - + cupstestppd(1) @@ -141,11 +141,11 @@ The PPD file does not conform to the Adobe PPD specification.
Notes

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 -ippeveprinter(1). +ippeveprinter(1).

See Also
-
lpadmin(8), +
lpadmin(8), CUPS Online Help (http://localhost:631/help), Adobe PostScript Printer Description File Format Specification, Version 4.3. diff --git a/doc/help/man-filter.html b/doc/help/man-filter.html index f8f2ebc41a..bc8a647198 100644 --- a/doc/help/man-filter.html +++ b/doc/help/man-filter.html @@ -1,7 +1,7 @@ - + filter(7) @@ -209,27 +209,27 @@ The user executing the filter, typically "lp" or "root"; con
Notes

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 -ippeveprinter(1). +ippeveprinter(1).

CUPS filters are not meant to be run directly by the user. Aside from the legacy System V interface issues (argv[0] is the printer name), CUPS filters also expect specific environment variables and file descriptors, and typically run in a user session that (on macOS) has additional restrictions that affect how it runs. Unless you are a developer and know what you are doing, please do not run filters directly. Instead, use the -cupsfilter(8) +cupsfilter(8) program to use the appropriate filters to do the conversions you need.

See Also
-
backend(7), +
backend(7), -cups(1), +cups(1), -cups-files.conf(5), +cups-files.conf(5), -cupsd(8), +cupsd(8), -cupsfilter(8), +cupsfilter(8),
CUPS Online Help (http://localhost:631/help) diff --git a/doc/help/man-ippevepcl.html b/doc/help/man-ippevepcl.html index 79df63733c..a0f16afe22 100644 --- a/doc/help/man-ippevepcl.html +++ b/doc/help/man-ippevepcl.html @@ -1,7 +1,7 @@ - + ippevepcl/ps(7) @@ -25,7 +25,7 @@ and ippeveps are print commands for -ippeveprinter(1). +ippeveprinter(1). As with all print commands, these commands read either the filename specified on the command-line or from the standard input. Output is sent to the standard output. diff --git a/doc/help/man-ippeveprinter.html b/doc/help/man-ippeveprinter.html index 9fcabeef2f..fe4ce0a5ae 100644 --- a/doc/help/man-ippeveprinter.html +++ b/doc/help/man-ippeveprinter.html @@ -1,7 +1,7 @@ - + ippeveprinter(1) @@ -145,7 +145,7 @@ Specifies the maximum IPP version to report.
-a filename.conf
Load printer attributes from "filename.conf". Attribute files can be created using the -ipptool(1) +ipptool(1) command with the --ippserver @@ -157,11 +157,11 @@ If "command" is not an absolute path ("/path/to/command"), ippeveprinter looks for the command in the "command" subdirectory of the CUPS binary directory, typically /usr/lib/cups/command or /usr/libexec/cups/command. The -cups-config(1) +cups-config(1) command can be used to discover the correct binary directory ("cups-config --serverbin"). In addition, the CUPS_SERVERBIN environment variable can be used to override the default location of this directory - see the -cups(1) +cups(1) man page for more details.
@@ -289,7 +289,7 @@ command whenever a job is sent to the server: ippeveprinter -c /usr/bin/file "My Cool Printer"
See Also
-
ippevepcl(7), +
ippevepcl(7), ippeveps(7), diff --git a/doc/help/man-ippfind.html b/doc/help/man-ippfind.html index 7894c680a0..70394e1c66 100644 --- a/doc/help/man-ippfind.html +++ b/doc/help/man-ippfind.html @@ -1,7 +1,7 @@ - + ippfind(1) @@ -263,7 +263,7 @@ Values of TXT record KEY (uppercase). -f onepage-letter.ps '{}' print-job.test \;
See Also
-
ipptool(1) +
ipptool(1)

Copyright
diff --git a/doc/help/man-ipptool.html b/doc/help/man-ipptool.html index 6dcc34b072..405034ef2a 100644 --- a/doc/help/man-ipptool.html +++ b/doc/help/man-ipptool.html @@ -1,7 +1,7 @@ - + ipptool(1) @@ -87,7 +87,7 @@ Output is either a plain text, formatted text, CSV, or XML report on the standar The testfile format is described in -ipptoolfile(5). +ipptoolfile(5).

Options
@@ -264,7 +264,7 @@ program is unique to CUPS and conforms to the Internet Printing Protocol up to v ipp://localhost/printers/myprinter create-printer-subscription.test
See Also
-
ipptoolfile(5), +
ipptoolfile(5), IANA IPP Registry (https://www.iana.org/assignments/ipp-registrations), PWG Internet Printing Protocol Workgroup (https://www.pwg.org/ipp) diff --git a/doc/help/man-ipptoolfile.html b/doc/help/man-ipptoolfile.html index 5caaf56b9a..f67e36681e 100644 --- a/doc/help/man-ipptoolfile.html +++ b/doc/help/man-ipptoolfile.html @@ -1,7 +1,7 @@ - + ipptoolfile(5) @@ -11,7 +11,7 @@

Description

The -ipptool(1) +ipptool(1) program accepts free-form plain text files that describe one or more IPP requests. Comments start with the "#" character and continue to the end of the line. @@ -738,7 +738,7 @@ if any. Inserts the current user's login name.

See Also
-
ipptool(1), +
ipptool(1), IANA IPP Registry (https://www.iana.org/assignments/ipp-registrations), PWG Internet Printing Protocol Workgroup (https://www.pwg.org/ipp), diff --git a/doc/help/man-lp.html b/doc/help/man-lp.html index 2b70c4c8f8..f3aa5e745c 100644 --- a/doc/help/man-lp.html +++ b/doc/help/man-lp.html @@ -1,7 +1,7 @@ - + lp(1) @@ -88,10 +88,10 @@ Use a filename of "-" to force printing from the standard input.
The Default Destination

CUPS provides many ways to set the default destination. The LPDEST and PRINTER environment variables are consulted first. If neither are set, the current default set using the -lpoptions(1) +lpoptions(1) command is used, followed by the default set using the -lpadmin(8) +lpadmin(8) command.
@@ -162,7 +162,7 @@ The page numbers refer to the output pages and not the document's original pages

Common Job Options

Aside from the printer-specific options reported by the -lpoptions(1) +lpoptions(1) command, the following generic options are available:
@@ -200,6 +200,15 @@ Prints on both sides of the paper for portrait output.

-o sides=two-sided-short-edge
Prints on both sides of the paper for landscape output. +
+
Environment
+
The following environment variables override the default destination: +
+
LPDEST
+Specifies the default print queue (System V standard). +
+
PRINTER
+Specifies the default print queue (Berkeley standard).

Conforming To

Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#". @@ -226,19 +235,19 @@ Also, printer and class names are not case-sensitive. lp -d bar -o number-up=2 filename
See Also
-
cancel(1), +
cancel(1), -lpadmin(8), +lpadmin(8), -lpoptions(1), +lpoptions(1), -lpq(1), +lpq(1), -lpr(1), +lpr(1), -lprm(1), +lprm(1), -lpstat(1), +lpstat(1), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-lpadmin.html b/doc/help/man-lpadmin.html index 658c0b1d94..4f19b191c4 100644 --- a/doc/help/man-lpadmin.html +++ b/doc/help/man-lpadmin.html @@ -1,13 +1,13 @@ - + lpadmin(8)
lpadmin(8)

Name
-
lpadmin - configure cups printers and classes +
lpadmin - configure cups printers and classes on cups scheduler

Synopsis

lpadmin @@ -57,15 +57,15 @@ It can also be used to set the server default printer or class.

When specified before the -d, -p, or -x options, the -E option forces encryption when connecting to the server.
-
The first form of the command (-d) sets the default printer or class to destination. +
The first form of the command (-d) sets the scheduler's default printer or class to destination. Subsequent print jobs submitted via the -lp(1) +lp(1) or -lpr(1) +lpr(1) commands will use this destination unless the user specifies otherwise with the -lpoptions(1) +lpoptions(1) command.
@@ -84,7 +84,7 @@ If class does not exist it is created automatically.
-m model
Sets a standard PPD file for the printer from the model directory or using one of the driver interfaces. Use the -m option with the -lpinfo(8) +lpinfo(8) command to get a list of supported models. The model "raw" clears any existing PPD file and the model "everywhere" queries the printer referred to by the specified IPP device-uri. @@ -120,7 +120,7 @@ Sets the default banner page(s) to use for print jobs.
-o name=value
Sets a PPD option for the printer. PPD options can be listed using the -l option with the -lpoptions(1) +lpoptions(1) command.
@@ -173,7 +173,7 @@ Note: The user 'root' is not granted special access - using "-u allow:foo,b
-v "device-uri"
Sets the device-uri attribute of the printer queue. Use the -v option with the -lpinfo(8) +lpinfo(8) command to get a list of supported device URIs and schemes.
@@ -183,10 +183,10 @@ Provides a textual description of the destination.
-E
When specified before the -d, -p, or -x options, forces the use of TLS encryption on the connection to the scheduler. Otherwise, enables the destination and accepts jobs; this is the same as running the -cupsaccept(8) +cupsaccept(8) and -cupsenable(8) +cupsenable(8) programs on the destination.
@@ -215,7 +215,7 @@ This differs from the System V version which requires the root user to execute t
Notes

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 -ippeveprinter(1). +ippeveprinter(1).

The CUPS version of lpadmin does not support all of the System V or Solaris printing system configuration options. @@ -236,13 +236,13 @@ These files should not be edited directly and are an implementation detail of CU
See Also
-
cupsaccept(8), +
cupsaccept(8), -cupsenable(8), +cupsenable(8), -lpinfo(8), +lpinfo(8), -lpoptions(1), +lpoptions(1), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-lpc.html b/doc/help/man-lpc.html index 32d954ff68..fd3e160d16 100644 --- a/doc/help/man-lpc.html +++ b/doc/help/man-lpc.html @@ -1,7 +1,7 @@ - + lpc(8) @@ -44,26 +44,26 @@ Displays the status of one or more printer or class queues.

Since lpc is geared towards the Berkeley printing system, it is impossible to use lpc to configure printer or class queues provided by CUPS. To configure printer or class queues you must use the -lpadmin(8) +lpadmin(8) command or another CUPS-compatible client with that functionality.

See Also
-
cancel(1), +
cancel(1), -cupsaccept(8), +cupsaccept(8), -cupsenable(8), +cupsenable(8), -lp(1), +lp(1), -lpadmin(8), +lpadmin(8), -lpr(1), +lpr(1), -lprm(1), +lprm(1), -lpstat(1), +lpstat(1), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-lpinfo.html b/doc/help/man-lpinfo.html index 61147f3adb..97f7b3c9f0 100644 --- a/doc/help/man-lpinfo.html +++ b/doc/help/man-lpinfo.html @@ -1,7 +1,7 @@ - + lpinfo(8) @@ -121,11 +121,11 @@ Specifies the timeout when listing devices with the -v option.
Notes

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 -ippeveprinter(1). +ippeveprinter(1).

See Also
-
lpadmin(8), +
lpadmin(8), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-lpmove.html b/doc/help/man-lpmove.html index 261c30ffe9..20ce440355 100644 --- a/doc/help/man-lpmove.html +++ b/doc/help/man-lpmove.html @@ -1,7 +1,7 @@ - + lpmove(8) @@ -67,13 +67,13 @@ Note: This option must occur before all others. lpmove oldprinter newprinter
See Also
-
cancel(1), +
cancel(1), -lp(1), +lp(1), -lpr(1), +lpr(1), -lprm(1), +lprm(1),
CUPS Online Help (http://localhost:631/help) diff --git a/doc/help/man-lpoptions.html b/doc/help/man-lpoptions.html index c3c985d545..99cc46817a 100644 --- a/doc/help/man-lpoptions.html +++ b/doc/help/man-lpoptions.html @@ -1,13 +1,13 @@ - + lpoptions(1)
lpoptions(1)

Name
-
lpoptions - display or set printer options and defaults +
lpoptions - display or set per-user printer options and defaults

Synopsis

lpoptions @@ -53,16 +53,16 @@
Description

lpoptions displays or sets printer options and defaults. If no printer is specified using the -p option, the default printer is used as described in -lp(1). +lp(1).

If no -l, -o, or -r options are specified, the current options are reported on the standard output.

Options set with the lpoptions command are used by the -lp(1) +lp(1) and -lpr(1) +lpr(1) commands when submitting jobs.
@@ -94,7 +94,7 @@ Specifies a new option for the named destination. Sets the destination and instance, if specified, for any options that follow. If the named instance does not exist then it is created. Destinations can only be created using the -lpadmin(8) +lpadmin(8) program.
@@ -105,9 +105,18 @@ Removes the specified option from the named destination. Removes the options for the named destination and instance, if specified. If the named instance does not exist then this does nothing. Destinations can only be removed using the -lpadmin(8) +lpadmin(8) command. +
+
Environment
+
The following environment variables override the default destination: +
+
LPDEST
+Specifies the default print queue (System V standard). +
+
PRINTER
+Specifies the default print queue (Berkeley standard).

Files

~/.cups/lpoptions - user defaults and instances created by non-root users. @@ -118,15 +127,15 @@ command.
The lpoptions command is unique to CUPS.

See Also
-
cancel(1), +
cancel(1), -lp(1), +lp(1), -lpadmin(8), +lpadmin(8), -lpr(1), +lpr(1), -lprm(1), +lprm(1), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-lpq.html b/doc/help/man-lpq.html index 113d9559f5..fe9d78eba2 100644 --- a/doc/help/man-lpq.html +++ b/doc/help/man-lpq.html @@ -1,7 +1,7 @@ - + lpq(1) @@ -58,15 +58,15 @@ Note: This option must occur before all others. Requests a more verbose (long) reporting format.

See Also
-
cancel(1), +
cancel(1), -lp(1), +lp(1), -lpr(1), +lpr(1), -lprm(1), +lprm(1), -lpstat(1), +lpstat(1), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-lpr.html b/doc/help/man-lpr.html index 94a41dc332..c5f5b3548a 100644 --- a/doc/help/man-lpr.html +++ b/doc/help/man-lpr.html @@ -1,7 +1,7 @@ - + lpr(1) @@ -58,10 +58,10 @@ If no files are listed on the command-line, lpr reads the print
The Default Destination

CUPS provides many ways to set the default destination. The LPDEST and PRINTER environment variables are consulted first. If neither are set, the current default set using the -lpoptions(1) +lpoptions(1) command is used, followed by the default set using the -lpadmin(8) +lpadmin(8) command.
@@ -117,7 +117,7 @@ Specifies that the named print files should be deleted after submitting them.

Common Job Options

Aside from the printer-specific options reported by the -lpoptions(1) +lpoptions(1) command, the following generic options are available:
@@ -158,6 +158,15 @@ Prints on both sides of the paper for landscape output.

Notes

The -c, -d, -f, -g, -i, -n, -t, -v, and -w options are not supported by CUPS and produce a warning message if used. +
+
Environment
+
The following environment variables override the default destination: +
+
LPDEST
+Specifies the default print queue (System V standard). +
+
PRINTER
+Specifies the default print queue (Berkeley standard).

Examples

Print two copies of a document to the default printer: @@ -178,19 +187,19 @@ Prints on both sides of the paper for landscape output. lpr -P foo -o number-up=2 filename
See Also
-
cancel(1), +
cancel(1), -lp(1), +lp(1), -lpadmin(8), +lpadmin(8), -lpoptions(1), +lpoptions(1), -lpq(1), +lpq(1), -lprm(1), +lprm(1), -lpstat(1), +lpstat(1), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-lprm.html b/doc/help/man-lprm.html index 9015cd91db..a795d279e1 100644 --- a/doc/help/man-lprm.html +++ b/doc/help/man-lprm.html @@ -1,7 +1,7 @@ - + lprm(1) @@ -76,15 +76,15 @@ is compatible with the standard Berkeley command of the same name. lprm -
See Also
-
cancel(1), +
cancel(1), -lp(1), +lp(1), -lpq(1), +lpq(1), -lpr(1), +lpr(1), -lpstat(1), +lpstat(1), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-lpstat.html b/doc/help/man-lpstat.html index 3935d816f9..79424f3564 100644 --- a/doc/help/man-lpstat.html +++ b/doc/help/man-lpstat.html @@ -1,7 +1,7 @@ - + lpstat(1) @@ -83,7 +83,7 @@ Shows the ranking of print jobs. Specifies an alternate username.

-W which-jobs
-Specifies which jobs to show, "all", "successful", "completed" or "not-completed" (the default). +Specifies which jobs to show, "all, "successful", "completed" or "not-completed" (the default). This option must appear before the -o option and/or any printer names, otherwise the default ("not-completed") value will be used in the request to the scheduler.

-a [printer(s)]
@@ -95,7 +95,10 @@ Shows the printer classes and the printers that belong to them. If no classes are specified then all classes are listed.

-d
-Shows the current default destination. +Shows the current default destination, either the +lpoptions(1) + +default (if set) or the scheduler default (otherwise).

-e
Shows all available destinations on the local network. @@ -133,6 +136,15 @@ If no users are specified, lists the jobs queued by the current user.
-v [printer(s)]
Shows the printers and what device they are attached to. If no printers are specified then all printers are listed. +
+
Environment
+
The following environment variables override the default destination: +
+
LPDEST
+Specifies the default print queue (System V standard). +
+
PRINTER
+Specifies the default print queue (Berkeley standard).

Conforming To

Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", and "#". @@ -143,15 +155,15 @@ Also, printer and class names are not case-sensitive.
The Solaris -f, -P, and -S options are silently ignored.

See Also
-
cancel(1), +
cancel(1), -lp(1), +lp(1), -lpq(1), +lpq(1), -lpr(1), +lpr(1), -lprm(1), +lprm(1), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-mailto.conf.html b/doc/help/man-mailto.conf.html index d5da0f1b82..30df522743 100644 --- a/doc/help/man-mailto.conf.html +++ b/doc/help/man-mailto.conf.html @@ -1,7 +1,7 @@ - + mailto.conf(5) @@ -38,7 +38,7 @@ If multiple lines are present, only the last one is used. Specifies a prefix string for the subject line of an email notification.

See Also
-
cupsd(8), +
cupsd(8), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-mime.convs.html b/doc/help/man-mime.convs.html index b7451513c5..229fb52318 100644 --- a/doc/help/man-mime.convs.html +++ b/doc/help/man-mime.convs.html @@ -1,7 +1,7 @@ - + mime.convs(5) @@ -51,19 +51,19 @@ Filenames are relative to the CUPS filter directory.
Notes

CUPS filters 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 -ippeveprinter(1). +ippeveprinter(1).

See Also
-
cups-files.conf(5), +
cups-files.conf(5), -cupsd.conf(5), +cupsd.conf(5), -cupsd(8), +cupsd(8), -cupsfilter(8), +cupsfilter(8), -mime.types(5), +mime.types(5), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-mime.types.html b/doc/help/man-mime.types.html index 1592619ec2..55626b2480 100644 --- a/doc/help/man-mime.types.html +++ b/doc/help/man-mime.types.html @@ -1,7 +1,7 @@ - + mime.types(5) @@ -102,15 +102,15 @@ However, if "text/foo" also defines a higher priority than "text/ string(4,PwgRaster<00>) priority(150)
See Also
-
cups-files.conf(5), +
cups-files.conf(5), -cupsd.conf(5), +cupsd.conf(5), -cupsd(8), +cupsd(8), -cupsfilter(8), +cupsfilter(8), -mime.convs(5), +mime.convs(5), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-notifier.html b/doc/help/man-notifier.html index 4529d03489..b35e5ae987 100644 --- a/doc/help/man-notifier.html +++ b/doc/help/man-notifier.html @@ -1,7 +1,7 @@ - + notifier(7) @@ -29,13 +29,13 @@ and functions and exit on error. Notifiers are encouraged to exit after a suitable period of inactivity, however they may exit after reading the first message or stay running until an error is seen. Notifiers inherit the environment and can use the logging mechanism documented in -filter(7). +filter(7).

See Also
-
cupsd(8), +
cupsd(8), -filter(7), +filter(7), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-ppdc.html b/doc/help/man-ppdc.html index 864d0b3eec..40a93422ac 100644 --- a/doc/help/man-ppdc.html +++ b/doc/help/man-ppdc.html @@ -1,7 +1,7 @@ - + ppdc(1) @@ -92,19 +92,19 @@ The default is to use the line feed character alone.
Notes

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 -ippeveprinter(1). +ippeveprinter(1).

See Also
-
ppdhtml(1), +
ppdhtml(1), -ppdi(1), +ppdi(1), -ppdmerge(1), +ppdmerge(1), -ppdpo(1), +ppdpo(1), -ppdcfile(5), +ppdcfile(5), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-ppdcfile.html b/doc/help/man-ppdcfile.html index 1a42175a2f..da7a1bd763 100644 --- a/doc/help/man-ppdcfile.html +++ b/doc/help/man-ppdcfile.html @@ -1,7 +1,7 @@ - + ppdcfile(5) @@ -11,7 +11,7 @@

Description

The CUPS PPD compiler reads meta files that contain descriptions of one or more PPD files to be generated by -ppdc(1). +ppdc(1). This man page provides a quick reference to the supported keywords and should be used in conjunction with the online help for CUPS.
@@ -150,19 +150,19 @@ This man page provides a quick reference to the supported keywords and should be
Notes

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 -ippeveprinter(1). +ippeveprinter(1).

See Also
-
ppdc(1), +
ppdc(1), -ppdhtml(1), +ppdhtml(1), -ppdi(1), +ppdi(1), -ppdmerge(1), +ppdmerge(1), -ppdpo(1), +ppdpo(1), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-ppdhtml.html b/doc/help/man-ppdhtml.html index a876f19b32..267d346ce8 100644 --- a/doc/help/man-ppdhtml.html +++ b/doc/help/man-ppdhtml.html @@ -1,7 +1,7 @@ - + ppdhtml(1) @@ -37,19 +37,19 @@ Multiple -I options can be supplied to add additional directories.
Notes

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 -ippeveprinter(1). +ippeveprinter(1).

See Also
-
ppdc(1), +
ppdc(1), -ppdcfile(5), +ppdcfile(5), -ppdi(1), +ppdi(1), -ppdmerge(1), +ppdmerge(1), -ppdpo(1), +ppdpo(1), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-ppdi.html b/doc/help/man-ppdi.html index 8a5fc939e9..65bcf1fbe8 100644 --- a/doc/help/man-ppdi.html +++ b/doc/help/man-ppdi.html @@ -1,7 +1,7 @@ - + ppdi(1) @@ -44,19 +44,19 @@ If no source file is specified, the filename ppdi.drv is used.
Notes

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 -ippeveprinter(1). +ippeveprinter(1).

See Also
-
ppdc(1), +
ppdc(1), -ppdhtml(1), +ppdhtml(1), -ppdmerge(1), +ppdmerge(1), -ppdpo(1), +ppdpo(1), -ppdcfile(5), +ppdcfile(5), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-ppdmerge.html b/doc/help/man-ppdmerge.html index f8b25073b9..a9daa5a2e7 100644 --- a/doc/help/man-ppdmerge.html +++ b/doc/help/man-ppdmerge.html @@ -1,7 +1,7 @@ - + ppdmerge(1) @@ -37,22 +37,22 @@ If the output file already exists, it is silently overwritten.
Notes

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 -ippeveprinter(1). +ippeveprinter(1).

ppdmerge does not check whether the merged PPD files are for the same device. Merging of different device PPDs will yield unpredictable results.

See Also
-
ppdc(1), +
ppdc(1), -ppdhtml(1), +ppdhtml(1), -ppdi(1), +ppdi(1), -ppdpo(1), +ppdpo(1), -ppdcfile(5), +ppdcfile(5), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-ppdpo.html b/doc/help/man-ppdpo.html index 9b49abd8a2..c887aeeec0 100644 --- a/doc/help/man-ppdpo.html +++ b/doc/help/man-ppdpo.html @@ -1,7 +1,7 @@ - + ppdpo(1) @@ -44,17 +44,17 @@ The supported extensions are .po or .po.gz for GNU gettext for
Notes

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 -ippeveprinter(1). +ippeveprinter(1).

See Also
-
ppdc(1), +
ppdc(1), -ppdhtml(1), +ppdhtml(1), -ppdi(1), +ppdi(1), -ppdmerge(1), +ppdmerge(1), ppdcfile(5), diff --git a/doc/help/man-printers.conf.html b/doc/help/man-printers.conf.html index d6b0cd647f..1fd7f1bfa0 100644 --- a/doc/help/man-printers.conf.html +++ b/doc/help/man-printers.conf.html @@ -1,7 +1,7 @@ - + printers.conf(5) @@ -11,7 +11,7 @@

Description

The printers.conf file defines the local printers that are available. It is normally located in the /etc/cups directory and is maintained by the -cupsd(8) +cupsd(8) program. This file is not intended to be edited or managed manually.
@@ -19,19 +19,19 @@ program. This file is not intended to be edited or managed manually.
The name, location, and format of this file are an implementation detail that will change in future releases of CUPS.

See Also
-
classes.conf(5), +
classes.conf(5), -cups-files.conf(5), +cups-files.conf(5), -cupsd(8), +cupsd(8), -cupsd.conf(5), +cupsd.conf(5), -mime.convs(5), +mime.convs(5), -mime.types(5), +mime.types(5), -subscriptions.conf(5), +subscriptions.conf(5), CUPS Online Help (http://localhost:631/help)
diff --git a/doc/help/man-subscriptions.conf.html b/doc/help/man-subscriptions.conf.html index a5c33737bd..413ad6605c 100644 --- a/doc/help/man-subscriptions.conf.html +++ b/doc/help/man-subscriptions.conf.html @@ -1,7 +1,7 @@ - + subscriptions.conf(5) @@ -12,7 +12,7 @@
Description

The subscriptions.conf file defines the local event notification subscriptions that are active. It is normally located in the /etc/cups directory and is maintained by the -cupsd(8) +cupsd(8) program. This file is not intended to be edited or managed manually. @@ -21,19 +21,19 @@ This file is not intended to be edited or managed manually.
The name, location, and format of this file are an implementation detail that will change in future releases of CUPS.

See Also
-
classes.conf(5), +
classes.conf(5), -cups-files.conf(5), +cups-files.conf(5), -cupsd(8), +cupsd(8), -cupsd.conf(5), +cupsd.conf(5), -mime.convs(5), +mime.convs(5), -mime.types(5), +mime.types(5), -printers.conf(5), +printers.conf(5), CUPS Online Help (http://localhost:631/help)
diff --git a/man/lp.1 b/man/lp.1 index d22358c6af..f11c27c230 100644 --- a/man/lp.1 +++ b/man/lp.1 @@ -8,7 +8,7 @@ .\" Licensed under Apache License v2.0. See the file "LICENSE" for more .\" information. .\" -.TH lp 1 "CUPS" "2022-05-02" "OpenPrinting" +.TH lp 1 "CUPS" "2024-04-02" "OpenPrinting" .SH NAME lp \- print files .SH SYNOPSIS @@ -195,6 +195,14 @@ Prints on both sides of the paper for portrait output. .TP 5 \fB\-o sides=two\-sided\-short\-edge\fR Prints on both sides of the paper for landscape output. +.SH ENVIRONMENT +The following environment variables override the default destination: +.TP 5 +.B LPDEST +Specifies the default print queue (System V standard). +.TP 5 +.B PRINTER +Specifies the default print queue (Berkeley standard). .SH CONFORMING TO Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#". Also, printer and class names are \fInot\fR case-sensitive. diff --git a/man/lpadmin.8 b/man/lpadmin.8 index b75b775b07..9804af4281 100644 --- a/man/lpadmin.8 +++ b/man/lpadmin.8 @@ -8,9 +8,9 @@ .\" Licensed under Apache License v2.0. See the file "LICENSE" for more .\" information. .\" -.TH lpadmin 8 "CUPS" "2021-02-28" "OpenPrinting" +.TH lpadmin 8 "CUPS" "2024-04-02" "OpenPrinting" .SH NAME -lpadmin \- configure cups printers and classes +lpadmin \- configure cups printers and classes on cups scheduler .SH SYNOPSIS .B lpadmin [ @@ -58,7 +58,7 @@ It can also be used to set the server default printer or class. .LP When specified before the \fI-d\fR, \fI-p\fR, or \fI-x\fR options, the \fI-E\fR option forces encryption when connecting to the server. .LP -The first form of the command (\fI-d\fR) sets the default printer or class to \fIdestination\fR. +The first form of the command (\fI-d\fR) sets the scheduler's default printer or class to \fIdestination\fR. Subsequent print jobs submitted via the .BR lp (1) or diff --git a/man/lpoptions.1 b/man/lpoptions.1 index 9c3a7e63bd..9692585878 100644 --- a/man/lpoptions.1 +++ b/man/lpoptions.1 @@ -8,9 +8,9 @@ .\" Licensed under Apache License v2.0. See the file "LICENSE" for more .\" information. .\" -.TH lpoptions 1 "CUPS" "2022-05-02" "OpenPrinting" +.TH lpoptions 1 "CUPS" "2024-04-02" "OpenPrinting" .SH NAME -lpoptions \- display or set printer options and defaults +lpoptions \- display or set per-user printer options and defaults .SH SYNOPSIS .B lpoptions [ @@ -103,6 +103,14 @@ If the named instance does not exist then this does nothing. Destinations can only be removed using the .BR lpadmin (8) command. +.SH ENVIRONMENT +The following environment variables override the default destination: +.TP 5 +.B LPDEST +Specifies the default print queue (System V standard). +.TP 5 +.B PRINTER +Specifies the default print queue (Berkeley standard). .SH FILES \fI~/.cups/lpoptions\fR - user defaults and instances created by non-root users. .br diff --git a/man/lpr.1 b/man/lpr.1 index 6757b4f4df..febd920bed 100644 --- a/man/lpr.1 +++ b/man/lpr.1 @@ -8,7 +8,7 @@ .\" Licensed under Apache License v2.0. See the file "LICENSE" for more .\" information. .\" -.TH lpr 1 "CUPS" "2022-05-02" "OpenPrinting" +.TH lpr 1 "CUPS" "2024-04-02" "OpenPrinting" .SH NAME lpr \- print files .SH SYNOPSIS @@ -152,6 +152,14 @@ Prints on both sides of the paper for portrait output. Prints on both sides of the paper for landscape output. .SH NOTES The \fI\-c\fR, \fI\-d\fR, \fI\-f\fR, \fI\-g\fR, \fI\-i\fR, \fI\-n\fR, \fI\-t\fR, \fI\-v\fR, and \fI\-w\fR options are not supported by CUPS and produce a warning message if used. +.SH ENVIRONMENT +The following environment variables override the default destination: +.TP 5 +.B LPDEST +Specifies the default print queue (System V standard). +.TP 5 +.B PRINTER +Specifies the default print queue (Berkeley standard). .SH EXAMPLES Print two copies of a document to the default printer: .nf diff --git a/man/lpstat.1 b/man/lpstat.1 index e554fc9566..8cdf5efe96 100644 --- a/man/lpstat.1 +++ b/man/lpstat.1 @@ -7,7 +7,7 @@ .\" .\" Licensed under Apache License v2.0. See the file "LICENSE" for more information. .\" -.TH lpstat 1 "CUPS" "2022-05-02" "OpenPrinting" +.TH lpstat 1 "CUPS" "2024-04-02" "OpenPrinting" .SH NAME lpstat \- print cups status information .SH SYNOPSIS @@ -94,7 +94,9 @@ Shows the printer classes and the printers that belong to them. If no classes are specified then all classes are listed. .TP 5 .B \-d -Shows the current default destination. +Shows the current default destination, either the +.BR lpoptions (1) +default (if set) or the scheduler default (otherwise). .TP 5 .B \-e Shows all available destinations on the local network. @@ -132,6 +134,14 @@ If no users are specified, lists the jobs queued by the current user. \fB\-v \fR[\fIprinter(s)\fR] Shows the printers and what device they are attached to. If no printers are specified then all printers are listed. +.SH ENVIRONMENT +The following environment variables override the default destination: +.TP 5 +.B LPDEST +Specifies the default print queue (System V standard). +.TP 5 +.B PRINTER +Specifies the default print queue (Berkeley standard). .SH CONFORMING TO Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", and "#". Also, printer and class names are \fInot\fR case-sensitive.