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