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

   1 '\" te
   2 .\" Copyright (c) 2017 Peter Tribble.
   3 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
   4 .\" 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   5 .\"  See the License for the specific language governing permissions and limitations under the License. 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
   6 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH PKGADM 1M "Mar 2, 2017"
   8 .SH NAME
   9 pkgadm \- manage packaging system
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBpkgadm dbstatus\fR [\fB-R\fR \fIrootpath\fR]
  14 .fi
  15
  16 .LP
  17 .nf
  18 \fBpkgadm sync\fR [\fB-R\fR \fIrootpath\fR] [\fB-q\fR]
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBpkgadm\fR \fB-V\fR
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBpkgadm\fR \fB-?\fR
  29 .fi
  30
  31 .SH DESCRIPTION
  32 .LP
  33 The \fBpkgadm\fR utility is used for managing the packaging
  34 system. It has several subcommands that perform various operations relating to
  35 packaging.
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fBsync\fR\fR
  40 .ad
  41 .sp .6
  42 .RS 4n
  43 Writes the contents file and rolls the contents log file. With use of the
  44 \fB-q\fR option, forces the contents file server to quit.
  45 .RE
  46
  47 .SS "Internal Install Database"
  48 .LP
  49 The Solaris operating system relies upon enhanced System V revision 4 (SVr4)
  50 packages as the basis for its software installation and revision management.
  51 The package maintenance software stores information about installed packages in
  52 an internal database. The \fBpkgadm\fR subcommand \fBdbstatus\fR is used to
  53 determine how the package internal database is implemented. The \fBdbstatus\fR
  54 command returns a string that indicates the type of internal database in use.
  55 In the current implementation, the \fBdbstatus\fR command always returns the
  56 string \fBtext\fR, which indicates that the \fBcontents\fR(4) package database
  57 is in use. Future releases of Solaris might supply alternative database
  58 implementations.
  59 .SH OPTIONS
  60 .LP
  61 The following options are supported:
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fB-q\fR\fR
  66 .ad
  67 .sp .6
  68 .RS 4n
  69 (Applies to \fBsync\fR subcommand.) Shuts down the contents file cache daemon.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB-R\fR \fIrootpath\fR\fR
  76 .ad
  77 .sp .6
  78 .RS 4n
  79 Defines the full name of a directory to use as the root (\fB/\fR) path.
  80 .LP
  81 Note -
  82 .sp
  83 .RS 2
  84 The root file system of any non-global zones must not be referenced with the
  85 \fB-R\fR option. Doing so might damage the global zone's file system, might
  86 compromise the security of the global zone, and might damage the non-global
  87 zone's file system. See \fBzones\fR(5).
  88 .RE
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-V\fR\fR
  95 .ad
  96 .sp .6
  97 .RS 4n
  98 Print version associated with packaging tools.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fB-?\fR\fR
 105 .ad
 106 .sp .6
 107 .RS 4n
 108 Print help message.
 109 .RE
 110
 111 .SH EXAMPLES
 112 .LP
 113 \fBExample 1 \fRSynchronizing the contents file
 114 .sp
 115 .LP
 116 The following example forces any pending changes to the contents(4) file to be flushed and the pkgserv daemon to shut down.
 117
 118 .sp
 119 .in +2
 120 .nf
 121 example% pkgadm sync -q
 122 .fi
 123 .in -2
 124 .sp
 125
 126 .SH EXIT STATUS
 127 .ne 2
 128 .na
 129 \fB\fB0\fR\fR
 130 .ad
 131 .sp .6
 132 .RS 4n
 133 successful completion
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBnon-zero\fR\fR
 140 .ad
 141 .sp .6
 142 .RS 4n
 143 fatal error
 144 .RE
 145
 146 .SH ATTRIBUTES
 147 .LP
 148 See \fBattributes\fR(5) for descriptions of the following attributes:
 149 .sp
 150
 151 .sp
 152 .TS
 153 box;
 154 c | c
 155 l | l .
 156 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 157 _
 158 Interface Stability     Evolving
 159 .TE
 160
 161 .SH SEE ALSO
 162 .LP
 163 \fBpkginfo\fR(1), \fBpkgmk\fR(1), \fBpkgparam\fR(1), \fBpkgproto\fR(1),
 164 \fBpkgtrans\fR(1), \fBsvcs\fR(1), \fBinstallf\fR(1M), \fBpkgadd\fR(1M),
 165 \fBpkgask\fR(1M), \fBpkgrm\fR(1M), \fBremovef\fR(1M), \fBsvcadm\fR(1M),
 166 \fBadmin\fR(4), \fBcontents\fR(4), \fBexec_attr\fR(4), \fBpkginfo\fR(4),
 167 \fBattributes\fR(5), \fBrbac\fR(5), \fBsmf\fR(5)
 168 .sp
 169 .LP
 170 \fI\fR
 171 .SH NOTES
 172 .LP
 173 The service for \fBpkgadm\fR is managed by the service management facility,
 174 \fBsmf\fR(5), under the service identifier:
 175 .sp
 176 .in +2
 177 .nf
 178 svc:/system/pkgserv
 179 .fi
 180 .in -2
 181 .sp
 182
 183 .sp
 184 .LP
 185 Administrative actions on this service, such as enabling, disabling, or
 186 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
 187 status can be queried using the \fBsvcs\fR(1) command.