[comp.sys.next] SybaseDoc 1.0 - printing Sybase docs

dbrenner@icon.weeg.uiowa.edu (12/06/89)

I've FTPed a file called SybaseDoc-1.0.tar.Z to the pub/next/submissions
directory at cs.orst.edu.

This file might be of interest if you are trying to print the Sybase User's or
Administration Guide.

Attached is the README file.  I hope someone finds this of use.
==========================================================================
README file for SybaseDoc-1.0  (December 3, 1989)

I wanted to print the Sybase documentation, so I followed the suggestions in
the document /NextLibrary/Documentation/Sybase/README.wn.  The suggestions did
not work completely due to the following problems:

1. Several figures are missing which causes troff to abort.  These figures are
included via the .so directive that's part of the .Sc macro (file name is
/usr/lib/tmac/tmac.syb).  Parts of the Administration Guide (SAG), User's
Guide (SQLUG), and Command Reference (COMREF) have this problem.

My solution: I changed the .Sc macro to generate a box giving the missing
figure's name.

2. The table of contents macro file (/usr/lib/tmac/tmac.sybtoc) is missing.
When you use the troff command line option -rT1, the table of contents is
generated to the screen.  If you redirect this output and try to format it
with -msyb you'll see the problem.

My solution:  None.

3. The Sybase documentation is designed to be formated via ditroff (available
from AT&T) using 9 different fonts.  This makes the documentation difficult to
read when formatted via troff because font/style changes above 4 are ignored.

My solution: Use the more readable Times font with troff and let the fixed
pitch examples by misaligned.  (An alternative solution would be to use
Courier for the entire document -- body and examples.)

4. The README.wn document neglects to tell you to use 'tbl' on the source
files prior to using troff.

My solution:  Use 'tbl'!  :-)

Going with the overkill method, I've created two Makefiles that will correctly
turn the SAG and SQLUG into PostScript files that can be printed or viewed.
Included with these two makefiles are three Sybase files that needed changes
and a third makefile to put things into place.

The files included in SybaseDoc-1.0 are:

   README         - this file
   disclaimer     - Sybase document with .fp references removed
   Makefile       - Makefile to put these files into place
   Makefile.SAG   - Makefile for SAG (Administration Guide)
   Makefile.SQLUG - Makefile for SQLUG (User's Guide)
   titpage.sqlug  - Sybase document with .fp references removed
   tmac.syb       - Sybase macros with .Sc macro changed

1. After you have these files unpacked, edit Makefile's INSTALLDIR to indicate
where you'd like things installed.  (The default is the Next supplied Sybase
documentation directory, which would require the proper access.)

2. If you change the default install directory, use 'make installdir' to copy
the necessary Sybase documentation into place.

3. Use 'make install' to merge the new files into the install directory.

With that done, you can use the Makefiles to create PostScript versions of the
SAG and SQLUG.  Just move into the install directory, change to either SAG or
SQLUG, and type 'make'.  ('make help' with give some additional usage in case
you're interested.)

I'm sorry if this is confusing.  Best I could do on short notice.  ;-)

I suppose something similar could be done for the Command Reference (COMREF)
and Database Library (DBLIB) documentation.  Not me, not tonight.

NeXT is aware of these problems.  I understand they are working with Sybase
and should have things resolved in the next release.  No date given.
==========================================================================
Doug Brenner, Weeg Computing Center, The University of Iowa, Iowa City, IA
dbrenner@umaxc.weeg.uiowa.edu | dbrennpg@uiamvs.bitnet | 319-335-5444.at&t