diff options
Diffstat (limited to 'installiso.8')
-rw-r--r-- | installiso.8 | 140 |
1 files changed, 140 insertions, 0 deletions
diff --git a/installiso.8 b/installiso.8 new file mode 100644 index 0000000..c2348d5 --- /dev/null +++ b/installiso.8 @@ -0,0 +1,140 @@ +.\" Copyright (c) 2021 Stefan Kreutz <mail@skreutz.com> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.Dd $Mdocdate: July 24 2021 $ +.Dt INSTALLISO 8 +.Os +.Sh NAME +.Nm installiso +.Nd Customize OpenBSD installation images +.Sh SYNOPSIS +.Nm installiso +.Op Fl v +.Ar command +.Op Ar arg ... +.Sh DESCRIPTION +The +.Nm +utility facilitates creating custom ISO 9660 installation images for the +unattended installation of +.Ox . +.Pp +The common options are as follows: +.Bl -tag -width Ds +.It Fl v +Verbose mode. +Causes +.Nm +to print informative messages. +Multiple +.Fl v +options increase the verbosity. +The maximum is 2. +By default, +.Nm +is quiet. +.El +.Pp +The commands are as follows: +.Bl -tag -width Ds +.It Cm fetch Oo Fl f Oc Oo Fl m Ar mirror Oc Oo Fl r Ar release Oc Oo Fl p Ar key Oc Oo Fl o Ar output Oc +Download and verify an official ISO 9660 installation image. +.Bl -tag -width 15n +.It Fl f +Force overwriting existing files. +By default, +.Cm fetch +will not overwrite existing files. +.It Fl m Ar mirror +The HTTP(S) +.Ox +.Ar mirror +to use. +Defaults to the mirror specified by +.Xr installurl 5 +or else +.Lk https://cdn.openbsd.org/pub/OpenBSD/ . +.It Fl r Ar release +The +.Ox +.Ar release . +Defaults to the latest development snapshot of -current. +.It Fl p Ar key +The public +.Xr signify 1 +.Ar key +used to verify the downloaded installation image. +Defaults to the key +.Pa /etc/signify/openbsd-*-base.pub +corresponding to the downloaded release. +.El +.It Cm patch Oo Fl f Oc Oo Fl i Ar install_conf Oc Oo Fl u Ar upgrade_conf Oc Oo Fl s Ar site_dir Oc Ar input Ar output +Patch an ISO 9660 installation image. +.Bl -tag -width 15n +.It Fl f +Force overwriting existing files. +By default, +.Cm patch +will not overwrite existing files. +.It Fl i Ar install_conf +Insert an +.Xr autoinstall 8 +response file for unattended installation. +.It Fl u Ar upgrade_conf +Insert an +.Xr autoinstall 8 +response file for unattended upgrade. +.It Fl s Ar site +Package and insert the directory +.Ar site +as a site-specific file set. +.It Ar input +The +.Ar input +installation image file. +.It Ar output +The +.Ar output +installation image file. +.El +.El +.Sh EXIT STATUS +.Ex -std installiso +.Sh EXAMPLES +Fetch the latest development snapshot: +.Bd -literal -offset indent +$ installiso -v fetch +.Ed +.Pp +Fetch a specific release: +.Bd -literal -offset indent +$ installiso -v fetch -r 6.9 +.Ed +.Pp +Create a custom image for unattended installation: +.Bd -literal -offset indent +$ doas installiso -v patch -i install.conf install69.iso custom.iso +.Ed +.Sh SEE ALSO +.Xr autoinstall 8 , +.Xr mkhybrid 8 , +.Xr rdsetroot 8 , +.Xr sysupgrade 8 , +.Xr vnconfig 8 +.Sh AUTHORS +.An Stefan Kreutz Aq Mt mail@skreutz.com +.Sh BUGS +The +.Nm +utility is currently limited to the amd64 architecture because it wasn't tested +on any other architecture. |