X-Git-Url: https://git.rrq.au/?a=blobdiff_plain;f=README.adoc;h=e1ebe93ea560be845dea593022df42eeaff353d2;hb=refs%2Fheads%2Fmaster;hp=6547ccd7af709764f051bc5e15a79cb47b0fe1f8;hpb=ded272bc01244508aac88f7420fc0d32a7d21add;p=rrq%2Fsubhost.git

diff --git a/README.adoc b/README.adoc
index 6547ccd..e1ebe93 100644
--- a/README.adoc
+++ b/README.adoc
@@ -10,30 +10,26 @@ than within virtual machines (VM).
 pretend-boot
 ------------
 
-The +pretend-boot+ script works together with the +subhost-init+
-script to run a subhost almost as if booted in a virtual machine,
-except of course, that it really is merely an "unshared sandboxing"
-executed by the the host kernel.
+The +pretend-boot+ script runs a subhost almost as if booted in a
+virtual machine, except of course, that it really is merely an
+"unshared sandboxing" executed by the the host kernel.
 
 .Example
 ----
 # ./pretend-boot mysubhost
 ----
 
-The named subhost must then be set up in the directory
-+/opt/sub/mysubhost+ with firstly a +config+ file and secondly a
-+live+ subdirectory that will be used as root filesystem mount point.
-
- 1. +config+ configuration that defines +DISKS+ and +BRIDGES+
- 2. +live+ empty directory for the root filesystem mount
-
-The +config+ file is a textfile, or in fact a +bash+ source file, that
-should set the variables +DISKS+ and +BRIDGES+ for the subhost.
-
++pretend-boot+ sets up the +/opt/sub/mysubhost/live+ directory that it
+uses as root filesystem mount point. It requires the variables DISKS
+and BRIDGES to be set, either as environment variables, or via a
+configuration file that it by default expects to find at
++/opt/sub/mysubhost/config+ That +config+ would be a textfile, or in
+fact a +bash+ source file, that should set the variables +DISKS+ and
++BRIDGES+ for running the subhost.
 
 ====
 **The +DISKS+ variable** is an array declaring the disks in terms the
-paritions to mount. Each array element has three parts with ":"
+partitions to mount. Each array element has three parts with ":"
 between them:
 
  1. the device node name to use in the subhost
@@ -75,9 +71,12 @@ subhost-init
 The +subhost-init+ script is copied into the subhost root filesystem,
 and it first performs the rudimentary pre-pivot tasks (mounting "proc"
 etc.), the runs rcS and rc2 before entering into a plain wait for
-anyting to be written to +/run/initctl+ which works as an immediate
+anything to be written to +/run/initctl+ which works as an immediate
 +poweroff+ for the subhost.
 
+'''
+'''
+'''
 
 control
 -------