usr/src/tools/scripts/onu.1onbld

   1 .\" " CDDL HEADER START
   2 .\" "
   3 .\" " The contents of this file are subject to the terms of the
   4 .\" " Common Development and Distribution License (the "License").
   5 .\" " You may not use this file except in compliance with the License.
   6 .\" "
   7 .\" " You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   8 .\" " or http://www.opensolaris.org/os/licensing.
   9 .\" " See the License for the specific language governing permissions
  10 .\" " and limitations under the License.
  11 .\" "
  12 .\" " When distributing Covered Code, include this CDDL HEADER in each
  13 .\" " file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  14 .\" " If applicable, add the following below this CDDL HEADER, with the
  15 .\" " fields enclosed by brackets "[]" replaced with your own identifying
  16 .\" " information: Portions Copyright [yyyy] [name of copyright owner]
  17 .\" "
  18 .\" " CDDL HEADER END
  19 .\" "
  20 .\" "Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
  21 .\" "Copyright 2010, Richard Lowe
  22 .\" "
  23 .TH ONU 1ONBLD "Aug 28, 2010"
  24 .SH NAME
  25 .I onu
  26 \- OS/Net Update
  27 .SH SYNOPSIS
  28 \fBonu [opts] [-s <beName>] -t <beName>\fP
  29 .br
  30 \fBonu [opts] -r\fP
  31 .SH DESCRIPTION
  32 .LP
  33 .I onu
  34 is a replacement for
  35 .I bfu
  36 used to update a system with the latest set of IPS packages for the ON
  37 (OS/Net) consolidation of Solaris, using beadm(1M) to create a new Boot
  38 Environment (BE) and pkg(1) to update the image.
  39 .SH OPTIONS
  40 .LP
  41 The following global options are supported:
  42 .TP 4
  43 .B \-c <consolidation>
  44 Specifies the consolidation being installed via
  45 .IR onu ,
  46 used to locate the publisher from which that consolidation is currently
  47 installed.  This is almost always "osnet".
  48 .TP 4
  49 .B \-d <dir>
  50 Specifies that <dir> contains the repo.redist sub-directory;
  51 .I onu
  52 will run a depot using this packaging repository.
  53 Note that -d ignores -u and -U as well
  54 as the environment variables used by those options.
  55 .TP 4
  56 .B \-u <URI>
  57 Specifies that <URI> should be used as the origin URI for the publisher
  58 packaging repository.  See \fBONURI\fP below for default values.
  59 .TP 4
  60 .B \-U <publisher>
  61 Specifies that <publisher> should be used as the publisher name for
  62 the packaging repository.  See \fBONPUB\fP below for default values.
  63 .TP 4
  64 .B \-v
  65 Verbose mode.
  66 .LP
  67 The first form of onu creates a new BE and then updates it, and takes
  68 the following options:
  69 .TP 4
  70 .B \-s <beName>
  71 Specifies that <beName> should be used as the source Boot Environment to
  72 clone.  The default is the active BE.
  73 .TP 4
  74 .B \-t <beName>
  75 Specifies the target BE name.  This argument is required; there
  76 is no default value.
  77 .TP 4
  78 .B \-Z
  79 Do not update any installed zones.
  80 .LP
  81 The second form of onu takes the following option:
  82 .TP 4
  83 .B \-r
  84 In the current BE configure the requested publisher appropriately, without
  85 updating.
  86 .SH EXIT STATUS
  87 .LP
  88 The following exit values are returned:
  89 .TP 4
  90 .B 0
  91 The command completed successfully.
  92 No errors or warnings were reported.
  93 .TP 4
  94 .B 1
  95 Incorrect usage.
  96 .TP 4
  97 .B 2
  98 One of the commands used by the script failed.
  99 .SH NOTES
 100 .LP
 101 Former users of bfu should note the following ways in which onu behaves
 102 differently from bfu.  First, as noted above, onu creates a new BE, rather
 103 than updating an existing BE in-place.  Second, onu will not install packages
 104 that are older than what is already installed in the source BE.  Third,
 105 conflicts in system configuration files are automatically resolved according
 106 to the files' "preserve" attribute, as described in pkg(5).
 107 .LP
 108 If the
 109 .B -d
 110 option is given to specify a repository directory, the new
 111 publishers will not be available in the new BE. This can prevent correct
 112 zone installs or cause issues with installing additional packages
 113 sourced from the ON repositories. In both cases, the \fB-r\fR option
 114 can be used in the new BE to re-enable the publishers. See
 115 \fBEXAMPLES\fR.
 116 .LP
 117 Use of
 118 .I onu
 119 will prevent use of zone attach for ipkg-brand zones in the new BE,
 120 since the
 121 .B entire
 122 incorporation is removed.
 123 .LP
 124 By default,
 125 .I onu
 126 will attempt to update any ipkg-brand installed zones on the system; the
 127 .B -Z
 128 option may be used to disable this behavior.
 129 .SH EXAMPLES
 130 .LP
 131 \fBExample 1\fR Installing latest ON nightly build
 132 .LP
 133 # onu -t new-nightly-be
 134 .LP
 135 \fBExample 2\fR Installing an ON build from a directory
 136 .LP
 137 # onu -d /path/to/my/ws/packages/`uname -p`/nightly -t new-nightly-be
 138 .LP
 139 \fBExample 3\fR Installing additional packages in the new BE
 140 .LP
 141 # onu -d /path/to/my/ws/packages/`uname -p`/nightly -t new-nightly-be
 142 .br
 143 # reboot
 144 .br
 145 # onu -r -d /path/to/my/ws/packages/`uname -p`/nightly
 146 .br
 147 # pkg install netcat
 148 .br
 149 #
 150 .SH ENVIRONMENT
 151 .LP
 152 ONURI
 153 .IP
 154 If the -u option is not provided, and this variable is set, it will be used
 155 as the origin URI for the publisher packaging repository.  If -u is not
 156 provided and this variable is not set, http://ipkg.sfbay/on-nightly will
 157 be used.
 158 .LP
 159 ONPUB
 160 .IP
 161 If the -U option is not provided, and this variable is set, it will be
 162 used as the publisher name for the packaging repository.  If -U is not
 163 provided and this variable is not set, on-nightly will be used.
 164 .SH SEE ALSO
 165 .BR beadm "(1M), "
 166 .BR pkg "(1), "
 167 .BR pkg "(5) "