Atari FTP/ATARI_FTP_0693.zip/ATARI_FTP_0693/Mint/mntdoc01.zoo/mintdoc/read.me

Text File | 1993-03-03 | 3KB | 54 lines

Hi all,

This is MNTDOC01, the MiNT documentation package version 0.1.
The MiNT documentation package is meant as a complete documentation
package for all programmers using MiNT and the mintlibs. It contains the
'official' MiNT documentation as supplied by Eric Smith, the MiNT system
call documentation as written by Eric Smith, and documentation for part
of the mintlibs.

This documentation has grown from a Pure-C user-defined helpfile, and
still is based on that. Since many people do not have Pure-C or do want
to use the documentation on-line in a terminal or toswin window, the
documentation is also supplied in nroff -man format (both raw and
formatted). Since the nroff -man version is translated from the Pure-C
helpfile by a simple computer program, it doesn't look all that nice.
Too bad, it will get better in the next version.

The mintdocs are up-to-date for MiNT 0.95 (official docs), MiNT 0.99
(system call docs) and the mintlibs pl 30 (mintlib docs).

Installation and use:
- copy USR.HLP to your Pure-C directory (Pure-C only)
- merge the Pure-C sources with your own if you already have your own
  user-defined helpfile that you like to keep. (Pure-C only)
- copy the contents of the man2, man3, cat2, cat3 directories to your
  /usr/man directory to use the docs with 'man'. ('man' users only)
- study the contents of the c_src directory and see if you can use it.
- just read the docs in the mintdocs directory (install in brain)

Copyrights:
MiNT is copyrighted by Eric Smith and Atari Corp. So are the MiNT docs
supplied here and the MiNT system call documentation. The mintlib docs
are free; however, if you make them into something else, I'd like it if
you left my name in it. The contents of the c_src/* directory is
freeware; again, please leave my name in this stuff.

Future:
In the near future, more mintlib documentation will be added as my spare
time permits. First, I want to finish the <unistd.h>, <stdio.h>,
<stdlib.h> and <support.h> calls; later, I may add other stuff. If you
really need something or want to add some stuff you did yourself, mail
me.
Also in the near future, I will improve the layout of the nroff man
pages (i.e., add bold/italic stuff where needed). If there is a demand
for it, I will also supply a 'book' of documentation in dvi or
PostScript format (mail me if you want that!).
In the medium to long term future, I'll be working on a hypertext system
and document conversion utilities. Some of that work may be reflected in
these docs. No promises, however!

Bye,
  Hildo Biersma
  [e-mail] // [e-mail]