Mike
Screwey docs? Check the format. First, all the docs are in Unix-text
format. Meaning they terminate lines with CR instead of CR-LF. If
you run them through the GNU cat program (located as part of the
gnufu.zoo set of tools) it'll be corrected. Some editors (like GNU
Emacs and Micro-Emacs) will also fix this.
Second, if the files have a .texi extension, then they aren't normal
text, but should be decoded. I don't know the name of the program to
do this, though.
Does anyone know how to read .texi files?
--
|) David Charlap "I don't even represent myself
/|_ dic...@hertz.njit.edu sometimes so NJIT is right out!.
((|,)
~|~ Hi! I am a .signature virus, copy me into your .signature file.
>Second, if the files have a .texi extension, then they aren't normal
>text, but should be decoded. I don't know the name of the program to
>do this, though.
>
>Does anyone know how to read .texi files?
OK, I know now. They are dual-purpose files. They can be formatted
into a printed manual with TeX and an appropriate header file. They
can also be turned into emacs-style .info files. This information is
in GNU-emacs's info system - lookup "texinfo" files.
The information on TexInfo from Emacs follow:
--------- BEGIN QUOTE -----------
Overview of Texinfo
*******************
Texinfo is a documentation system that uses a single source file for
both on-line help and a printed manual. This means that instead of
writing two different documents, one for the on-line help and the
other for the printed manual, only one document needs to be written.
When the system is revised, only one file has to be revised.
Using Texinfo, you can create a document with the normal features of
a book such as chapters, sections, cross references and indices. The
chapters and sections of the printed manual can be made to correspond
to the nodes of the on-line help. The cross references and indices
can be used in both the on-line help and in the printed document.
Indices are generated semi-automatically. The ``GNU Emacs Manual''
is a good example of a Texinfo file.
To make the printed manual, the Texinfo source file is processed by
the TeX typesetting program; the resulting DVI file can be typeset
and printed as a book. To make the on-line help, the Texinfo source
file is by processed the `M-x texinfo-format-buffer' command; the
resulting Info file is installed in the `info' directory.
Since the Texinfo source file is used for a dual task--to create both
the on-line help and the printed manual--it must be written in a
special format that uses @-commands (words preceded by an `@') to
indicate chapters, sections, nodes, examples, index entries and the
like.
Before writing a Texinfo source file, you should be familiar with the
on-line Info documentation reading program. (*note info: (info)Info,
for more information.) If you are writing a document that will be
both on-line and printed, you will need both Info and TeX.
To make an Info file, you use the `M-x texinfo-format-buffer' command
in GNU Emacs.
To make a printed manual, you need to use TeX, a powerful,
sophisticated typesetting program written by Donald Knuth. TeX is
freely distributable. It is written in a dialect of Pascal called WEB
and can be compiled either in Pascal or (by using a conversion
program that comes with the TeX distribution) in C. (For information
about getting TeX, *note : (emacs)TeX Mode.)
When TeX processes a Texinfo source file, TeX makes use of a macro
definitions file called `texinfo.tex' that comes with the GNU Emacs
distribution in the `emacs/man' sources directory. (The first line
of every Texinfo file has a command that says `\input texinfo'; this
tells TeX to use the `texinfo.tex' file.)
If the `texinfo.tex' file has not already been copied to the
directory which contains the other TeX macro definition files when
Emacs was installed, you will probably want to copy it to that
directory. Usually, this is the `/usr/lib/tex/macros' directory.
For more information, *note @TeX{} Input Initialization: TeX Input.
Documentation for GNU utilities and libraries should be written in
Texinfo format.
:)Second, if the files have a .texi extension, then they aren't normal
:)text, but should be decoded. I don't know the name of the program to
:)do this, though.
Grab a copy of gnuinfo.zoo from hobbes.
Yes. Use TeX to print them and texinfo to view them online. I've only
used TeX so far. If you are on a Unix box it's probably loaded. If you
don't have TeX you can get an excellent OS/2 version called emTeX from
ftp-os2.nmsu.edu:/pub/os2/all as well as many other sites. My search
on archie found about 20 before I killed the search. You don't need
the whole thing. To get started:
1) Get the file readme.eng (or the german version if you like :-)) and
print it out and read it, then read it again. It has everything you
need to know except which files you need to unzip just for the gcc
docs.
2) To print the gcc docs unzip tex1.zip, tex2.zip and the dvidrv.zip
files (I think there are 3). The files will unzip into a single
directory called emtex. Have a look at the file emtex\set-vars.cmd.
You can paste this into your config.sys changing the drive letter if
neccessary.
3) You will also need to unzip the font files for your printer. They
can go anywhere, I put mine in emtex\fonts. An env-var is set to that
directory as described in the docs.
4) Put c:\emtex (or whatever) in your path.
You can now reboot.
EmTeX also runs under DOS, the command tex is a dos program. texp is
the OS/2 version. I deleted all the dos stuff and renamed texp.exe to
tex.exe.
You will also need a current version of texinfo.tex. This is a
standard include file for all the GNU documentation. It needs to go in
a direcctory specified in one of the env-vars for include files. (I
forget which, I don't have OS/2 here at work but the readme file
explains it all). texinfo.tex can be obtained from the usual GNU
archives and from GNUINFO.ZOO. Actually, I suggest you get GNUINFO.ZOO
(from ftp-os2) as it has some other goodies for TeX, namely
texindex.exe, which is used to sort the indexes.
Ok, asssuming all of the above was done properley you can start to get
some output.
I have a directory called texdocs where I process the files as I can
clean it out easily. (TeX produces a lot of intermediate files). Copy
all the *.texi files into your work area and rename then to *.tex. One
limitation with emTeX is that the OS/2 version is not HPFS aware and
still expects 8.3 filenames. Hopefully a full 32-bit version with long
filename support will appear soon. (Hint, hint).
There are 2 manuals for gcc, one for the preprocessor, cpp and one for
the compiler gcc. I'll use cpp as an example here, I suggest you try
that one frst as it's smaller (about 50 pages, gcc is over 300).
Enter: tex cpp
You will get a lot of stuff printed on the screen as emTeX creates a
dvi file. Page numbers are in square brackets. There are other error
messages too, like overfull boxes and stuff. Ignore them.
Enter: texindex cpp.??
This builds and sorts the index.
Enter: tex cpp
This time emTeX will include the index in the dvi file.
Ok, now you're ready to print something at last. There are lots of cmd
files in \emtex with the name prt*. One should match your printer
type. I use prthplj (HP LaserJet) for my deskjet. To print I enter:
prthplj cpp /od <- turns on deskjet mode.
When you get really ambitious you can try double sided printing:
prthplj cpp /od /2o <- specifies odd pages
Turn paper over etc.
prthplj cpp /od 2e /z <- prints from last page to first.
The /z switch may not be needed depending on how your printer works.
Use the switch -? to get more options for your particular printer.
The only problems I've had so far are using texindex on the gcc
manual. It aborts because there are more that 64k of stuff in an array
or something. I tried to recompile it as a 32-bit app without the
restriction but exceeded my C hacking ability too soon. (I mainly
program in Pascal, PL/1 and COBOL). ExTeX has a program called
makeindx but I haven't looked at it yet.
Well, that ends the crash course on emTeX. I'm very impressed with the
quality on my deskjet. I've got the DVI previewer for PM working too.
It came off the beta disks and setting it up changed a bit of what I
described above. If there is any interest I'll give some help on
getting it to work too
Trevor Lampre
MIS Unit
Flinders University of South Australia
>OK, I know now. They are dual-purpose files. They can be formatted
>into a printed manual with TeX and an appropriate header file. They
>can also be turned into emacs-style .info files. This information is
>in GNU-emacs's info system - lookup "texinfo" files.
>
>The information on TexInfo from Emacs follow:
>
[Quote from GNU-Emacs info pages deleted]
I still have a problem with a few files. M-x Texinfo-Format-Buffer
will not format gcc.texi. It has a problem with the @set and @ifset
functions. I noticed that the conpiled gcc.info file has a comment
line stating that it was compiled with a program called "Makeinfo".
Does anyone know about this program or if it was compiled for OS/2?
I also noticed a few bugs in some of the gcc .texi files. On of them
(cpp.texi) has a "@ref" function which emacs won't process.
Instead, it should be either "@xref" or "@pxref". After making the
change, the file compiled without error.
Look for: gnuinfo.zoo on hobbes. The archive contains:
makeinfo - creates info files from texinfo files
texindex - creates/sorts indexes when building dvi files
texinfo.tex - TeX macro file
plus some readme/info on use. Note that there are about 900 different
versions of texinfo.tex floating around and I'm not sure which is the
most recent/appropriate. Also makefiles are an excellent way of building
and installing texinfo sources (could add rules to you dmake.ini or
rc file for whatever make you happen to be using).
Hope this helps.
/Doug
The texinfo format is an evolving thing. The gcc manual uses (I think)
version 2 of the format. Emacs very likeley comes with a version 1
texinfo formatter [well, 18.57 does anyway], so you won't be able to use
emacs to do the formatting.
The gnuinfo package's makeinfo.exe is up to date. You could also obtain
the new texinfo.el (or whatever it is called) from the gnuinfo package
as distributed by GNU and use emacs to do your formatting.
Hope this helps...
--
Colin Jensen (cje...@ampex.com)