1 '\" te
   2 .\"
   3 .\" This file and its contents are supplied under the terms of the
   4 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   5 .\" You may only use this file in accordance with the terms of version
   6 .\" 1.0 of the CDDL.
   7 .\"
   8 .\" A full copy of the text of the CDDL should have accompanied this
   9 .\" source.  A copy of the CDDL is also available via the Internet at
  10 .\" http://www.illumos.org/license/CDDL.
  11 .\"
  12 .\"
  13 .\" Copyright 2013 Nexenta Systems, Inc. All rights reserved.
  14 .\"
  15 .\" Note usage messages in sub-command scripts for this brand:
  16 .\" $SRC/lib/brand/solaris10/zone/
  17 .\"
  18 .TH IPKG 5 "Mar 10, 2013"
  19 .SH NAME
  20 ipkg \- Image Packaging System (IPS) branded zone
  21 .SH DESCRIPTION
  22 
  23 .sp
  24 .LP
  25 The \fBipkg\fR brand allows the branded zones framework
  26 described in \fBbrands\fR(5) to run Solaris 10 programs.
  27 This brand supports only the "whole root", non-global zone
  28 model.
  29 
  30 .sp
  31 .LP
  32 You create a \fBipkg\fR branded zone using the
  33 \fBzonecfg\fR(1M) utility, specifying the property
  34 \fBbrand=ipkg\fR in its configuration.
  35 
  36 .sp
  37 .LP
  38 After configuring a \fBipkg\fR branded zone,
  39 you attach or install it using \fBzoneadm\fR(1M).
  40 
  41 .SH SUB-COMMANDS
  42 
  43 .LP
  44 The \fBipkg\fR brand supports the following
  45 \fBzoneadm\fR(1M) sub-commands:
  46 
  47 .LP
  48 .nf
  49 \fB\fBattach\fR [\fB-a \fIarchive\fR|\fB-d \fIdirectory\fR|\fB-r \fIrecv_type\fR]
  50 .fi
  51 
  52 .sp .6
  53 .RS 4n
  54 The \fBattach\fR subcommand creates a zone from a previously detached
  55 \fBipkg\fR zone image.
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fB-a \fIarchive\fR\fR
  60 .ad
  61 .sp .6
  62 .RS 4n
  63 Specifies an archive name which can be a flar, tar, pax or cpio archive.
  64 .RE
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fB-d \fIdirectory\fR\fR
  69 .ad
  70 .sp .6
  71 .RS 4n
  72 Specifies an existing \fIdirectory\fR where the zone image has
  73 already been created.
  74 .RE
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fB-r \fIrecv_type\fR\fR
  79 .ad
  80 .sp .6
  81 .RS 4n
  82 Specifies the type of archive to be read from standard input.
  83 .RE
  84 .RE
  85 
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBclone\fR \fIsource_zone\fR
  90 .ad
  91 .sp .6
  92 .RS 4n
  93 The \fBclone\fR subcommand creates a zone by making a \fBzfs\fR
  94 clone of an existing \fIsource zone\fR.
  95 .RE
  96 
  97 .LP
  98 .\" This documents the image_install.ksh usage (p2v existing image)
  99 .nf
 100 \fB\fBinstall\fR [\fB-u\fR|\fB-p\fR] [\fB-v\fR|\fB-s\fR] [\fB-a \fIarchive\fR|\fB-d \fIdirectory\fR]
 101 .fi
 102 
 103 .LP
 104 .\" This documents the pkgcreatezone.ksh usage (build a new image)
 105 .nf
 106 \fB\fBinstall\fR [\fB-c \fIcertificate\fR] [\fB-k \fIkey_file\fR] [\fB-P \fIPublisher\fR] [\fB-e \fIextra_pkgs\fR [...]]
 107 .fi
 108 
 109 .sp .6
 110 .RS 4n
 111 The \fBinstall\fR subcommand creates a zone from an archive image
 112 or an existing directory.
 113 
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fB-a \fIarchive\fR\fR
 118 .ad
 119 .sp .6
 120 .RS 4n
 121 Specifies an archive name which can be a flar, tar, pax or cpio archive.
 122 .RE
 123 
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fB-c \fIcertificate\fR\fR
 128 .ad
 129 .sp .6
 130 .RS 4n
 131 Specifies the \fIcertificate\fR to install for the \fIPublisher\fR.
 132 .RE
 133 
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fB-d \fIdirectory\fR\fR
 138 .ad
 139 .sp .6
 140 .RS 4n
 141 Specifies an existing \fIdirectory\fR where the zone image has
 142 already been created. If the \fIdirectory\fR specified is \fB-\fR
 143 then installation into the zone root is skipped, and the \fBinstall\fR
 144 subcommand only modifies the zone root as necessary to run in a zone.
 145 .RE
 146 
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fB-e \fIextra_pkg\fR [...]
 151 .ad
 152 .sp .6
 153 .RS 4n
 154 Specifies an extra package to install in the new zone.
 155 Multiple packages may be specified using multiple
 156 \fB-e \fIextra_pkg\fR options.
 157 .RE
 158 
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fB-P \fIPublisher\fR
 163 .ad
 164 .sp .6
 165 .RS 4n
 166 Specifies the IPS \fIPublisher\fR to configure in the new zone.
 167 .RE
 168 
 169 .sp
 170 .ne 2
 171 .na
 172 \fB\fB-p\fR
 173 .ad
 174 .sp .6
 175 .RS 4n
 176 Preserves the configuration of the new zone.
 177 .RE
 178 
 179 .sp
 180 .ne 2
 181 .na
 182 \fB\fB-s\fR
 183 .ad
 184 .sp .6
 185 .RS 4n
 186 Slient installation.
 187 .RE
 188 
 189 .sp
 190 .ne 2
 191 .na
 192 \fB\fB-u\fR
 193 .ad
 194 .sp .6
 195 .RS 4n
 196 Unconfigures the new zone.
 197 .RE
 198 
 199 .sp
 200 .ne 2
 201 .na
 202 \fB\fB-v\fR
 203 .ad
 204 .sp .6
 205 .RS 4n
 206 Verbose messages.
 207 .RE
 208 
 209 .RE
 210 
 211 .SH SEE ALSO
 212 .LP
 213 \fBcpio\fR(1), \fBpax\fR(1), \fBzfs\fR(1M), \fBzoneadm\fR(1M),
 214 \fBzonecfg\fR(1M),
 215 \fBbrands\fR(5), \fBzones\fR(5)