--- gforth/INSTALL 1997/03/20 14:39:48 1.27 +++ gforth/INSTALL 1999/12/03 18:25:52 1.29 @@ -24,7 +24,8 @@ If everything is all right, you may want make install -You have to make an entry in the info directory file manually. +You have to make an entry in the info directory file manually (see +Installing Info Files, below). For paper documentation, print gforth.ps (a Postscript file (300dpi fonts, i.e., it works, but does not produce best quality on better @@ -37,8 +38,16 @@ documentation in HTML format by typing make html -If you prefer plain ASCII documentation, just concatenate the files -gforth.info-* ('cat gforth.info-*' under Unix). +If you prefer plain ASCII documentation, you can + +make doc/gforth.txt + +or just concatenate the files gforth.info-* ('cat gforth.info-*' under +Unix); the result of the latter option is a little worse. + +You can find binary distributions, documentation in HTML and plain +text format and information on known installation problems at +http://www.complang.tuwien.ac.at/forth/gforth/. Configuration Options @@ -127,20 +136,20 @@ ac_cv_c_bigendian variable gives the byt If you want to have some installation-specific files loaded when Gforth starts (e.g., an assembler for your processor), put commands -for loading them into /usr/local/share/gforth/site-forth/site-init.fs +for loading them into /usr/local/share/gforth/site-forth/siteinit.fs (if the commands work for all architectures) or -/usr/local/lib/gforth/site-forth/site-init.fs (for +/usr/local/lib/gforth/site-forth/siteinit.fs (for architecture-specific commands); -/usr/local/lib/gforth/site-forth/site-init.fs takes precedence if both +/usr/local/lib/gforth/site-forth/siteinit.fs takes precedence if both files are present (unless you change the search path). The file names given above are the defaults; if you have changed the prefix, you have to replace "/usr/local" in these names with your prefix. By default, the installation procedure creates an empty -/usr/local/share/gforth/site-forth/site-init.fs if there is no such +/usr/local/share/gforth/site-forth/siteinit.fs if there is no such file. -If you change the site-init.fs file, you should run "make install" +If you change the siteinit.fs file, you should run "make install" again for the changes to take effect (Actually, the part of "make install" starting with "rm gforth.fi" is sufficient). @@ -154,3 +163,28 @@ keep the old version for some time after You can deinstall this version of Gforth with 'make uninstall' and version foo with 'make uninstall VERSION=foo'. 'make uninstall' also tells you how to uninstall Gforth completely. + + + Installing Info Files + +Info is the GNU project on-line documentation format. You can read +info files either from within Emacs (Ctrl-h i) or using the +stand-alone Info reader, 'info'. + +If you use the default install root of '/usr/local' then the info +files will be installed in '/usr/local/info'. + +Many GNU/Linux distributions are set up to put all of their +documentation in '/usr/info', in which case you might have to do a +couple of things to get your environment set up to accommodate files +in both areas: + +1. Add an INFOPATH environment variable. The easiest place to do +this is '/etc/profile', right next to PATH and MANPATH: + +INFOPATH=/usr/local/info:/usr/info + +2. Create a file called 'dir' in 'usr/local/info'. Use the file +'/usr/info/dir' as a template. You can add the line for gforth +manually, or use '/sbin/install-info' (man install-info for details). +