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