[install-guide/F21-rewrite] Adding commands to Kickstart Syntax Reference up to logvol
pbokoc
pbokoc at fedoraproject.org
Thu Sep 18 16:06:08 UTC 2014
commit dc5e3e516122f99743550dc9a9fe37592ba9bafd
Author: Petr Bokoc <pbokoc at redhat.com>
Date: Thu Sep 18 12:16:11 2014 +0200
Adding commands to Kickstart Syntax Reference up to logvol
en-US/Kickstart_Syntax_Reference.xml | 389 ++++++++++++++++++++++++++++++++--
1 files changed, 372 insertions(+), 17 deletions(-)
---
diff --git a/en-US/Kickstart_Syntax_Reference.xml b/en-US/Kickstart_Syntax_Reference.xml
index 29993ce..229ebc7 100644
--- a/en-US/Kickstart_Syntax_Reference.xml
+++ b/en-US/Kickstart_Syntax_Reference.xml
@@ -124,10 +124,195 @@
</section>
<section id="sect-kickstart-commands-install">
- <title>install - Configure Installation Method</title>
- <para>
- text
- </para>
+ <title>install (required) - Configure Installation Method</title>
+ <para>
+ The default installation mode. You must specify the type of installation from <literal>cdrom</literal>, <literal>harddrive</literal>, <literal>nfs</literal>, <literal>liveimg</literal>, or <literal>url</literal>. The <command>install</command> command and the installation method command must be on separate lines. For example:
+ </para>
+ <programlisting>
+<command>install</command>
+<command>liveimg --url=file:///images/install/squashfs.img --noverifyssl</command>
+ </programlisting>
+ <para>
+ The installation method commands are:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><command>cdrom</command></term>
+ <listitem>
+ <para>
+ Install from the first optical (DVD) drive on the system.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>harddrive</command></term>
+ <listitem>
+ <para>
+ Install from a tree or full installation ISO image on a local hard drive. The tree or ISO image must be on a file system which is mountable in the installation environment. Supported file systems are <systemitem>ext2</systemitem>, <systemitem>ext3</systemitem>, <systemitem>ext4</systemitem>, <systemitem>vfat</systemitem>, or <systemitem>xfs</systemitem>.
+ </para>
+ <programlisting>
+<command>install</command>
+<command>harddrive --partition= | --biospart= [--dir=]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--partition=</option></term>
+ <listitem>
+ <para>
+ Partition to install from (such as <literal>sdb2</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--biospart=</option></term>
+ <listitem>
+ <para>
+ BIOS partition to install from (such as <literal>82p2</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--dir=</option></term>
+ <listitem>
+ <para>
+ Directory containing the installation tree or ISO image.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>liveimg</command></term>
+ <listitem>
+ <para>
+ Install from a disk image instead of packages. The image can be the <filename>squashfs.img</filename> file from a live ISO image, or any file system that the installation media can mount. Supported file systems are <systemitem>ext2</systemitem>, <systemitem>ext3</systemitem>, <systemitem>ext4</systemitem>, <systemitem>vfat</systemitem>, and <systemitem>xfs</systemitem>.
+ </para>
+ <programlisting>
+<command>install</command>
+<command>liveimg --url= [--proxy= | --checksum= | --noverifyssl=]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--url=</option></term>
+ <listitem>
+ <para>
+ The location to install from. Supported protocols are <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem>, <systemitem class="protocol">FTP</systemitem>, and <systemitem class="protocol">file</systemitem>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--proxy=</option></term>
+ <listitem>
+ <para>
+ Specify an <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem> or <systemitem class="protocol">FTP</systemitem> proxy to use while performing the installation.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--checksum=</option></term>
+ <listitem>
+ <para>
+ An optional argument with the <systemitem>SHA256</systemitem> checksum of the image file, used for integrity verification. If you are using a live image provided by Fedora Project, you can find a list of checksums at <ulink url="https://fedoraproject.org/en/verify" />.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--noverifyssl</option></term>
+ <listitem>
+ <para>
+ Disable SSL verification when connecting to an <systemitem class="protocol">HTTPS</systemitem> server.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>nfs</command></term>
+ <listitem>
+ <para>
+ Install from an <systemitem class="protocol">NFS</systemitem> server specified. <remark>TODO: link to the PXE chapter's section on preparing install source on nfs</remark>
+ </para>
+ <programlisting>
+<command>install</command>
+<command>nfs --server= [--dir=] [--opts= ]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--server=</option></term>
+ <listitem>
+ <para>
+ Host name of the server.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--dir=</option></term>
+ <listitem>
+ <para>
+ Directory containing the installation tree or ISO image.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--opts=</option></term>
+ <listitem>
+ <para>
+ Mount options to use for mounting the <systemitem class="protocol">NFS</systemitem> export.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>url</command></term>
+ <listitem>
+ <para>
+ Install from a tree on a remote server via <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem>, or <systemitem class="protocol">FTP</systemitem>.
+ </para>
+ <programlisting>
+<command>install</command>
+<command>url --url= | --mirrorlist= [--proxy= | --noverifyssl]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--url=</option></term>
+ <listitem>
+ <para>
+ The location to install from. Supported protocols are <literal>http</literal>, <literal>https</literal>, <literal>ftp</literal>, and <literal>file</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--mirrorlist=</option></term>
+ <listitem>
+ <para>
+ The mirror URL to install from.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--proxy=</option></term>
+ <listitem>
+ <para>
+ Specify an <systemitem class="protocol">HTTP</systemitem>, <systemitem class="protocol">HTTPS</systemitem> or <systemitem class="protocol">FTP</systemitem> proxy to use while performing the installation.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--noverifyssl</option></term>
+ <listitem>
+ <para>
+ Disable SSL verification when connecting to an <systemitem>HTTPS</systemitem> server.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="sect-kickstart-commands-mediacheck">
@@ -697,17 +882,95 @@
</section>
<section id="sect-kickstart-commands-iscsi">
- <title>iscsi - Configure iSCSI Devices</title>
- <para>
- text
- </para>
+ <title>iscsi (optional) - Configure iSCSI Devices</title>
+ <para>
+ Specifies additional iSCSI storage to be attached during installation. If you use the <command>iscsi</command> command, you must also assign a name to the iSCSI node, using the <command>iscsiname</command> command (see <xref linkend="sect-kickstart-commands-iscsiname" />. The <command>iscsiname</command> command must appear before the <command>iscsi</command> command in the Kickstart file.
+ </para>
+ <para>
+ You should configure iSCSI storage in the system BIOS or firmware (iBFT for Intel systems) rather than use the <command>iscsi</command> command if possible. If you do so, <application>Anaconda</application> automatically detects and uses disks configured in BIOS or firmware and no special configuration is necessary in the Kickstart file.
+ </para>
+ <para>
+ If you must use the <command>iscsi</command> command, make sure that networking is activated at the beginning of the installation, and that the <command>iscsi</command> command appears in the Kickstart file <emphasis>before</emphasis> you refer to iSCSI disks with commands such as <command>clearpart</command> or <command>ignoredisk</command>.
+ </para>
+ <programlisting>
+<command>iscsi --ipaddr= --port= [--target= | --iface= | --user= | --password= | --reverse-user= | --reverse-password=]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--ipaddr=</option></term>
+ <listitem>
+ <para>
+ The IP address of the target to connect to.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--port=</option></term>
+ <listitem>
+ <para>
+ The port number (typically <literal>3260</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--target=</option></term>
+ <listitem>
+ <para>
+ Target <firstterm>IQN</firstterm> (iSCSI Qualified Name).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--iface=</option></term>
+ <listitem>
+ <para>
+ Bind the connection to a specific network interface instead of using the default one determined by the network layer. Once used, it must be specified in all instances of the <command>iscsi</command> command in the entire Kickstart file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--user=</option></term>
+ <listitem>
+ <para>
+ User name required to authenticate with the target.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--password=</option></term>
+ <listitem>
+ <para>
+ Password that corresponds with the user name specified for the target.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--reverse-user=</option></term>
+ <listitem>
+ <para>
+ User name required to authenticate with the initiator from a target using reverse CHAP authentication.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--reverse-password=</option></term>
+ <listitem>
+ <para>
+ Password that corresponds with the user name specified for the initiator.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="sect-kickstart-commands-iscsiname">
- <title>iscsiname - Assign Name to iSCSI Device</title>
+ <title>iscsiname (optional) - Assign Name to iSCSI Device</title>
<para>
- text
- </para>
+ Assigns a name to an iSCSI node specified by the <command>iscsi</command> command (<xref linkend="sect-kickstart-commands-iscsi" />). This command is mandatory if you use the <command>iscsi</command> command, and it must be specified <emphasis>before</emphasis> you use <command>iscsi</command>.
+ </para>
+ <programlisting>
+<command>iscsiname <replaceable>iqn</replaceable></command>
+ </programlisting>
</section>
<section id="sect-kickstart-commands-logvol">
@@ -867,17 +1130,80 @@
</para>
<section id="sect-kickstart-commands-keyboard">
- <title>keyboard - Configure Keyboard Layouts</title>
- <para>
- text
- </para>
+ <title>keyboard (optional) - Configure Keyboard Layouts</title>
+ <para>
+ Sets one or more available keyboard layouts for the system.
+ </para>
+ <programlisting>
+<command>keyboard --vckeymap= | --xlayouts= [--switch=]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--vckeymap=</option></term>
+ <listitem>
+ <para>
+ Specify a <systemitem>VConsole</systemitem> keymap which should be used. Valid names correspond to the list of files in the <filename class="directory">/usr/lib/kbd/keymaps/*</filename> directory, without the <literal>.map.gz</literal> extension.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--xlayouts=</option></term>
+ <listitem>
+ <para>
+ Specify a list of <application>X</application> layouts that should be used as a comma-separated list without spaces. Accepts values in the same format as <systemitem>setxkbmap(1)</systemitem>, either in the <literal><replaceable>layout</replaceable></literal> format (such as <literal>cz</literal>), or in the <literal><replaceable>layout</replaceable> (<replaceable>variant</replaceable>)</literal> format (such as <literal>cz (qwerty)</literal>).
+ </para>
+ <para>
+ All available layouts can be viewed on the <systemitem>xkeyboard-config(7)</systemitem> man page under <literal>Layouts</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--switch=</option></term>
+ <listitem>
+ <para>
+ Specify a list of layout-switching options (shortcuts for switching between multiple keyboard layouts). Multiple options must be separated by commas without spaces. Accepts values in the same format as <systemitem>setxkbmap(1)</systemitem>.
+ </para>
+ <para>
+ Available switching options can be viewed on the <systemitem>xkeyboard-config(7)</systemitem> man page under <literal>Options</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ The following example sets up two keyboard layouts (<literal>English (US)</literal> and <literal>Czech (qwerty)</literal>) using the <option>--xlayouts=</option> option, and allows to switch between them using <keycombo><keycap>Alt</keycap><keycap>Shift</keycap></keycombo>:
+ </para>
+ <programlisting>
+<command>keyboard --xlayouts=us,'cz (qwerty)' --switch=grp:alt_shift_toggle</command>
+ </programlisting>
</section>
<section id="sect-kickstart-commands-lang">
- <title>lang - Configure Language During Installation</title>
- <para>
- text
- </para>
+ <title>lang (optional) - Configure Language During Installation</title>
+ <para>
+ Sets the language to use during installation and the default language to use on the installed system.
+ </para>
+ <programlisting>
+<command>lang <replaceable>language</replaceable> [--addsupport=]</command>
+ </programlisting>
+ <para>
+ The file <filename>/usr/share/system-config-language/locale-list</filename> provides a list of the valid <replaceable>language</replaceable> codes in the first column of each line and is part of the <package>system-config-language</package> package.
+ </para>
+ <para>
+ Certain languages (for example, Chinese, Japanese, Korean, and Indic languages) are not supported during text-mode installation. If you specify one of these languages with the <command>lang</command> command and use text mode, the installation process will continue in English, but the installed system will use your selection as its default language.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><option>--addsupport=</option></term>
+ <listitem>
+ <para>
+ Add support for additional languages. Takes the form of comma-separated list without spaces. For example:
+ </para>
+ <programlisting>
+<command>lang en_US --addsupport=cs_CZ,de_DE,en_UK</command>
+ </programlisting>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="sect-kickstart-commands-services">
@@ -1203,8 +1529,37 @@
<section id="sect-kickstart-commands-logging">
<title>logging - Configure Error Logging During Installation</title>
<para>
- text
- </para>
+ Controls the error logging of <application>Anaconda</application> during installation. It has no effect on the installed system.
+ </para>
+ <programlisting>
+<command>logging [--host= | --port= | --level=]</command>
+ </programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><option>--host=</option></term>
+ <listitem>
+ <para>
+ Send logging information to the given remote host, which must be running a <systemitem class="service">syslogd</systemitem> process configured to accept remote logging.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--port=</option></term>
+ <listitem>
+ <para>
+ If the remote syslogd process uses a port other than the default, it may be specified with this option.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--level=</option></term>
+ <listitem>
+ <para>
+ Specify the minimum level of messages that appear on virtual console 3 (<systemitem>tty3</systemitem>). This only affects messages printed to the console; log files will contain messages of all levels. Possible values are <literal>debug</literal>, <literal>info</literal>, <literal>warning</literal>, <literal>error</literal>, or <literal>critical</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
<section id="sect-kickstart-commands-rescue">
More information about the docs-commits
mailing list