[install-guide/F21-rewrite] New structure for Kickstart syntax, take 2

pbokoc pbokoc at fedoraproject.org
Mon Sep 15 18:09:12 UTC 2014


commit 7701f9a12ab80343932225552ede908836c18ac2
Author: Petr Bokoc <pbokoc at redhat.com>
Date:   Mon Sep 15 20:08:40 2014 +0200

    New structure for Kickstart syntax, take 2

 en-US/Boot_Options.xml               |    6 +-
 en-US/Kickstart_Syntax_Reference.xml |  253 ++++++++++++++++++++--------------
 en-US/VNC_Installations.xml          |    4 +-
 3 files changed, 152 insertions(+), 111 deletions(-)
---
diff --git a/en-US/Boot_Options.xml b/en-US/Boot_Options.xml
index 37c085e..cacc661 100644
--- a/en-US/Boot_Options.xml
+++ b/en-US/Boot_Options.xml
@@ -314,7 +314,7 @@
                     <term><option>inst.lang=</option></term>
                     <listitem>
                         <para>
-                            Sets the language to be used during the installation. Language codes are the same as the ones used in the <command>lang</command> Kickstart command as described in <xref linkend="sect-kickstart-commands" />. On systems where the <package>system-config-language</package> package is installed, a list of valid values can also be find in <filename>/usr/share/system-config-language/locale-list</filename>.
+                            Sets the language to be used during the installation. Language codes are the same as the ones used in the <command>lang</command> Kickstart command as described in <xref linkend="appe-kickstart-syntax-reference" />. On systems where the <package>system-config-language</package> package is installed, a list of valid values can also be find in <filename>/usr/share/system-config-language/locale-list</filename>.
                         </para>
                     </listitem>
                 </varlistentry>
@@ -369,7 +369,7 @@
                     <term><option>inst.keymap=</option></term>
                     <listitem>
                         <para>
-                            Specifies the keyboard layout to be used by the installation program. Layout codes are the same as the ones used in the <command>keyboard</command> Kickstart command as described in <xref linkend="sect-kickstart-commands" />.
+                            Specifies the keyboard layout to be used by the installation program. Layout codes are the same as the ones used in the <command>keyboard</command> Kickstart command as described in <xref linkend="appe-kickstart-syntax-reference" />.
                         </para>
                     </listitem>
                 </varlistentry>
@@ -449,7 +449,7 @@
                         </para>
                         <note>
                             <para>
-                                During the installation, the <systemitem class="username">root</systemitem> account has no password by default. You can set a root password to be used during the installation with the <command>sshpw</command> Kickstart command as described in <xref linkend="sect-kickstart-commands" />.
+                                During the installation, the <systemitem class="username">root</systemitem> account has no password by default. You can set a root password to be used during the installation with the <command>sshpw</command> Kickstart command as described in <xref linkend="appe-kickstart-syntax-reference" />.
                             </para>
                         </note>
                     </listitem>
diff --git a/en-US/Kickstart_Syntax_Reference.xml b/en-US/Kickstart_Syntax_Reference.xml
index 0667de1..057d44e 100644
--- a/en-US/Kickstart_Syntax_Reference.xml
+++ b/en-US/Kickstart_Syntax_Reference.xml
@@ -6,87 +6,88 @@
 <appendix id="appe-kickstart-syntax-reference">
     <title>Kickstart Syntax Reference</title>
     <para>
-        intro text
+        This appendix describes commands and options available in Kickstart installations. For information about how to automate your installation using Kickstart, see <xref linkend="chap-kickstart-installations" />.
     </para>
     
-    <section id="sect-kickstart-syntax-changes">
-        <title>Changes in Kickstart Syntax</title>
-        <para>
-            text
-        </para>
-    </section>
-    
-    <section id="sect-kickstart-commands">
-        <title>Kickstart Commands and Options</title>
+    <section id="sect-kickstart-commands-installation">
+        <title>Installation Methods and Sources</title>
         <para>
             text
         </para>
         
-        <section id="sect-kickstart-commands-auth">
-            <title>auth - Configure Authentication</title>
+        <section id="sect-kickstart-commands-device">
+            <title>device - Install Extra Device Drivers</title>
             <para>
                 text
             </para>
         </section>
-
-        <section id="sect-kickstart-commands-autopart">
-            <title>autopart - Automatic Partitioning</title>
+        
+        <section id="sect-kickstart-commands-driverdisk">
+            <title>driverdisk - Use a Driver Disk</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-autostep">
-            <title>autostep - Go Through Every Screen Automatically</title>
+        <section id="sect-kickstart-commands-install">
+            <title>install - Configure Installation Method</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-bootloader">
-            <title>bootloader - Configure Boot Loader</title>
+        <section id="sect-kickstart-commands-mediacheck">
+            <title>mediacheck - Verify Installation Media Integrity</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-btrfs">
-            <title>btrfs - Create Btrfs Volume or Subvolume</title>
+        <section id="sect-kickstart-commands-ostree">
+            <title>ostree - Install from an OSTree</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-clearpart">
-            <title>clearpart - Remove All Existing Partitions</title>
+        <section id="sect-kickstart-commands-repo">
+            <title>repo - Configure Instalaltion Source</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-cmdline">
-            <title>cmdline - Perform Installation in Command Line Mode</title>
+    </section>
+    
+    <section id="sect-kickstart-commands-storage">
+        <title>Storage and Partitioning</title>
+        <para>
+            text
+        </para>
+        
+        <section id="sect-kickstart-commands-autopart">
+            <title>autopart - Automatic Partitioning</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-device">
-            <title>device - Install Extra Device Drivers</title>
+        <section id="sect-kickstart-commands-bootloader">
+            <title>bootloader - Configure Boot Loader</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-driverdisk">
-            <title>driverdisk - Use a Driver Disk</title>
+        <section id="sect-kickstart-commands-btrfs">
+            <title>btrfs - Create Btrfs Volume or Subvolume</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-eula">
-            <title>eula - Accept the License Agreement</title>
+        <section id="sect-kickstart-commands-clearpart">
+            <title>clearpart - Remove All Existing Partitions</title>
             <para>
                 text
             </para>
@@ -99,134 +100,158 @@
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-firewall">
-            <title>firewall - Configure Firewall</title>
+        <section id="sect-kickstart-commands-ignoredisk">
+            <title>ignoredisk - Ignore Specified Disks</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-firstboot">
-            <title>firstboot - Enable or Disable Initial Setup</title>
+        <section id="sect-kickstart-commands-iscsi">
+            <title>iscsi - Configure iSCSI Devices</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-group">
-            <title>group - Create User Group</title>
+        <section id="sect-kickstart-commands-iscsiname">
+            <title>iscsiname - Assign Name to iSCSI Device</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-graphical">
-            <title>graphical - Perform Installation in Graphical Mode</title>
+        <section id="sect-kickstart-commands-logvol">
+            <title>logvol - Create LVM Logical Volume</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-halt">
-            <title>halt - Halt System After Installation</title>
+        <section id="sect-kickstart-commands-part">
+            <title>part - Create Physical Partition</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-ignoredisk">
-            <title>ignoredisk - Ignore Specified Disks</title>
+        <section id="sect-kickstart-commands-raid">
+            <title>raid - Create Software RAID</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-install">
-            <title>install - Configure Installation Method</title>
+        <section id="sect-kickstart-commands-volgroup">
+            <title>volgroup - Create LVM Volume Group</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-iscsi">
-            <title>iscsi - Configure iSCSI Devices</title>
+        <section id="sect-kickstart-commands-zerombr">
+            <title>zerombr - Reinitialize Partition Tables</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-iscsiname">
-            <title>iscsiname - Assign Name to iSCSI Device</title>
+        <section id="sect-kickstart-commands-zfcp">
+            <title>zfcp - Configure Fibre Channel Device</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-keyboard">
-            <title>keyboard - Configure Keyboard Layouts</title>
+    </section>
+    
+    <section id="sect-kickstart-commands-network-configuration">
+        <title>Network Configuration</title>
+        <para>
+            text
+        </para>
+        
+        <section id="sect-kickstart-commands-firewall">
+            <title>firewall - Configure Firewall</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-lang">
-            <title>lang - Configure Language During Installation</title>
+        <section id="sect-kickstart-commands-network">
+            <title>network - Configure Network Interfaces</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-logging">
-            <title>logging - Configure Error Logging During Installation</title>
+    </section>
+    
+    <section id="sect-kickstart-commands-environment">
+        <title>Console and Environment</title>
+        <para>
+            text
+        </para>
+        
+        <section id="sect-kickstart-commands-keyboard">
+            <title>keyboard - Configure Keyboard Layouts</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-logvol">
-            <title>logvol - Create LVM Logical Volume</title>
+        <section id="sect-kickstart-commands-lang">
+            <title>lang - Configure Language During Installation</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-mediacheck">
-            <title>mediacheck - Verify Installation Media Integrity</title>
+        <section id="sect-kickstart-commands-services">
+            <title>services - Configure Services</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-network">
-            <title>network - Configure Network Interfaces</title>
+        <section id="sect-kickstart-commands-skipx">
+            <title>skipx - Do Not Configure X Window System</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-ostree">
-            <title>ostree - Install from an OSTree</title>
+        <section id="sect-kickstart-commands-timezone">
+            <title>timezone - Configure Time Zone</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-part">
-            <title>part - Create Physical Partition</title>
+        <section id="sect-kickstart-commands-xconfig">
+            <title>xconfig - Configure X Window System</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-poweroff">
-            <title>poweroff - Power Off After Installation</title>
+    </section>
+    
+    <section id="sect-kickstart-commands-users-groups">
+        <title>Users, Groups and Authentication</title>
+        <para>
+            text
+        </para>
+        
+        <section id="sect-kickstart-commands-auth">
+            <title>auth - Configure Authentication</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-raid">
-            <title>raid - Create Software RAID</title>
+        <section id="sect-kickstart-commands-group">
+            <title>group - Create User Group</title>
             <para>
                 text
             </para>
@@ -239,57 +264,65 @@
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-reboot">
-            <title>reboot - Reboot After Installation</title>
+        <section id="sect-kickstart-commands-rootpw">
+            <title>rootpw - Set Root Password</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-repo">
-            <title>repo - Configure Instalaltion Source</title>
+        <section id="sect-kickstart-commands-selinux">
+            <title>selinux - Configure SELinux</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-rescue">
-            <title>rescue - Rescue Mode</title>
+        <section id="sect-kickstart-commands-user">
+            <title>user - Create User Account</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-rootpw">
-            <title>rootpw - Set Root Password</title>
+    </section>
+    
+    <section id="sect-kickstart-commands-installation-environment">
+        <title>Installation Environment</title>
+        <para>
+            text
+        </para>
+        
+        <section id="sect-kickstart-commands-autostep">
+            <title>autostep - Go Through Every Screen Automatically</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-selinux">
-            <title>selinux - Configure SELinux</title>
+        <section id="sect-kickstart-commands-cmdline">
+            <title>cmdline - Perform Installation in Command Line Mode</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-services">
-            <title>services - Configure Services</title>
+        <section id="sect-kickstart-commands-graphical">
+            <title>graphical - Perform Installation in Graphical Mode</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-shutdown">
-            <title>shutdown - Shut Down After Installation</title>
+        <section id="sect-kickstart-commands-logging">
+            <title>logging - Configure Error Logging During Installation</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-skipx">
-            <title>skipx - Do Not Configure X Window System</title>
+        <section id="sect-kickstart-commands-rescue">
+            <title>rescue - Rescue Mode</title>
             <para>
                 text
             </para>
@@ -309,13 +342,6 @@
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-timezone">
-            <title>timezone - Configure Time Zone</title>
-            <para>
-                text
-            </para>
-        </section>
-        
         <section id="sect-kickstart-commands-unsupported_hardware">
             <title>unsupported_hardware - Suppress Unsupported Hardware Alerts</title>
             <para>
@@ -323,50 +349,58 @@
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-user">
-            <title>user - Create User Accound</title>
+        <section id="sect-kickstart-commands-vnc">
+            <title>vnc - Configure VNC Access</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-vnc">
-            <title>vnc - Configure VNC Access</title>
+    </section>
+        
+    <section id="sect-kickstart-commands-after">
+        <title>After the Installation</title>
+        <para>
+            text
+        </para>
+        
+        <section id="sect-kickstart-commands-eula">
+            <title>eula - Accept the License Agreement</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-volgroup">
-            <title>volgroup - Create LVM Volume Group</title>
+        <section id="sect-kickstart-commands-firstboot">
+            <title>firstboot - Enable or Disable Initial Setup</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-xconfig">
-            <title>xconfig - Configure X Window System</title>
+        <section id="sect-kickstart-commands-halt">
+            <title>halt - Halt System After Installation</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-zerombr">
-            <title>zerombr - Reinitialize Partition Tables</title>
+        <section id="sect-kickstart-commands-poweroff">
+            <title>poweroff - Power Off After Installation</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-zfcp">
-            <title>zfcp - Configure Fibre Channel Device</title>
+        <section id="sect-kickstart-commands-reboot">
+            <title>reboot - Reboot After Installation</title>
             <para>
                 text
             </para>
         </section>
         
-        <section id="sect-kickstart-commands-include">
-            <title>%include - Include Contents of Another File</title>
+        <section id="sect-kickstart-commands-shutdown">
+            <title>shutdown - Shut Down After Installation</title>
             <para>
                 text
             </para>
@@ -374,6 +408,13 @@
         
     </section>
     
+    <section id="sect-kickstart-commands-include">
+        <title>%include - Include Contents of Another File</title>
+        <para>
+            text
+        </para>
+    </section>
+    
     <section id="sect-kickstart-packages">
         <title>Package Selection</title>
         <para>
diff --git a/en-US/VNC_Installations.xml b/en-US/VNC_Installations.xml
index 3b6f438..75adc01 100644
--- a/en-US/VNC_Installations.xml
+++ b/en-US/VNC_Installations.xml
@@ -257,14 +257,14 @@ Thu Feb 20 15:23:54 2014
     <section id="sect-vnc-kickstart-considerations">
         <title>Kickstart Considerations</title>
        <para>
-            Commands for using a VNC installation are also available in Kickstart installations. Using just the <command>vnc</command> command will set up an installation using Direct Mode. Options are available to set up an installation using Connect Mode. For more information about the <command>vnc</command> command and options used in Kickstart files, see <xref linkend="sect-kickstart-commands" />.
+            Commands for using a VNC installation are also available in Kickstart installations. Using just the <command>vnc</command> command will set up an installation using Direct Mode. Options are available to set up an installation using Connect Mode. For more information about the <command>vnc</command> command and options used in Kickstart files, see <xref linkend="appe-kickstart-syntax-reference" />.
         </para>
     </section>
 
     <section id="sect-vnc-headless-considerations">
         <title>Considerations for Headless Systems</title>
         <para>
-            When installing headless systems, the only choices are an automated Kickstart installation or an interactive VNC installation using connect mode. For more information about automated Kickstart installation, see <xref linkend="sect-kickstart-commands" />. The general process for an interactive VNC installation is described below.
+            When installing headless systems, the only choices are an automated Kickstart installation or an interactive VNC installation using connect mode. For more information about automated Kickstart installation, see <xref linkend="appe-kickstart-syntax-reference" />. The general process for an interactive VNC installation is described below.
         </para>
         <orderedlist>
             <listitem>


More information about the docs-commits mailing list