usr/src/man/man1m/lpset.1m

   1 '\" te
   2 .\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH LPSET 1M "May 23, 2003"
   7 .SH NAME
   8 lpset \- set printing configuration in /etc/printers.conf or other supported
   9 databases
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBlpset\fR [\fB-n\fR system | nisplus | fnsldap] [\fB-x\fR]
  14      [ [\fB-D\fR binddn] [\fB-w\fR passwd] [\fB-h\fR ldaphost]]
  15      [\fB-a\fR \fIkey=value\fR] [\fB-d\fR \fIkey\fR] \fIdestination\fR
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBlpset\fR utility sets printing configuration information in  the system
  22 configuration databases. Use \fBlpset\fR to create and update printing
  23 configuration in \fB/etc/printers.conf\fR, or \fBprinters.org_dir\fR (NIS+).
  24 See \fBnsswitch.conf\fR(4) and \fBprinters.conf\fR(4).
  25 .sp
  26 .LP
  27 Only a superuser or a member of Group 14 may execute \fBlpset\fR.
  28 .SH OPTIONS
  29 .sp
  30 .LP
  31 The following options are supported:
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fB-n\fR \fBsystem\fR|\fBnisplus\fR|\fBldap\fR\fR
  36 .ad
  37 .RS 26n
  38 Create or update the configuration information  for the \fIdestination\fR entry
  39 in \fB/etc/printers.conf\fR, \fBprinters.org_dir\fR (NIS+), or LDAP printer
  40 contexts. \fBsystem\fR specifies that the information is created or updated in
  41 \fB/etc/printers.conf\fR. \fBnisplus\fR specifies that the information is
  42 created or updated in the \fBprinters.org_dir\fR NIS+ table. \fBldap\fR
  43 specifies that the information is written to an LDAP server. See .
  44 .sp
  45 If  \fB-n\fR is not specified, \fBsystem\fR is the default.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fB-x\fR\fR
  52 .ad
  53 .RS 26n
  54 Remove all configuration for  the \fIdestination\fR entry from the database
  55 specified by the \fB-n\fR option.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fB-a\fR \fIkey\fR\fB=\fR\fIvalue\fR\fR
  62 .ad
  63 .RS 26n
  64 Configure the specified \fIkey\fR\fB=\fR\fIvalue\fR pair for the
  65 \fIdestination\fR. See \fBprinters.conf\fR(4) for information regarding the
  66 specification of \fIkey\fR\fB=\fR\fIvalue\fR pairs.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fB-d\fR \fIkey\fR\fR
  73 .ad
  74 .RS 26n
  75 Delete the configuration option specified by \fIkey\fR for the
  76 \fIdestination\fR entry. See \fBprinters.conf\fR(4) for information regarding
  77 the specification of \fIkey\fR and  \fIkey\fR\fB=\fR\fIvalue\fR pairs.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB-D\fR \fBbinddn\fR\fR
  84 .ad
  85 .RS 26n
  86 Use the distinguished name (DN) \fBbinddn\fR to bind to the LDAP directory
  87 server.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fB-w\fR \fBpasswd\fR\fR
  94 .ad
  95 .RS 26n
  96 Use \fBpasswd\fR as the password for authentication to the LDAP directory
  97 server.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fB-h\fR \fBldaphost\fR\fR
 104 .ad
 105 .RS 26n
 106 Specify an alternate host on which the LDAP server is running. This option is
 107 only used when \fBldap\fR is specified as the naming service. If this option is
 108 not specified, the default is the current host system.
 109 .RE
 110
 111 .SH OPERANDS
 112 .sp
 113 .LP
 114 The following operand is supported:
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fIdestination\fR\fR
 119 .ad
 120 .RS 15n
 121 Specifies the entry in  \fB/etc/printers.conf\fR, \fBprinters.org_dir\fR, or
 122 LDAP, in which to create or modify information. \fIdestination\fR names a
 123 printer of class of printers. See  \fBlpadmin\fR(1M). Each entry in
 124 \fBprinters.conf\fR describes one destination. Specify \fIdestination\fR using
 125 atomic names. POSIX-style destination names are not acceptable. See
 126 \fBprinters.conf\fR(4) for information regarding the naming conventions for
 127 atomic names and \fBstandards\fR(5) for information regarding POSIX.
 128 .RE
 129
 130 .SH EXAMPLES
 131 .LP
 132 \fBExample 1 \fRRemoving All Existing Printing Configuration Information
 133 .sp
 134 .LP
 135 The following example removes all existing printing configuration information
 136 for destination \fBdogs\fR from \fB/etc/printers.conf\fR:
 137
 138 .sp
 139 .in +2
 140 .nf
 141 example% \fBlpset -x dogs\fR
 142 .fi
 143 .in -2
 144 .sp
 145
 146 .LP
 147 \fBExample 2 \fRSetting a \fBkey=value\fR Pair
 148 .sp
 149 .LP
 150 The following example sets the \fBuser-equivalence\fR \fB=true\fR
 151 \fIkey\fR\fB=\fR\fIvalue\fR pair for destination  \fBtabloid\fR in the NIS+
 152 context:
 153
 154 .sp
 155 .in +2
 156 .nf
 157 example% \fBlpset -n nisplus -a user-equivalence=true tabloid\fR
 158 .fi
 159 .in -2
 160 .sp
 161
 162 .LP
 163 \fBExample 3 \fRSetting a \fBkey=value\fR Pair in LDAP
 164 .sp
 165 .in +2
 166 .nf
 167 example% \fBlpset -n ldap -h ldapl.xyz.com -D "cn=Directory Manager" \e
 168    -w passwd -a key1=value1 printer1\fR
 169 .fi
 170 .in -2
 171 .sp
 172
 173 .SH EXIT STATUS
 174 .sp
 175 .LP
 176 The following exit values are returned:
 177 .sp
 178 .ne 2
 179 .na
 180 \fB\fB0\fR\fR
 181 .ad
 182 .RS 12n
 183 Successful completion.
 184 .RE
 185
 186 .sp
 187 .ne 2
 188 .na
 189 \fBnon-zero\fR
 190 .ad
 191 .RS 12n
 192 An error occurred.
 193 .RE
 194
 195 .SH FILES
 196 .sp
 197 .ne 2
 198 .na
 199 \fB\fB/etc/printers.conf\fR\fR
 200 .ad
 201 .RS 26n
 202 System configuration database.
 203 .RE
 204
 205 .sp
 206 .ne 2
 207 .na
 208 \fB\fBprinter.org_dir\fR (NIS+)\fR
 209 .ad
 210 .RS 26n
 211 \fBNIS+\fR version of \fB/etc/printers.conf\fR.
 212 .RE
 213
 214 .SH ATTRIBUTES
 215 .sp
 216 .LP
 217 See \fBattributes\fR(5) for descriptions of the following attributes:
 218 .sp
 219
 220 .sp
 221 .TS
 222 box;
 223 c | c
 224 l | l .
 225 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 226 _
 227 Stability Level Stable
 228 .TE
 229
 230 .SH SEE ALSO
 231 .sp
 232 .LP
 233 \fBldap\fR(1), \fBlp\fR(1), \fBlpc\fR(1B), \fBlpq\fR(1B), \fBlpr\fR(1B),
 234 \fBlpstat\fR(1), \fBldapclient\fR(1M), \fBlpadmin\fR(1M), \fBlpget\fR(1M),
 235 \fBnsswitch.conf\fR(4), \fBprinters\fR(4), \fBprinters.conf\fR(4),
 236 \fBattributes\fR(5), \fBstandards\fR(5)
 237 .sp
 238 .LP
 239 \fI\fR
 240 .SH NOTES
 241 .sp
 242 .LP
 243 If the \fBldap\fR database is used, the printer administrator should be mindful
 244 of the following when updating printer information.
 245 .RS +4
 246 .TP
 247 1.
 248 Because the domain information for the printer being updated is extracted
 249 from the \fBldapclient\fR(1M) configuration, the LDAP server being updated must
 250 host the same domain that is used by the current \fBldapclient\fR(1M) server.
 251 .RE
 252 .RS +4
 253 .TP
 254 2.
 255 If the LDAP server being updated is a replica LDAP server, the updates will
 256 be referred to the master LDAP server and completed there. The updates might be
 257 out of sync and not appear immediatedly, as the replica server may not have
 258 been updated by the master server.  For example, a printer that you deleted by
 259 using \fBlpset\fR may still appear in the printer list you display with
 260 \fBlpget\fR until the replica is updated from the master. Replica servers vary
 261 as to how often they are updated from the master.  See \fISystem Administration
 262 Guide: Solaris Printing\fR for information on LDAP server replication.
 263 .RE
 264 .RS +4
 265 .TP
 266 3.
 267 Although users can use the LDAP command line utilities \fBldapadd\fR(1) and
 268 \fBldapmodify\fR(1) to update printer entries in the directory, the preferred
 269 method is to use \fBlpset\fR. Otherwise, if the \fBldapadd\fR and
 270 \fBldapmodify\fR utilities are used, the administrator must ensure that the
 271 \fBprinter-name\fR attribute value is unique within the \fBou=printers\fR
 272 container on the LDAP server. If the value is not unique, the result of
 273 modifications done using \fBlpset\fR or the Solaris Print Manager,
 274 \fBprintmgr\fR(1M) may be unpredictable.
 275 .RE