force use of pandoc version >= 3.1.12.2
The `bin/pandoc-wrapper.sh` tool will verify that the ssytem has a recent enough version of `pandoc(1)`. We explain why we insist on `pandoc(1)`. version >= 3.1.12.2 in comments where the $PANDOC_MIN_VERSION is set. Added `--wrap=preserve` as a default argument to `pandoc(1)`. While this change will impact every HTML file generated, we believe this will improve the ability of someone to look at the generated HTML and correlate with the original markdown. Changed `bin/pandoc-wrapper.sh` VERSION from "1.4.2 2024-03-17" to "1.4.3 2024-03-18". Performed `make www` to achieve all of the above and to generate HTML using the new `--wrap=preserve` `pandoc(1)` mode.
This commit is contained in:
Landon Curt Noll committed
1 parent
9eb7a54e9f
commit
b0b212acb1
402 files changed
+37061
-55132
No files matched your search
+35
-46
@@ -122,53 +122,42 @@
|
||||
|
||||
<h1 id="usage">Usage</h1>
|
||||
<ol type="1">
|
||||
<li><p>First, build the kernel and filesystem (just <code>make</code>).
|
||||
In short, you need to build this on an x86 Linux machine. If you wish to
|
||||
try to compile on an OS other than Linux you may need modify the <a
|
||||
href="Makefile">Makefile</a> to compile <code>sh</code> using a
|
||||
cross-compiler that produces ELF binaries - i.e. a cross-compiler
|
||||
targeting x86 Linux. In short, you need to build this on an x86 Linux
|
||||
machine.</p></li>
|
||||
<li><p>Next, find a suitable machine to run the OS on. It should be
|
||||
perfectly safe, and since it does not directly attempt to access any
|
||||
hard disk drives (only a <a
|
||||
href="https://en.wikipedia.org/wiki/RAM_drive">RAM disk</a> loaded by
|
||||
the bootloader) it should do no damage to your existing setup, BUT I
|
||||
ACCEPT NO LIABILITY FOR ANY DAMAGE DONE BY THIS PROGRAM. Run it at your
|
||||
own risk. The OS has been tested on half a dozen machines or so, and
|
||||
worked on all but one. The failure came in the form of the machine
|
||||
rebooting itself midway through loading the OS, with no nasty
|
||||
side-effects.</p>
|
||||
<li><p>First, build the kernel and filesystem (just <code>make</code>). In short, you need to
|
||||
build this on an x86 Linux machine. If you wish to try to compile on an OS
|
||||
other than Linux you may need modify the <a href="Makefile">Makefile</a> to compile <code>sh</code>
|
||||
using a cross-compiler that produces ELF binaries - i.e. a cross-compiler
|
||||
targeting x86 Linux. In short, you need to build this on an x86 Linux machine.</p></li>
|
||||
<li><p>Next, find a suitable machine to run the OS on. It should be perfectly safe,
|
||||
and since it does not directly attempt to access any hard disk drives (only a
|
||||
<a href="https://en.wikipedia.org/wiki/RAM_drive">RAM disk</a> loaded by the bootloader) it
|
||||
should do no damage to your existing setup, BUT I ACCEPT NO LIABILITY FOR ANY
|
||||
DAMAGE DONE BY THIS PROGRAM. Run it at your own risk. The OS has been tested
|
||||
on half a dozen machines or so, and worked on all but one. The failure came in
|
||||
the form of the machine rebooting itself midway through loading the OS, with no
|
||||
nasty side-effects.</p>
|
||||
<p>Hardware requirements - i386 or better processor, but the GUI is
|
||||
surprisingly power-hungry, so I would recommend a fast P3 or P4
|
||||
processor (has been tested on P3/P4/Athlon machines). Minimum RAM is
|
||||
something like 32MB. PS/2 mouse & keyboard required - no USB I’m
|
||||
afraid, and the keyboard map is for a UK keyboard. Uses VESA VBE 3.0, so
|
||||
should work on any modern graphics card (has been tested on NVIDIA,
|
||||
Matrox, and SiS cards).</p></li>
|
||||
<li><p>Now you need to setup a bootloader to load the OS. If you have a
|
||||
system using a lilo bootloader you can simply add the OS to your boot
|
||||
menu. Just add appropriate <code>image=</code> and <code>initrd=</code>
|
||||
lines to your <code>/etc/lilo.conf</code>, pointing at
|
||||
<code>kernel</code> and <code>fs.tar</code> respectively (as built by
|
||||
make earlier), then run <code>lilo</code>. If you do not wish modify
|
||||
your lilo setup, one easy option is to get yourself a GRUB boot disk
|
||||
image, and follow the instructions for GRUB below - Debian users can
|
||||
simply run<code>apt-get install grub-disk</code> to get themselves a
|
||||
GRUB boot disk.</p>
|
||||
<p>If you run GRUB, then at the boot menu simply hit <code>c</code> to
|
||||
get a console, then type <code>kernel=(hd0,0)/<PATH>/kernel</code>
|
||||
(substituting appropriate hard drive/partition numbers & path, or
|
||||
using <code>(fd0)</code> to load a kernel on the floppy), then
|
||||
<code>initrd=(hd0,0)/<PATH>/fs.tar</code>, and finally
|
||||
<code>boot</code>.</p></li>
|
||||
<li><p>Assuming the OS has booted, what can you do now? Well, start by
|
||||
trying <code>sh</code>, to open another shell. Then, try
|
||||
<code>vi gavin.c</code> to open up the OS source in a text file viewer
|
||||
(up/down or PgUp/PgDn to scroll). Note that the provided applications,
|
||||
<code>sh</code> and <code>vi</code> both have windows of the same size,
|
||||
and both open in the top left corner of the screen, so you may need drag
|
||||
the windows around a bit to tell them apart.</p></li>
|
||||
surprisingly power-hungry, so I would recommend a fast P3 or P4 processor
|
||||
(has been tested on P3/P4/Athlon machines). Minimum RAM is something like
|
||||
32MB. PS/2 mouse & keyboard required - no USB I’m afraid, and the keyboard
|
||||
map is for a UK keyboard. Uses VESA VBE 3.0, so should work on any modern
|
||||
graphics card (has been tested on NVIDIA, Matrox, and SiS cards).</p></li>
|
||||
<li><p>Now you need to setup a bootloader to load the OS. If you have a system
|
||||
using a lilo bootloader you can simply add the OS to your boot menu. Just add
|
||||
appropriate <code>image=</code> and <code>initrd=</code> lines to your <code>/etc/lilo.conf</code>, pointing at
|
||||
<code>kernel</code> and <code>fs.tar</code> respectively (as built by make earlier), then run <code>lilo</code>.
|
||||
If you do not wish modify your lilo setup, one easy option is to get yourself a
|
||||
GRUB boot disk image, and follow the instructions for GRUB below - Debian users
|
||||
can simply run<code>apt-get install grub-disk</code> to get themselves a GRUB boot disk.</p>
|
||||
<p>If you run GRUB, then at the boot menu simply hit <code>c</code> to get a console, then
|
||||
type <code>kernel=(hd0,0)/<PATH>/kernel</code> (substituting appropriate hard
|
||||
drive/partition numbers & path, or using <code>(fd0)</code> to load a kernel on the
|
||||
floppy), then <code>initrd=(hd0,0)/<PATH>/fs.tar</code>, and finally <code>boot</code>.</p></li>
|
||||
<li><p>Assuming the OS has booted, what can you do now? Well, start by trying <code>sh</code>,
|
||||
to open another shell. Then, try <code>vi gavin.c</code> to open up the OS source in a
|
||||
text file viewer (up/down or PgUp/PgDn to scroll). Note that the provided
|
||||
applications, <code>sh</code> and <code>vi</code> both have windows of the same size, and both open in
|
||||
the top left corner of the screen, so you may need drag the windows around a bit
|
||||
to tell them apart.</p></li>
|
||||
<li><p>To shut down - just hit the power button. :-)</p></li>
|
||||
</ol>
|
||||
|
||||
|
||||
Reference in new issue
Block a user