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

   1 '\" te
   2 .\"  Copyright (c) 2007 by 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 PPDMGR 1M "Mar 9, 2007"
   7 .SH NAME
   8 ppdmgr \- utility for managing PPD files
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBppdmgr\fR \fB-a\fR \fIppd_filename_path\fR [\fB-L\fR \fIlabel\fR] [\fB-R\fR \fIppd_repository_name\fR] [\fB-w\fR]
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBppdmgr\fR \fB-r\fR [\fB-L\fR \fIlabel\fR] [\fB-R\fR \fIppd_repository_name\fR]
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBppdmgr\fR \fB-u\fR [\fB-L\fR \fIlabel\fR] [\fB-R\fR \fIppd_repository_name\fR]
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The PPD File Manager adds PPD files to the print system's PPD file
  29 repositories. When changes in the PPD file repositories are made by the
  30 utility, they are reflected in the Solaris Print Manager (see
  31 \fBprintmgr\fR(1M)) GUI printer driver field when adding or modifying local
  32 attached or network attached printers.
  33 .sp
  34 .LP
  35 Multiple PPD file repositories may be available. PPD files that are supplied
  36 with the system are available in the "\fBsystem\fR" repository. PPD files that
  37 are supplied by third party vendors may be available in the "\fBvendor\fR"
  38 repository. PPD files that are supplied by system administrators may be
  39 available in the "\fBadmin\fR" repository, and PPD files that are added using
  40 this utility are available in the "user" repository. When this utility is used
  41 to update or rebuild printer information reflected in the \fBprintmgr\fR(1M),
  42 the special reserved repository name "\fBall\fR" can be used to specify all of
  43 the available PPD file repositories.
  44 .sp
  45 .LP
  46 PPD files are grouped under a user-provided "label" within the print system's
  47 PPD file repository to allow easier selection of a printer driver through the
  48 \fBprintmgr\fR GUI. The special reserved label name "\fBall\fR" can be used to
  49 specify all of the available labels in a PPD file repository. The results are
  50 undefined if a label name contains characters that are not in the portable
  51 filename character set or if a label name starts with a hyphen (-). A label
  52 name may not contain a semi-colon (:).
  53 .SH OPTIONS
  54 .sp
  55 .LP
  56 The following subcommand are supported:
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fB-a\fR \fIppd_file_path\fR\fR
  61 .ad
  62 .sp .6
  63 .RS 4n
  64 Adds a copy of \fIppd_file_path\fR to the system under the specified label in
  65 the specified repository, where \fIppd_file_path\fR is the full path and file
  66 name to the PPD file. The utility accepts a valid PPD file with either a
  67 \fB\&.ppd\fR or \fB\&.ppd.gz\fR (gzipped) extension.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fB-L\fR \fIlabel\fR\fR
  74 .ad
  75 .sp .6
  76 .RS 4n
  77 Specifies a label to group PPD files under. When specified with the \fB-a\fR
  78 option, the default label is "\fBuser\fR". When specified with the \fB-r\fR or
  79 \fB-u\fR option, the default label is "\fBall\fR". The following are reserved
  80 labels:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBcaches\fR\fR
  85 .ad
  86 .RS 16n
  87 may never be specified
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBppdcache\fR\fR
  94 .ad
  95 .RS 16n
  96 may never be specified
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBmanufaliases\fR\fR
 103 .ad
 104 .RS 16n
 105 may never be specified
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBall\fR\fR
 112 .ad
 113 .RS 16n
 114 applies the specified action to all labels in a repository, and may only be
 115 specified with the \fB-r\fR or \fB-u\fR option.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBSUNW*\fR\fR
 122 .ad
 123 .RS 16n
 124 anything starting with \fBSUNW\fR is reserved and should not be specified with
 125 the \fB-a\fR option.
 126 .RE
 127
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fB-R\fR \fIrepository_name\fR\fR
 134 .ad
 135 .sp .6
 136 .RS 4n
 137 Specifies the name of a PPD file repository representing one of the PPD file
 138 installation locations. Possible repository names include: "\fBuser\fR",
 139 "\fBadmin\fR", "\fBvendor\fR", "\fBsystem\fR", and "\fBall\fR".
 140 .sp
 141 The repository name "\fBall\fR" signifies all of the possible repository names.
 142 The default repository name is "\fBuser\fR". Only the "\fBuser\fR" or
 143 "\fBadmin\fR" repository may be specified with the \fB-a\fR option.
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fB-r\fR\fR
 150 .ad
 151 .sp .6
 152 .RS 4n
 153 Rebuilds the cache information for the specified label in the specified
 154 repository.
 155 .RE
 156
 157 .sp
 158 .ne 2
 159 .na
 160 \fB\fB-u\fR\fR
 161 .ad
 162 .sp .6
 163 .RS 4n
 164 Updates the cache information for the specified label in the specified
 165 repository.
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fB\fB-w\fR\fR
 172 .ad
 173 .sp .6
 174 .RS 4n
 175 Write the full path of the added PPD file. This option is only valid with the
 176 \fB-a\fR option. Otherwise, this option is ignored.
 177 .RE
 178
 179 .SH EXAMPLES
 180 .LP
 181 \fBExample 1 \fRAdding a copy of a PPD file to the repository
 182 .sp
 183 .LP
 184 The following commands add a copy of a PPD file to the "\fBuser\fR" repository
 185 under the "\fBuser\fR" label:
 186
 187 .sp
 188 .in +2
 189 .nf
 190 # ppdmgr -a /net/somesystem/ppdfiles/ppdfile.ppd
 191 .fi
 192 .in -2
 193 .sp
 194
 195 .sp
 196 .LP
 197 or
 198
 199 .sp
 200 .in +2
 201 .nf
 202 # ppdmgr -a /net/somesystem/ppdfiles/ppdfile.ppd -L user
 203 .fi
 204 .in -2
 205 .sp
 206
 207 .sp
 208 .LP
 209 The following command adds a copy of a PPD file to the "\fBuser\fR" repository
 210 under the "\fBPhoto\fR" label and write the full path of the added copy to
 211 standard output:
 212
 213 .sp
 214 .in +2
 215 .nf
 216 # ppdmgr -a /net/somesystem/ppdfiles/ppdfile.ppd -L "Photo" -w
 217 .fi
 218 .in -2
 219 .sp
 220
 221 .LP
 222 \fBExample 2 \fRUpdating the cache for the PPD files
 223 .sp
 224 .LP
 225 The following commands update the cache for the PPD files under the "\fBall\fR"
 226 labels in the "\fBuser\fR" repository:
 227
 228 .sp
 229 .in +2
 230 .nf
 231  # ppdmgr -u
 232 .fi
 233 .in -2
 234 .sp
 235
 236 .sp
 237 .LP
 238 or
 239
 240 .sp
 241 .in +2
 242 .nf
 243  # ppdmgr -u -R user -L all
 244 .fi
 245 .in -2
 246 .sp
 247
 248 .sp
 249 .LP
 250 The following command updates the cache for the PPD files under the "photo"
 251 label in the "\fBuser\fR" repository:
 252
 253 .sp
 254 .in +2
 255 .nf
 256  # ppdmgr -u -R user -L Photo
 257 .fi
 258 .in -2
 259 .sp
 260
 261 .LP
 262 \fBExample 3 \fRRebuilding the cache for the PPD files
 263 .sp
 264 .LP
 265 The following command rebuilds the cache for the PPD files under the "Photo"
 266 label in the "\fBuser\fR" repository:
 267
 268 .sp
 269 .in +2
 270 .nf
 271 # ppdmgr -r -R user -L Photo
 272 .fi
 273 .in -2
 274 .sp
 275
 276 .SH EXIT STATUS
 277 .sp
 278 .LP
 279 The following exit values are returned:
 280 .sp
 281 .ne 2
 282 .na
 283 \fB\fB0\fR\fR
 284 .ad
 285 .RS 6n
 286 Successful completion.
 287 .RE
 288
 289 .sp
 290 .ne 2
 291 .na
 292 \fB\fB>0\fR\fR
 293 .ad
 294 .RS 6n
 295 An error occurred.
 296 .RE
 297
 298 .SH ATTRIBUTES
 299 .sp
 300 .LP
 301 See \fBattributes\fR(5) for descriptions of the following attributes:
 302 .sp
 303
 304 .sp
 305 .TS
 306 box;
 307 c | c
 308 l | l .
 309 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 310 _
 311 Interface Stability     Committed
 312 .TE
 313
 314 .SH SEE ALSO
 315 .sp
 316 .LP
 317 \fBprintmgr\fR(1M), \fBattributes\fR(5)