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 "Feb 25, 2017"
   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 | 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 .LP
  20 The \fBlpset\fR utility sets printing configuration information in  the system
  21 configuration databases. Use \fBlpset\fR to create and update printing
  22 configuration in \fB/etc/printers.conf\fR.
  23 See \fBnsswitch.conf\fR(4) and \fBprinters.conf\fR(4).
  24 .sp
  25 .LP
  26 Only a superuser or a member of Group 14 may execute \fBlpset\fR.
  27 .SH OPTIONS
  28 .LP
  29 The following options are supported:
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fB-n\fR \fBsystem\fR|\fBldap\fR\fR
  34 .ad
  35 .RS 26n
  36 Create or update the configuration information for the \fIdestination\fR entry
  37 in \fB/etc/printers.conf\fR or LDAP printer contexts. \fBsystem\fR specifies
  38 that the information is created or updated in \fB/etc/printers.conf\fR.
  39 \fBldap\fR specifies that the information is written to an LDAP server.
  40 .sp
  41 If  \fB-n\fR is not specified, \fBsystem\fR is the default.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fB-x\fR\fR
  48 .ad
  49 .RS 26n
  50 Remove all configuration for  the \fIdestination\fR entry from the database
  51 specified by the \fB-n\fR option.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fB-a\fR \fIkey\fR\fB=\fR\fIvalue\fR\fR
  58 .ad
  59 .RS 26n
  60 Configure the specified \fIkey\fR\fB=\fR\fIvalue\fR pair for the
  61 \fIdestination\fR. See \fBprinters.conf\fR(4) for information regarding the
  62 specification of \fIkey\fR\fB=\fR\fIvalue\fR pairs.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fB-d\fR \fIkey\fR\fR
  69 .ad
  70 .RS 26n
  71 Delete the configuration option specified by \fIkey\fR for the
  72 \fIdestination\fR entry. See \fBprinters.conf\fR(4) for information regarding
  73 the specification of \fIkey\fR and  \fIkey\fR\fB=\fR\fIvalue\fR pairs.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fB-D\fR \fBbinddn\fR\fR
  80 .ad
  81 .RS 26n
  82 Use the distinguished name (DN) \fBbinddn\fR to bind to the LDAP directory
  83 server.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB-w\fR \fBpasswd\fR\fR
  90 .ad
  91 .RS 26n
  92 Use \fBpasswd\fR as the password for authentication to the LDAP directory
  93 server.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fB-h\fR \fBldaphost\fR\fR
 100 .ad
 101 .RS 26n
 102 Specify an alternate host on which the LDAP server is running. This option is
 103 only used when \fBldap\fR is specified as the naming service. If this option is
 104 not specified, the default is the current host system.
 105 .RE
 106
 107 .SH OPERANDS
 108 .LP
 109 The following operand is supported:
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fIdestination\fR\fR
 114 .ad
 115 .RS 15n
 116 Specifies the entry in  \fB/etc/printers.conf\fR or
 117 LDAP, in which to create or modify information. \fIdestination\fR names a
 118 printer of class of printers. See  \fBlpadmin\fR(1M). Each entry in
 119 \fBprinters.conf\fR describes one destination. Specify \fIdestination\fR using
 120 atomic names. POSIX-style destination names are not acceptable. See
 121 \fBprinters.conf\fR(4) for information regarding the naming conventions for
 122 atomic names and \fBstandards\fR(5) for information regarding POSIX.
 123 .RE
 124
 125 .SH EXAMPLES
 126 .LP
 127 \fBExample 1 \fRRemoving All Existing Printing Configuration Information
 128 .sp
 129 .LP
 130 The following example removes all existing printing configuration information
 131 for destination \fBdogs\fR from \fB/etc/printers.conf\fR:
 132
 133 .sp
 134 .in +2
 135 .nf
 136 example% \fBlpset -x dogs\fR
 137 .fi
 138 .in -2
 139 .sp
 140
 141 .LP
 142 \fBExample 2 \fRSetting a \fBkey=value\fR Pair in LDAP
 143 .sp
 144 .in +2
 145 .nf
 146 example% \fBlpset -n ldap -h ldapl.xyz.com -D "cn=Directory Manager" \e
 147    -w passwd -a key1=value1 printer1\fR
 148 .fi
 149 .in -2
 150 .sp
 151
 152 .SH EXIT STATUS
 153 .LP
 154 The following exit values are returned:
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fB0\fR\fR
 159 .ad
 160 .RS 12n
 161 Successful completion.
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fBnon-zero\fR
 168 .ad
 169 .RS 12n
 170 An error occurred.
 171 .RE
 172
 173 .SH FILES
 174 .ne 2
 175 .na
 176 \fB\fB/etc/printers.conf\fR\fR
 177 .ad
 178 .RS 26n
 179 System configuration database.
 180 .RE
 181
 182 .SH ATTRIBUTES
 183 .LP
 184 See \fBattributes\fR(5) for descriptions of the following attributes:
 185 .sp
 186
 187 .sp
 188 .TS
 189 box;
 190 c | c
 191 l | l .
 192 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 193 _
 194 Stability Level Stable
 195 .TE
 196
 197 .SH SEE ALSO
 198 .LP
 199 \fBldap\fR(1), \fBlp\fR(1), \fBlpc\fR(1B), \fBlpq\fR(1B), \fBlpr\fR(1B),
 200 \fBlpstat\fR(1), \fBldapclient\fR(1M), \fBlpadmin\fR(1M), \fBlpget\fR(1M),
 201 \fBnsswitch.conf\fR(4), \fBprinters\fR(4), \fBprinters.conf\fR(4),
 202 \fBattributes\fR(5), \fBstandards\fR(5)
 203 .sp
 204 .LP
 205 \fI\fR
 206 .SH NOTES
 207 .LP
 208 If the \fBldap\fR database is used, the printer administrator should be mindful
 209 of the following when updating printer information.
 210 .RS +4
 211 .TP
 212 1.
 213 Because the domain information for the printer being updated is extracted
 214 from the \fBldapclient\fR(1M) configuration, the LDAP server being updated must
 215 host the same domain that is used by the current \fBldapclient\fR(1M) server.
 216 .RE
 217 .RS +4
 218 .TP
 219 2.
 220 If the LDAP server being updated is a replica LDAP server, the updates will
 221 be referred to the master LDAP server and completed there. The updates might be
 222 out of sync and not appear immediatedly, as the replica server may not have
 223 been updated by the master server.  For example, a printer that you deleted by
 224 using \fBlpset\fR may still appear in the printer list you display with
 225 \fBlpget\fR until the replica is updated from the master. Replica servers vary
 226 as to how often they are updated from the master.  See \fISystem Administration
 227 Guide: Solaris Printing\fR for information on LDAP server replication.
 228 .RE
 229 .RS +4
 230 .TP
 231 3.
 232 Although users can use the LDAP command line utilities \fBldapadd\fR(1) and
 233 \fBldapmodify\fR(1) to update printer entries in the directory, the preferred
 234 method is to use \fBlpset\fR. Otherwise, if the \fBldapadd\fR and
 235 \fBldapmodify\fR utilities are used, the administrator must ensure that the
 236 \fBprinter-name\fR attribute value is unique within the \fBou=printers\fR
 237 container on the LDAP server. If the value is not unique, the result of
 238 modifications done using \fBlpset\fR or the Solaris Print Manager,
 239 \fBprintmgr\fR(1M) may be unpredictable.
 240 .RE