summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2020-07-14 21:20:04 -0500
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2020-07-14 21:20:04 -0500
commit235024a6e845b5e2fe9d8935336fc528f97a3406 (patch)
treeb9f0bda9771889a70d09231ee0cca0ab65233a32
parent04baa8fc546173171c0aa076cc2f2649680fdbf0 (diff)
downloaddocs-235024a6e845b5e2fe9d8935336fc528f97a3406.tar.gz
docs-235024a6e845b5e2fe9d8935336fc528f97a3406.tar.bz2
docs-235024a6e845b5e2fe9d8935336fc528f97a3406.tar.xz
docs-235024a6e845b5e2fe9d8935336fc528f97a3406.zip
install: Write some of chapter 5
-rw-r--r--src/install/4_options.xml4
-rw-r--r--src/install/5_commit.xml29
-rw-r--r--src/install/7_scripts.xml4
3 files changed, 30 insertions, 7 deletions
diff --git a/src/install/4_options.xml b/src/install/4_options.xml
index 213ab34..528c56d 100644
--- a/src/install/4_options.xml
+++ b/src/install/4_options.xml
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter label="4" id="options">
<title>Selecting System Options</title>
- <para>You use the Adélie Linux System Installation software to configure your new environment.
+ <highlights><para>You use the Adélie Linux System Installation software to configure your new environment.
This chapter introduces you to System Installation, and provides detailed information about your available options on each screen.
- For more information about how to use and navigate System Installation, see <xref linkend="navigating" />.</para>
+ For more information about how to use and navigate System Installation, see <xref linkend="navigating" />.</para></highlights>
<section id="ui_overview">
<title>Overview</title>
<para>The System Installation software asks you a series of questions about the desired configuration for your computer.
diff --git a/src/install/5_commit.xml b/src/install/5_commit.xml
index 91d4edf..b43e333 100644
--- a/src/install/5_commit.xml
+++ b/src/install/5_commit.xml
@@ -1,8 +1,31 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter label="5" id="commit">
<title>Installing System Software</title>
- <section>
- <title/>
- <para/>
+ <highlights><para>Now that you have selected the appropriate options for your system, you can proceed with installing Adélie Linux.</para></highlights>
+ <section id="ui_runner">
+ <title>From Adélie graphical installation media</title>
+ <para>If you are using the graphical System Installation wizard from Adélie Linux installation media, choosing "Install" from the last page of System Installation will automatically begin the process of installing Adélie Linux on your computer.</para>
+ </section>
+ <section id="executor">
+ <title>From a command line</title>
+ <para>You can use the Horizon Executor from a command line to execute a HorizonScript that you have prepared on another computer.</para>
+ <procedure>
+ <title>Executing a HorizonScript from the command line</title>
+ <step><para>Boot the target computer using Horizon media. This can be either the normal Full or Live Installation Media, the Network Installation Media, or custom media you have created that contains the Horizon system.</para></step>
+ <step><para>Obtain a root command prompt on the target computer. Typically, this is accomplished by logging in as <literal>root</literal> on the Installation Media.</para></step>
+ <step><para>Run <literal><command>hscript-fetch</command> <userinput>url-to-installfile</userinput></literal>, where <userinput>url-to-installfile</userinput> is a fully-qualified URL to the desired installfile. For example, <literal><command>hscript-fetch</command> https://myserver/my-workstation.installfile</literal> will fetch the HorizonScript at https://myserver/my-workstation.installfile.</para></step>
+ <step><para>Optionally, run <literal><command>hscript-validate</command> /etc/horizon/installfile</literal> to validate the HorizonScript.</para></step>
+ <step><para>Run <literal><command>hscript-executor</command></literal> to execute the HorizonScript.</para></step>
+ </procedure>
+ </section>
+ <section id="executor_log">
+ <title>Reviewing the Executor log file</title>
+ <para>When using graphical installation media, the Executor log file is located at <filename>/var/log/horizon/executor.log</filename> in the live environment. If you choose "Save Installation Data" when completing System Installation, the Executor log file is saved to <filename>executor.log</filename> in the directory you select.</para>
+ <para>When running Horizon from the command line, the log is output to <literal>stderr</literal>.</para>
+ <section id="log_format">
+ <title>Interpreting log messages</title>
+ <para>Every log message output by Horizon is in a specific format, designed to be easily readable by system operators and processed by computer programs.</para>
+ <para>The format is: <literal>timestamp TAB message-type TAB location: [severity: ] message</literal></para>
+ </section>
</section>
</chapter>
diff --git a/src/install/7_scripts.xml b/src/install/7_scripts.xml
index 3ea0550..c21855a 100644
--- a/src/install/7_scripts.xml
+++ b/src/install/7_scripts.xml
@@ -111,7 +111,7 @@ inherit cad.installfile
<step><para>Open a Terminal window.</para></step>
<step><para>Run <literal><command>hscript-validate</command> <filename><userinput>/path/to/installfile</userinput></filename></literal>, where <userinput>/path/to/installfile</userinput> is the path to your HorizonScript.</para></step>
</procedure>
- <para>The HorizonScript Validation Utility outputs log messages in the same format as the Horizon Executor. For more information on interpreting log messages from the HorizonScript Validation Utility, refer to <!-- TODO chap 5 <xref linkend="executor_log"/> -->.</para>
+ <para>The HorizonScript Validation Utility outputs log messages in the same format as the Horizon Executor. For more information on interpreting log messages from the HorizonScript Validation Utility, refer to <xref linkend="executor_log"/>.</para>
<para>If you believe your HorizonScript may have multiple errors, you can use the <option>-k</option> flag (which stands for "Keep going") to have the Validation Utility run through the entire script instead of stopping at the first error.</para>
</section>
<section id="simulate_script">
@@ -123,7 +123,7 @@ inherit cad.installfile
<step><para>Open a Terminal window.</para></step>
<step><para>Run <literal><command>hscript-simulate</command> <filename><userinput>/path/to/installfile</userinput></filename></literal>, where <userinput>/path/to/installfile</userinput> is the path to your HorizonScript.</para></step>
</procedure>
- <para>The HorizonScript Simulation Utility outputs log messages in the same format as the Horizon Executor. For more information on interpreting log messages from the HorizonScript Simulation Utility, refer to <!-- TODO chap 5 <xref linkend="executor_log"/> -->.</para>
+ <para>The HorizonScript Simulation Utility outputs log messages in the same format as the Horizon Executor. For more information on interpreting log messages from the HorizonScript Simulation Utility, refer to <xref linkend="executor_log"/>.</para>
<para>The HorizonScript Simulation Utility writes log messages to <literal>stderr</literal>, and the equivalent shell commands to <literal>stdout</literal>. If you want to read the log messages and discard the shell commands, you may run the <literal><command>hscript-simulate</command></literal> command with <literal>stdout</literal> redirected to <literal>/dev/null</literal>, as in <literal><command>hscript-simulate</command> <filename><userinput>/path/to/installfile</userinput></filename> &gt;/dev/null</literal>. Similarly, if you want to save the shell commands to a file, you may redirect <literal>stdout</literal> to a file, as in <literal><command>hscript-simulate</command> <filename><userinput>/path/to/installfile</userinput></filename> &gt;<userinput>myscript.sh</userinput></literal>.</para>
</section>
</chapter>