                          _              |
                  ___  __| | ___   ___   |
                 / __|/ _` |/ _ \ / __|  |
                 \__ \ (_| | (_) | (__   |
                 |___/\__,_|\___/ \___|  |
                                         |
                       Source Documenter | 
                =========================+==================================
                                         |
                             Version 3.1 | softWorks
                             10/04/1997  | personal engineering software 
                                         |
====================+====================+==================================
        DESCRIPTION | This program helps you to document your programms. It
                    | supports you when you create or add documentation and 
                    | produces good looking (printable) output.
                    | 
                    | You add documentation information to your source code
                    | using pod (Plain Old Documentation), the documentation
                    | format also used in perl. The documentation options
                    | provided by pod are simple and easy to learn but 
                    | powerful enough to create nice and good looking
                    | documents.
                    |
                    | The programm can be used to document C, C++, Java, Tcl
                    | and Perl programms. It uses the information in your
                    | source file to create a pod-document which in turn may 
                    | be transformed to HTML, LaTeX, Postscript, nroff or 
                    | just plain text.
                    | 
                    | The preview function of sdoc lets you create docu-
                    | mentation interactively - add or modify your docu-
                    | mentation in the source file and check the output for
                    | correctness.
                    | 
                    | Here are some highlights:
                  o | documentation is included in source file, no separate 
                    | no separate files needed
                  o | powerful but easy to use formatting options
                  o | good looking documentation 
                  o | automated indexing
                  o | output may be in HTML, Postscript and a lot
                    | of other formats (have a look at the perlpod
                    | manual page or at available pod converters).
                  o | output may be used in the "Source Locator",
                    | another programm from softWorks that is
                    | especially suited for quick documentation
                    | lookup.
                    | 
                    | This version is limited to noncommercial use. The Source
                    | Documenter is also available as a commercial
                    | version. It adds the following:
                  o | significantly faster
                  o | full support, upgrades
                  o | complete documentation
                  o | more features
                    |
====================+========================================================
           LOCATION | You can download the public-domain version of the 
                    | programm from the neosoft archive (currently in 
                    | incomming, but will certainly move to the following 
                    | location):
                    |
                    | http://www.neosoft.com/tcl/ftparchive/sorted/development
                    | ftp://ftp.neosoft.com/pub/tcl/sorted/development
                    | ftp://sunsite.unc.edu/pub/Linux/??
                  o | Sdoc3.1.README
                  o | Sdoc3.1-info.tar.gz
                  o | Sdoc3.1-base.tar.gz
                  o | Sdoc3.1-public.tar.gz
                  o | Sdoc3.1-linux.tar.gz
                  o | Sdoc3.1-english.tar.gz
                  o | Sdoc3.1-german.tar.gz
                  o | Sdoc3.1.1-support.tar.gz
                    |
                    | You need the base, public and operating system specific 
                    | packages to run the programm. The language specific 
                    | files contain adaptions and help files, support contains
                    | examples and demos. The info file gives you an overview
                    | of the programm (html). 
                    | 
====================+========================================================
       INSTALLATION | This is a ready to run application - unpack the tar
                    | archive, maybe add the 'SW/bin' directory to your path
                    | or let the environment variable SOFTDIR point to your
                    | installation directory and start the program
                    | 
                    |         SOFTDIR=??/SW; export SOFTDIR
                    |         ??/SW/bin/tdoc
                    | 
                    | users in german speaking countries may want to set 
                    | SOFTLANG to 'german' ;-)
                    | Check the files contained in ??/SW/ins for
                    | additional installation information.
                    |
                    | Please go to the 'demo' subdirectory and try the 
                    | examples first (demos are in the support package).
                    | 
====================+========================================================
      DOCUMENTATION | Complete documentation and context sensitive help is
                    | included. 
                    |
                    | An overview of the programm is contained in the info
                    | package (in HTML).
                  o | Sdoc3.1-info.tar.gz
                    |
                    | This is also available from the following WWW-site:
                  o | http://members.ping.at/risc/sdoc.html
                    | 
====================+========================================================
          COPYRIGHT | See the supplied documentation for full details.
                    | The package includes other packages (like tcl/tix) that
                    | have their own copyrights.
                    |
                    | The public-domain version may be used, copied and
                    | modified as long as you keep the copyright notice and
                    | don't make any money with it (that is for private use).
                    |
                    | The commercial version has it's own copyright - check 
                    | out the documentation...
                    |
                    | All versions may be tested for 30 days. After this
                    | period you have to obtain a license code - which is
                    | free for the public-domain version...
                    |
====================+========================================================
     QUESTIONS/BUGS | You can contact me at
                    |       risc@finwds01.tu-graz.ac.at
                    |       http://members.ping.at/risc
                    |       Richard Schwaninger
                    |       softWorks
                    |       Theodor-Koernerstr. 173
                    |       A-8010 Graz, Austria
                    | 
====================+========================================================
       REQUIREMENTS | A binary version of the programm is available for the 
                    | following platforms:
                    |
                  o | Linux:
                    |   You need an ELF based system with X11 and perl
                    |
                  o | HP-UX:
                    |   Version 9.x, 10.x, X11R5 or later
                    |
                  o | SGI Irix: 
                    |   Version 5.3
                    |
                  o | The commercial version is also available in source
                    | form. Additional languages (eg C++, Java, Lisp)
                    | can be easily added. Please contact softWorks for
                    | details.
                    |                    
                    | sdoc needs perl (5.x, though 4.x should also work) to
                    | format it's output. The basic pod2xx filters (perl) 
                    | are included in the package.
                    |
====================+========================================================
    CURRENT VERSION | The current version is 
                    | 
                    | Source-Documenter Version 3.1
                    |
                    | Changes since 2.1
                    |
                  o | name change necessary, can now document other languages
                    | besides tcl.
                  o | complete rewrite of the display code, gives better
                    | usability.
                  o | active support for documentation-creation.
                  o | help system change, tips.
                    | 
                    | Changes sinze 1.2
                    |
                  o | Tdoc now uses upgraded libraries with various
                    | enhancements and bug fixes. 
                  o | It is now able to restore it's state upon
                    | restart.
                  o | Parsing is better on files that don't conform to
                    | our own internal standards. 
                  o | Some resize bugs have been fixed.
                  o | now can directly parse the original tcl
                    | documenting style for both tcl scripts and C
                    | source files.
                    | 
====================+========================================================
      MISCELLANEOUS | This is a binary, self contained release. It contains
                    | no sources and will only run on the platforms stated
                    | above. Contact softWorks if you would like to see the
                    | programm for other platforms.
                    |
                  o | If you are interested in other products and our services
                    | then send an email with the subject line 
                    |     'product-catalog'
                    | to risc@finwds01.tu-graz.ac.at or have a look at
                    |     http://members.ping.at/risc
                    | 
====================+========================================================

-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: 2.6.i

mQBtAjGoHyoAAAEDAL9++nAU4e2D21kraZpZENzNMWAV7yJz/G9FSSFS682YT64c
tfBRLdb+FUvfatUnyiHCc+O6Tlo6HSxmgCVb/HLXLIkCHH9VNtwOCZLFFE5Sf0Qs
iV+cA7Y0Q/IHQSUOJQAFEbQ8UmljaGFyZCBTY2h3YW5pbmdlciwgc29mdFdvcmtz
IDxyaXNjQGZpbndkczAxLnR1LWdyYXouYWMuYXQ+
=e7X9
-----END PGP PUBLIC KEY BLOCK-----



