.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "osinfo-install-script 1"
.TH osinfo-install-script 1 2024-11-03 libosinfo-1.12.0 Libosinfo
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
osinfo\-install\-script \- generate a script for automated installation
.SH SYNOPSIS
.IX Header "SYNOPSIS"
osinfo-install-script [OPTIONS...] MEDIA\-FILE|OS\-ID
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Generate a script suitable for performing an automated installation
of \f(CW\*(C`MEDIA_FILE\*(C'\fR or \f(CW\*(C`OS\-ID\*(C'\fR. \f(CW\*(C`MEDIA_FILE\*(C'\fR should be a path to an
installer or live media (typically an ISO file). \f(CW\*(C`OS\-ID\*(C'\fR should be
a URI identifying the operating system, or its short ID.
.PP
By default a script will be generated for a \f(CW\*(C`JEOS\*(C'\fR style install.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-profile=NAME\fR 8
.IX Item "--profile=NAME"
Choose the installation script profile. Defaults to \f(CW\*(C`jeos\*(C'\fR, but
can also be \f(CW\*(C`desktop\*(C'\fR, or a site specific profile name
.IP \fB\-\-installation\-source=NAME\fR 8
.IX Item "--installation-source=NAME"
Set the installation source to be used with the installation
script. Defaults to \f(CW\*(C`media\*(C'\fR, but can also be \f(CW\*(C`network\*(C'\fR.
.IP \fB\-\-config=key=value\fR 8
.IX Item "--config=key=value"
Set the configuration parameter \f(CW\*(C`key\*(C'\fR to \f(CW\*(C`value\*(C'\fR.
.IP \fB\-\-config\-file=config\-file\fR 8
.IX Item "--config-file=config-file"
Set the configurations parameters according to the config-file passed.
.Sp
Note that use of \fB\-\-config\-file\fR is strongly recommended if the user
or admin passwords need to be set. Providing passwords directly using
\&\fB\-\-config=\fR is insecure as the password is visible to all processes
and users on the same host.
.SH "CONFIGURATION KEYS"
.IX Header "CONFIGURATION KEYS"
The following configuration keys are available
.ie n .IP """hardware\-arch""" 8
.el .IP \f(CWhardware\-arch\fR 8
.IX Item "hardware-arch"
The hardware architecture
.ie n .IP """l10n\-timezone""" 8
.el .IP \f(CWl10n\-timezone\fR 8
.IX Item "l10n-timezone"
The local timezone
.ie n .IP """l10n\-keyboard""" 8
.el .IP \f(CWl10n\-keyboard\fR 8
.IX Item "l10n-keyboard"
The local keyboard layout
.ie n .IP """l10n\-language""" 8
.el .IP \f(CWl10n\-language\fR 8
.IX Item "l10n-language"
The local language
.ie n .IP """admin\-password""" 8
.el .IP \f(CWadmin\-password\fR 8
.IX Item "admin-password"
The administrator password
This option has been deprecated, use \fB\-\-config\-file\fR
for setting the admin password.
.ie n .IP """user\-password""" 8
.el .IP \f(CWuser\-password\fR 8
.IX Item "user-password"
The user password
This option has been deprecated, use \fB\-\-config\-file\fR
for setting the user password.
.ie n .IP """user\-login""" 8
.el .IP \f(CWuser\-login\fR 8
.IX Item "user-login"
The user login name
.ie n .IP """user\-realname""" 8
.el .IP \f(CWuser\-realname\fR 8
.IX Item "user-realname"
The user real name
.ie n .IP """user\-autologin""" 8
.el .IP \f(CWuser\-autologin\fR 8
.IX Item "user-autologin"
Whether to automatically login the user
.ie n .IP """user\-admin""" 8
.el .IP \f(CWuser\-admin\fR 8
.IX Item "user-admin"
Whether to give the user administrative privileges
.ie n .IP """reg\-product\-key""" 8
.el .IP \f(CWreg\-product\-key\fR 8
.IX Item "reg-product-key"
The software registration key
.ie n .IP """reg\-login""" 8
.el .IP \f(CWreg\-login\fR 8
.IX Item "reg-login"
The software registration user login
.ie n .IP """reg\-password""" 8
.el .IP \f(CWreg\-password\fR 8
.IX Item "reg-password"
The software registration user password
.SH "CONFIGURATION FILE FORMAT"
.IX Header "CONFIGURATION FILE FORMAT"
The configuration file must consist in a file which contains a
\&\f(CW\*(C`install\-script\*(C'\fR group and, under this group, \f(CW\*(C`key\*(C'\fR=\f(CW\*(C`value\*(C'\fR
pairs, as shown below:
.PP
.Vb 8
\&  [install\-script]
\&  l10n\-timezone=GMT
\&  l10n\-keyboard=uk
\&  l10n\-language=en_GB
\&  admin\-password=123456
\&  user\-login=berrange
\&  user\-password=123456
\&  user\-realname="Daniel P Berrange"
.Ve
.SH "EXAMPLE USAGE"
.IX Header "EXAMPLE USAGE"
The following usages generate a Fedora 30 kickstart script:
.PP
.Vb 4
\&  # osinfo\-install\-script \e
\&         \-\-profile jeos \e
\&         \-\-config\-file /path/to/config/file \e
\&         fedora30
\&
\&  # osinfo\-install\-script \e
\&         \-\-profile jeos \e
\&         \-\-config l10n\-timezone=GMT \e
\&         \-\-config l10n\-keyboard=uk \e
\&         \-\-config l10n\-language=en_GB \e
\&         \-\-config admin\-password=123456 \e
\&         \-\-config user\-login=berrange \e
\&         \-\-config user\-password=123456 \e
\&         \-\-config user\-realname="Daniel P Berrange" \e
\&         fedora30
.Ve
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
The exit status will be 0 if an install script is generated,
or 1 on error
.SH AUTHORS
.IX Header "AUTHORS"
Daniel P. Berrange <berrange@redhat.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2012 Red Hat, Inc.
.SH LICENSE
.IX Header "LICENSE"
\&\f(CW\*(C`osinfo\-install\-script\*(C'\fR is distributed under the termsof the GNU LGPL v2
license. This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE