]> git.ipfire.org Git - thirdparty/cups.git/blob - man/lpoptions.man.in
More updates.
[thirdparty/cups.git] / man / lpoptions.man.in
1 .\"
2 .\" "$Id$"
3 .\"
4 .\" lpoptions man page for CUPS.
5 .\"
6 .\" Copyright 2007-2014 by Apple Inc.
7 .\" Copyright 1997-2006 by Easy Software Products.
8 .\"
9 .\" These coded instructions, statements, and computer programs are the
10 .\" property of Apple Inc. and are protected by Federal copyright
11 .\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 .\" which should have been included with this file. If this file is
13 .\" file is missing or damaged, see the license at "http://www.cups.org/".
14 .\"
15 .TH lpoptions 1 "CUPS" "12 June 2014" "Apple Inc."
16 .SH NAME
17 lpoptions \- display or set printer options and defaults
18 .SH SYNOPSIS
19 .B lpoptions
20 [
21 .B \-E
22 ] [
23 .B \-U
24 .I username
25 ] [
26 \fB\-h \fIserver\fR[\fB:\fIport\fR]
27 ]
28 \fB\-d \fIdestination\fR[\fB/\fIinstance\fR]
29 [
30 .B \-l
31 ]
32 .br
33 .B lpoptions
34 [
35 .B \-E
36 ] [
37 .B \-U
38 .I username
39 ] [
40 \fB\-h \fIserver\fR[\fB:\fIport\fR]
41 ] [
42 \fB\-p \fIdestination\fR[\fB/\fIinstance\fR]
43 ]
44 \fB\-o \fIoption\fR[\fB=\fIvalue\fR] ...
45 .br
46 .B lpoptions
47 [
48 .B \-E
49 ] [
50 .B \-U
51 .I username
52 ] [
53 \fB\-h \fIserver\fR[\fB:\fIport\fR]
54 ] [
55 \fB\-p \fIdestination\fR[\fB/\fIinstance\fR]
56 ]
57 .B \-r
58 .I option
59 .br
60 .B lpoptions
61 [
62 .B \-E
63 ] [
64 .B \-U
65 .I username
66 ] [
67 \fB\-h \fIserver\fR[\fB:\fIport\fR]
68 ]
69 \fB\-x \fIdestination\fR[\fB/\fIinstance\fR]
70 .SH DESCRIPTION
71 \fBlpoptions\fR displays or sets printer options and defaults.
72 If no printer is specified using the \fI\-p\fR option, the default printer is used as described in
73 .BR lp (1).
74 .LP
75 If no \fI\-l\fR, \fI\-o\fR, or \fI\-r\fR options are specified, the current options are reported on the standard output.
76 .LP
77 Options set with the \fBlpoptions\fR command are used by the
78 .BR lp (1)
79 and
80 .BR lpr (1)
81 commands when submitting jobs.
82 .LP
83 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.
84 Otherwise, the per-user defaults are managed in the \fI~/.cups/lpoptions\fR file.
85 .SH OPTIONS
86 \fBlpoptions\fR supports the following options:
87 .TP 5
88 .B \-E
89 Enables encryption when communicating with the CUPS server.
90 .TP 5
91 \fB\-U \fIusername\fR
92 Uses an alternate username.
93 .TP 5
94 \fB\-d \fIdestination\fR[\fB/\fIinstance\fR]
95 Sets the user default printer to \fIdestination\fR.
96 If \fIinstance\fR is supplied then that particular instance is used.
97 This option overrides the system default printer for the current user.
98 .TP 5
99 \fB\-h \fIserver\fR[\fB:\fIport\fR]
100 Uses an alternate server.
101 .TP 5
102 .B \-l
103 Lists the printer specific options and their current settings.
104 .TP 5
105 \fB\-o \fIoption\fR[\fB=\fIvalue\fR]
106 Specifies a new option for the named destination.
107 .TP 5
108 \fB\-p \fIdestination\fR[\fB/\fIinstance\fR]
109 Sets the destination and instance, if specified, for any options that follow.
110 If the named instance does not exist then it is created.
111 Destinations can only be created using the
112 .BR lpadmin (8)
113 program.
114 .TP 5
115 \fB\-r \fIoption\fR
116 Removes the specified option from the named destination.
117 .TP 5
118 \fB\-x \fIdestination\fR[\fB/\fIinstance\fR]
119 Removes the options for the named destination and instance, if specified.
120 If the named instance does not exist then this does nothing.
121 Destinations can only be removed using the
122 .BR lpadmin (8)
123 command.
124 .SH FILES
125 \fI~/.cups/lpoptions\fR - user defaults and instances created by non-root users.
126 .br
127 \fI/etc/cups/lpoptions\fR - system-wide defaults and instances created by the root user.
128 .SH CONFORMING TO
129 The \fBlpoptions\fR command is unique to CUPS.
130 .SH SEE ALSO
131 .BR cancel (1),
132 .BR lp (1),
133 .BR lpadmin (8),
134 .BR lpr (1),
135 .BR lprm (1),
136 CUPS Online Help (http://localhost:631/help)
137 .SH COPYRIGHT
138 Copyright \[co] 2007-2014 by Apple Inc.
139 .\"
140 .\" End of "$Id$".
141 .\"