Greatly simplify the man page handling.
[thirdparty/cups.git] / man / lpoptions.1
CommitLineData
ef416fc2 1.\"
6e12033b 2.\" lpoptions man page for CUPS.
ef416fc2 3.\"
87030afb 4.\" Copyright © 2007-2019 by Apple Inc.
3581e03d 5.\" Copyright © 1997-2006 by Easy Software Products.
ef416fc2 6.\"
87030afb
MS
7.\" Licensed under Apache License v2.0. See the file "LICENSE" for more
8.\" information.
ef416fc2 9.\"
87030afb 10.TH lpoptions 1 "CUPS" "26 April 2019" "Apple Inc."
ef416fc2 11.SH NAME
12lpoptions \- display or set printer options and defaults
13.SH SYNOPSIS
14.B lpoptions
6e12033b
MS
15[
16.B \-E
17] [
6e12033b
MS
18\fB\-h \fIserver\fR[\fB:\fIport\fR]
19]
20\fB\-d \fIdestination\fR[\fB/\fIinstance\fR]
21[
22.B \-l
ef416fc2 23]
24.br
25.B lpoptions
6e12033b
MS
26[
27.B \-E
28] [
6e12033b
MS
29\fB\-h \fIserver\fR[\fB:\fIport\fR]
30] [
31\fB\-p \fIdestination\fR[\fB/\fIinstance\fR]
32]
33\fB\-o \fIoption\fR[\fB=\fIvalue\fR] ...
ef416fc2 34.br
35.B lpoptions
6e12033b
MS
36[
37.B \-E
38] [
6e12033b
MS
39\fB\-h \fIserver\fR[\fB:\fIport\fR]
40] [
41\fB\-p \fIdestination\fR[\fB/\fIinstance\fR]
42]
43.B \-r
ef416fc2 44.I option
45.br
46.B lpoptions
6e12033b
MS
47[
48.B \-E
49] [
6e12033b
MS
50\fB\-h \fIserver\fR[\fB:\fIport\fR]
51]
52\fB\-x \fIdestination\fR[\fB/\fIinstance\fR]
ef416fc2 53.SH DESCRIPTION
6e12033b
MS
54\fBlpoptions\fR displays or sets printer options and defaults.
55If no printer is specified using the \fI\-p\fR option, the default printer is used as described in
56.BR lp (1).
57.LP
58If no \fI\-l\fR, \fI\-o\fR, or \fI\-r\fR options are specified, the current options are reported on the standard output.
59.LP
60Options set with the \fBlpoptions\fR command are used by the
61.BR lp (1)
62and
63.BR lpr (1)
64commands when submitting jobs.
65.LP
66When run by the root user, \fBlpoptions\fR gets and sets default options and instances for all users in the \fI/etc/cups/lpoptions\fR file.
67Otherwise, the per-user defaults are managed in the \fI~/.cups/lpoptions\fR file.
68.SH OPTIONS
69\fBlpoptions\fR supports the following options:
ef416fc2 70.TP 5
6e12033b 71.B \-E
ef416fc2 72Enables encryption when communicating with the CUPS server.
73.TP 5
6e12033b
MS
74\fB\-d \fIdestination\fR[\fB/\fIinstance\fR]
75Sets the user default printer to \fIdestination\fR.
76If \fIinstance\fR is supplied then that particular instance is used.
77This option overrides the system default printer for the current user.
ef416fc2 78.TP 5
6e12033b 79\fB\-h \fIserver\fR[\fB:\fIport\fR]
bd7854cb 80Uses an alternate server.
ef416fc2 81.TP 5
6e12033b 82.B \-l
ef416fc2 83Lists the printer specific options and their current settings.
84.TP 5
6e12033b 85\fB\-o \fIoption\fR[\fB=\fIvalue\fR]
ef416fc2 86Specifies a new option for the named destination.
87.TP 5
6e12033b
MS
88\fB\-p \fIdestination\fR[\fB/\fIinstance\fR]
89Sets the destination and instance, if specified, for any options that follow.
90If the named instance does not exist then it is created.
91Destinations can only be created using the
92.BR lpadmin (8)
93program.
ef416fc2 94.TP 5
6e12033b
MS
95\fB\-r \fIoption\fR
96Removes the specified option from the named destination.
ef416fc2 97.TP 5
6e12033b
MS
98\fB\-x \fIdestination\fR[\fB/\fIinstance\fR]
99Removes the options for the named destination and instance, if specified.
100If the named instance does not exist then this does nothing.
101Destinations can only be removed using the
102.BR lpadmin (8)
103command.
ef416fc2 104.SH FILES
6e12033b 105\fI~/.cups/lpoptions\fR - user defaults and instances created by non-root users.
ef416fc2 106.br
6e12033b
MS
107\fI/etc/cups/lpoptions\fR - system-wide defaults and instances created by the root user.
108.SH CONFORMING TO
109The \fBlpoptions\fR command is unique to CUPS.
ef416fc2 110.SH SEE ALSO
6e12033b
MS
111.BR cancel (1),
112.BR lp (1),
113.BR lpadmin (8),
114.BR lpr (1),
115.BR lprm (1),
116CUPS Online Help (http://localhost:631/help)
ef416fc2 117.SH COPYRIGHT
87030afb 118Copyright \[co] 2007-2019 by Apple Inc.