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