From 1f8c740278812d4b5988c412f1f0a4f19d0f146b Mon Sep 17 00:00:00 2001 From: gdr-ftp Date: Mon, 18 Jan 1999 01:46:07 +0000 Subject: [PATCH] Makefile, intro.tex, mknotes: The file ../../verbatim/boot/README.install is now partially generated from intro.tex via the mknotes script. intro.tex: - expanded and corrected v2.0.6 installation notes - translated " --> '' (TeX style) mkhtmlman: Don't try to create man pages from resource forks (which would have been created by either CAP or Netatalk). --- doc/refs/Makefile | 7 ++- doc/refs/intro.tex | 137 +++++++++++++++++++++++++++++++++++---------- doc/refs/mkhtmlman | 5 +- doc/refs/mknotes | 93 ++++++++++++++++++++++++++++++ 4 files changed, 209 insertions(+), 33 deletions(-) create mode 100755 doc/refs/mknotes diff --git a/doc/refs/Makefile b/doc/refs/Makefile index f11fc77..4bb5a66 100644 --- a/doc/refs/Makefile +++ b/doc/refs/Makefile @@ -7,7 +7,7 @@ # # Devin Reade, 1997. # -# $Id: Makefile,v 1.10 1998/10/14 03:14:01 gdr-ftp Exp $ +# $Id: Makefile,v 1.11 1999/01/18 01:46:06 gdr-ftp Exp $ # # Set this to 'true' (without the quotes) for local links (used @@ -107,7 +107,7 @@ UPLOADS = \ # # targets # -all: dvi ps h man +all: dvi ps h man notes dvi: $(DVI) ps: ps_ltr ps_a4 ps_ltr: $(PS_LTR) @@ -128,6 +128,9 @@ intro.bbl: gno.bib upload: all $(UPLOADS) +# keeps intro.tex in sync with ../../verbatim/boot/README.install +notes:; ./mknotes + htmld.tar.gz: h tar -cf - $(HTMLD) | gzip --best > $@ diff --git a/doc/refs/intro.tex b/doc/refs/intro.tex index dccef22..45fb9f7 100644 --- a/doc/refs/intro.tex +++ b/doc/refs/intro.tex @@ -1,7 +1,7 @@ % % GNO Overview % -% $Id: intro.tex,v 1.8 1998/10/31 20:23:29 gdr-ftp Exp $ +% $Id: intro.tex,v 1.9 1999/01/18 01:46:06 gdr-ftp Exp $ % \documentclass{report} @@ -998,12 +998,12 @@ prior to doing a new installation. \section{Planning Your System} The install scripts assumes that your \em new\rm distribution will be installed -on to the two volumes \bf /gno \rm (ProDOS) and \bf /gno-hfs \rm (HFS). +on to the two volumes \bf /gno \rm (ProDOS) and \bf /gno-hfs \rm (HFS +or AppleShare). It also assumes these volumes already exist and are \em empty\rm. You may use other volume names, but you will have to edit certain files before you run your distribution. - \begin{tabular}{ll} boot disk (used only for installation) & 800k \\ binary distribution (shk files) & 4.6 MB \\ @@ -1011,11 +1011,26 @@ binary distribution (extracted) & 12.1 MB \\ complete GNO source & 15.0 MB \\ \end{tabular} +Before you start, you should also ensure that your system meets the +minimum hardware requirements, as documented in \bf Overview\rm. + +In order to install GNO, you will need some way to download the NuFX +archive files to your GS. You will also need GShrinkIt, which is available +from +\hturl{ftp://ftp.gno.org/pub/apple2/gs.specific/archivers/gshk11.bsc}. + +Part of the GNO installation still requires use of a text editor. The +GNO boot disk ships with \bf vi\rm installed; +if you do not know how to use \bf vi\rm (or you need a refresher), see +\hturl{http://www.jaws.umn.edu/~tobkin/vi} +for a good tutorial and quick reference guide. \section{Downloading and Extracting the Binary Distribution} -Your first step is of course to download the distribution. You should -have the following NuFX archives: +Your first step is of course to download the distribution. +The distribution is available from +\hturl{ftp://ftp.gno.org/pub/apple2/gs.specific/gno/base}. +You should have the following NuFX archives: \begin{itemize} @@ -1029,8 +1044,8 @@ fashion. \item{\bf gno.01.shk\rm, \bf gno.02.shk\rm, ... \bf gno.16.shk\rm} These disk archives contain the main portion of the GNO distribution. They must be placed in a single temporary subdirectory on a hard drive, -Zip disk, or other large capacity storage device. They should not yet be -extracted. +Zip disk, Appleshare volume, or other large capacity storage device. +They should not yet be extracted. \item{\bf gnohfs.shk\rm} This archive consists of files that do not conform to ProDOS naming @@ -1038,9 +1053,22 @@ conventions. While it is possible to run GNO without any HFS partitions at all, it is recommended that you have available to GNO a small amount of space on an HFS partition. If you use the \bf namespace\rm(5) facility, it is unnecessary to dedicate an entire HFS partition to GNO. +Note that Appleshare volumes may be used in lieu of HFS volumes. \end{itemize} +Next, using GShrinkIt or a similar program, extract the contents of the +file gnoboot.shk onto an 800k floppy named \bf gno.boot\rm. +The name of the floppy is critical. While you may use a hard drive +partition for \bf gno.boot\rm, this is likely a waste of hard drive space +since \bf gno.boot\rm will only be used while installing GNO, not while +running it. + +It should also be possible to use a RAM disk for \bf gno.boot\rm, but +this has not been verified. If you have successfully installed from a +RAM disk, please let Devin Reade know, along with any observations +you may have. + You should now do the following steps: \begin{comment} @@ -1053,57 +1081,94 @@ below with the appropriate name. \begin{enumerate} +\item +From your program launcher (typically the Finder), run the program +\bf /gno.boot/kern\rm. This is the GNO kernel. It will come up in +single user mode and you will be logged in as root running a \bf gsh\rm +shell session. + +Note that the boot disk currently uses the version 2.0.4 GNO kernel; this +is a temporary measure due to a bug with using newer kernels in single user +mode. When GNO gets installed to your hard drive, you will have a newer +kernel. + +\item +As per the instructions shown on the boot screen, you should now read the +file /gno.boot/README.install. The contents of that file, however, are +identical to the numerated instructions below; you need only read one or +the other set. + +%% README.install-start \item Set your DOWNLOAD\_DIR environment variable to the directory -into which you placed the above NuFX (*.shk) files. -For example, if the files gnohfs.shk, gno.01.shk, gno.02.shk -(and so forth) were in /download, you would type: +into which you placed the above NuFX (*.shk) files. For example, +if the files gnohfs.shk, gno.01.shk, gno.02.shk (and so forth) +were in /download, you would type: \begin{verbatim} setenv DOWNLOAD_DIR /download \end{verbatim} +Ensure that you use slashes (\bf/\rm) rather than colons (\bf:\rm) as the +pathname delimiter. Do not use a trailing slash. + \item -Assuming your distribution is to be installed onto the /gno partition, -issue the commands: +Install the majority of the GNO base distribution files by +changing directory into your destination directory and running +the \bf installboot1\rm script. Assuming that you will be installing +to the partition \bf/gno\rm, the commands would be: \begin{verbatim} cd /gno /gno.boot/installboot1 \end{verbatim} -This will install the majority of the GNO binaries. +This step takes quite a while, even with an accelerated IIgs. +Have patience. \item -There are a small number of recommended files that do not follow ProDOS -naming conventions. To install these files, issue the commands: +There are a small number of recommended files that do not follow +ProDOS naming conventions. If you wish to install these files, +make sure that you have an HFS or Appleshare disk online. Change +directories to that disk (or subdirectory) and run \bf installboot2\rm. +Assuming that the HFS disk is \bf/gno-hfs\rm, the commands are: \begin{verbatim} cd /gno-hfs /gno.boot/installboot2 \end{verbatim} -This assumes that /gno-hfs is an HFS partition. If you would like to -use on your HFS partition a single subdirectory for GNO, then you could -create and cd into /some-partition/gno-hfs instead. - -This step is optional. It is possible to use the GNO binary distribution -without an HFS partition, but some information will be missing. +This step is optional. It is possible to use the GNO binary +distribution without an HFS partition, but some information +will be missing. \item You should now edit the file /gno/etc/namespace. If your files were extracted onto a volume other than /gno, you will -have to replace all the ":gno:" strings with the appropriate -path. +have to replace all the ``:gno:'' strings with the appropriate +path. Similarily, you will have to replace ``:gno-hfs:'' if +that is not the name of your HFS (or Appleshare) partition +where you ran the \bf installboot2\rm script. +The \bf gno.boot\rm disk includes the \bf vi\rm utility to do these edits. +You can also edit the namespace file with any other text editor +of your choosing, as long as it is done before you try to run +your new GNO distribution. + +A vi tutorial and quick reference guide may be found at +\hturl{http://www.jaws.umn.edu/~tobkin/vi}. + +\begin{comment} You may want to put /usr onto a different partition; it will get fairly large over time. If you have a RAM disk, you should consider having it renamed to /tmp using renram5(8) or mktmp(8), in which case its entry should be removed from the namespace file. - -See the kernel reference manual for a description of this file. + +\end{comment} +See the kernel reference manual for a description of the +namespace file. \item If you are not short of disk space, you should create .so links @@ -1112,18 +1177,30 @@ explanation.) You can do this by executing the following commands: \begin{verbatim} - cd /gno/usr/man - mkso -v -H /gno-hfs/man mkso.data + cd /gno/usr/man + mkso -v -H /gno-hfs/man mkso.data \end{verbatim} - + +If you installed GNO somewhere other than /gno and /gno-hfs, then +edit the above lines accordingly. If you did not install files +onto an HFS (or Appleshare) partition at all, then execute the +following commands instead: + +\begin{verbatim} + cd /gno/usr/man + mkso -v mkso.data +\end{verbatim} + \item You should now return to your program launcher (the Finder, ProSEL-16, or whatever you used to start /gno.boot/kern) by -typing "exit" at the prompt. To startup up your new version +typing ``exit'' at the prompt. To startup up your new version of GNO, you should then launch /gno/kern. You will then see -a "login:" prompt. Enter "root" as the user name; you will +a ``login:'' prompt. Enter ``root'' as the user name; you will not yet need a password. +%% README.install-end + \end{enumerate} \section{Custom Configuration} diff --git a/doc/refs/mkhtmlman b/doc/refs/mkhtmlman index 277fcfa..1d996b9 100755 --- a/doc/refs/mkhtmlman +++ b/doc/refs/mkhtmlman @@ -2,7 +2,7 @@ # # Devin Reade, November 1997. # -# $Id: mkhtmlman,v 1.7 1998/02/19 03:04:05 gdr-ftp Exp $ +# $Id: mkhtmlman,v 1.8 1999/01/18 01:46:07 gdr-ftp Exp $ man2html=/usr/local/bin/man2html TMPDIR=${TMPDIR:-/tmp} @@ -43,6 +43,9 @@ for section in 1 2 3 4 5 6 7 8; do [ -d $dest ] || mkdir -p $dest for F in 00.DUMMY `find $MANDIRS -type f -name '*.'$section -print \ + | grep -v .AppleDouble \ + | grep -v .finderinfo \ + | grep -v .resource \ | grep -v libcurses/PSD.doc \ | grep -v bin/gsh/updates1.1 \ | grep -v sed/tests` ; do diff --git a/doc/refs/mknotes b/doc/refs/mknotes new file mode 100755 index 0000000..1bc7926 --- /dev/null +++ b/doc/refs/mknotes @@ -0,0 +1,93 @@ +#! /usr/bin/perl + +# +# This script creates the README.install notes for the gno.boot disk +# from the relevent information in the file ./intro.tex. It also reads +# in the file ../../verbatim/boot/README.install, and writes its results +# out to the same file. +# +# $Id: mknotes,v 1.1 1999/01/18 01:46:07 gdr-ftp Exp $ +# + +$texfile = "./intro.tex"; +$notes = "../../verbatim/boot/README.install"; + +# +# First read in the beginning of the README.install file. This part we +# leave as is. +# +open (fp, "< $notes") || die("couldn't read $notes: $!"); +while () { + $output .= $_; + if (m,\s*You should now do the following steps:\s*,) { + last; + } +} +close(fp); + +$started = 0; +$itemcount = 1; +open (fp, "< $texfile") || die("couldn't read $texfile: $!"); +while () { + + # handle the beginning and end of our install notes section + if ($started == 0) { + if (m,^\s*%%\s+README.install-start\s*$,) { + $started = 1; + } + next; + } + if (m,^\s*%%\s+README.install-end\s*$,) { + last; + } + + # don't print TeX comments. + if (m,^\s*\\begin\{comment\}\s*,) { + $incomment = 1; + next; + } + if (m,^\s*\\end\{comment\}\s*,) { + $incomment = 0; + next; + } + if ($incomment) { + next; + } + + # handle the paragraphs of our notes + if (m,^\s*\\item\s*$,) { + $firstline=1; + next; + } + if (m,^\s*\\begin\{verbatim\}\s*$,) { + $verbatim=1; + next; + } + if (m,^\s*\\end\{verbatim\}\s*$,) { + $verbatim=0; + next; + } + if ($verbatim) { + $output .= "\t"; # indent verbatim sections + } + if ($firstline) { + $firstline = 0; + $buffer = sprintf("\t%2d. ", $itemcount++); + $output .= $buffer; + } else { + $output .= "\t "; + } + s,\\htlink\{([^\}]+)\},$1,g; # show URLs as plain text + s,\s*\\bf\s*, ,g; # strip formatting commands + s,\\rm,,g; + s,\\,,g; # strip '\' from "\_" + s,\`\`,\",g; # translate TeX-style quotes + s,\'\',\",g; + $output .= $_; +} +close(fp); + +# write out the results +open (fp, "> $notes") || die("couldn't read $notes: $!"); +print fp $output; +close(fp);