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

Print this page

6282 ONBLD man pages not pbchk clean
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>

   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 "28 August 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 .LP
  32 .SH DESCRIPTION
  33 .IX "OS-Net build tools" "onu" "" "\fBonu\fP"
  34 .LP
  35 .I onu 
  36 is a replacement for
  37 .I bfu
  38 used to update a system with the latest set of IPS packages for the ON
  39 (OS/Net) consolidation of Solaris, using beadm(1M) to create a new Boot
  40 Environment (BE) and pkg(1) to update the image.
  41 .SH OPTIONS
  42 .LP
  43 The following global options are supported:
  44 .TP 4
  45 .B \-c <consolidation>
  46 Specifies the consolidation being installed via 
  47 .IR onu ,
  48 used to locate the publisher from which that consolidation is currently
  49 installed.  This is almost always "osnet".
  50 .TP 4
  51 .B \-d <dir>
  52 Specifies that <dir> contains the repo.redist sub-directory;
  53 .I onu

  75 .TP 4
  76 .B \-t <beName>
  77 Specifies the target BE name.  This argument is required; there
  78 is no default value.
  79 .TP 4
  80 .B \-Z
  81 Do not update any installed zones.
  82 .LP
  83 The second form of onu takes the following option:
  84 .TP 4
  85 .B \-r
  86 In the current BE configure the requested publisher appropriately, without
  87 updating.
  88 .SH EXIT STATUS
  89 .LP
  90 The following exit values are returned:
  91 .TP 4
  92 .B 0
  93 The command completed successfully.
  94 No errors or warnings were reported.
  95 .LP
  96 .TP 4
  97 .B 1
  98 Incorrect usage.
  99 .LP
 100 .TP 4
 101 .B 2
 102 One of the commands used by the script failed.
 103 .SH NOTES
 104 .LP
 105 Former users of bfu should note the following ways in which onu behaves
 106 differently from bfu.  First, as noted above, onu creates a new BE, rather
 107 than updating an existing BE in-place.  Second, onu will not install packages
 108 that are older than what is already installed in the source BE.  Third,
 109 conflicts in system configuration files are automatically resolved according
 110 to the files' "preserve" attribute, as described in pkg(5).
 111 .LP
 112 If the
 113 .B -d
 114 option is given to specify a repository directory, the new
 115 publishers will not be available in the new BE. This can prevent correct
 116 zone installs or cause issues with installing additional packages
 117 sourced from the ON repositories. In both cases, the \fB-r\fR option
 118 can be used in the new BE to re-enable the publishers. See
 119 \fBEXAMPLES\fR.
 120 .LP
 121 Use of
 122 .I onu
 123 will prevent use of zone attach for ipkg-brand zones in the new BE,
 124 since the
 125 .B entire
 126 incorporation is removed.
 127 .LP
 128 By default,
 129 .I onu
 130 will attempt to update any ipkg-brand installed zones on the system; the
 131 .B -Z
 132 option may be used to disable this behavior.
 133 .SH EXAMPLES
 134 .LP
 135 \fBExample 1\fR Installing latest ON nightly build
 136 .LP
 137 .SP
 138 .IN +2
 139 .NF
 140 # onu -t new-nightly-be
 141 .FI
 142 .IN -2
 143 .SP
 144 .LP
 145 \fBExample 2\fR Installing an ON build from a directory
 146 .LP
 147 .SP
 148 .IN +2
 149 .NF
 150 # onu -d /path/to/my/ws/packages/`uname -p`/nightly -t new-nightly-be
 151 .FI
 152 .IN -2
 153 .SP
 154 .LP
 155 \fBExample 3\fR Installing additional packages in the new BE
 156 .LP
 157 .SP
 158 .IN +2
 159 .NF
 160 # onu -d /path/to/my/ws/packages/`uname -p`/nightly -t new-nightly-be
 161 .br
 162 # reboot
 163 .br
 164 # onu -r -d /path/to/my/ws/packages/`uname -p`/nightly
 165 .br
 166 # pkg install netcat
 167 .br
 168 #
 169 .FI
 170 .IN -2
 171 .SP
 172 .SH ENVIRONMENT
 173 .LP
 174 ONURI
 175 .IP
 176 If the -u option is not provided, and this variable is set, it will be used
 177 as the origin URI for the publisher packaging repository.  If -u is not
 178 provided and this variable is not set, http://ipkg.sfbay/on-nightly will
 179 be used.
 180 .LP
 181 ONPUB
 182 .IP
 183 If the -U option is not provided, and this variable is set, it will be
 184 used as the publisher name for the packaging repository.  If -U is not
 185 provided and this variable is not set, on-nightly will be used.
 186 .LP
 187 .SH SEE ALSO
 188 .BR beadm "(1M), "
 189 .BR pkg "(1), "
 190 .BR pkg "(5) "

   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

  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) "