--------------------------------------------------------------------------
$VER: XSIG_Doc 0.4 (26.06.94)
--------------------------------------------------------------------------

XSig Documentation
==================

Program and documentation are (C) Copyright 1994 by Jürgen Weinelt.

IMPORT StdDisclaimer; (* in short: use it at your own risk *)
XSig was carefully tested, but there's certainly plenty of room for bugs.

XSig is Freeware, non-commercial distribution is o.k. as long as the
following conditions are met:

  * Source, executable and documentation must be distributed together and
    these files must be intact (you're not allowed to make changes).
    You're NOT allowed to add files to the archive.

  * This program may be included on PD/freeware CDs if I am allowed to
    order one of those CDs at 50% off the retail price (or cheaper :).
    Of course a free copy of the CD would be even nicer...

    Exception: Fred Fish has UNCONDITIONAL permission to add this
    program version to his library, no matter if he's distributing it
    on floppy disk or on CD.



XSig requires AmigaOS V37 or later (that's 2.04 or later).



Purpose
=======
XSig forms a news/mail signature by combining a fixed (name, address)
and a variable (cookie, funny quote) part. Both parts are selected
depending on a keyword ("group name").



Installation
============
To create a standard installation of XSig, you need to do the following:

- copy the "XSig", "XSigIDX" and "XSigGetGroup" binaries to a directory in
  your search path (preferably "uubin:")
- copy "XSig.data" to "uulib:"
- read _and_understand_ "FileSpecs.txt" ;-)
- edit "uulib:XSig.data"
- create a subdirectory "uulib:XSig"
- copy your cookie file(s) (see FileSpecs.txt) to "uulib:XSig"
- run XSigIDX on your cookie file(s) to create the index and pointer
  file(s)

That's it.



Usage
=====
XSig DATA/K,GROUP/K,QUIET/S,STDERR/S,NEXTSIG/S

DATA
----
Selects the config file. Default: uulib:XSig.data

GROUP
-----
The cookie selection keyword, a.k.a. "newsgroup name". No default.

QUIET
-----
Suppress startup message.

STDERR
------
Send error messages to the CONSOLE: instead of the standard output
stream.

NEXTSIG
-------
Get a new cookie; if you omit this, repeated calls to XSig will return
the same cookie over and over again.



Examples
--------
Call "XSig GROUP <groupname> NEXTSIG QUIET" to get a cookie.

Use "XSig >>article ..." to append the signature to a posting.

Look at the "XSIGEDIT" script. Ideally you just need to set
this as "NEWSEDITOR" in your "uulib:config" file.

Put "XSig >uulib:.sig-of-the-day ..." into a crontab to get a new
signature periodically.



History
=======
1.1     fixed a bug (typo, actually) in the STDERR template. Oops. *blush*
1.0     (a.k.a. 0.43) first release
0.37    second beta
0.35    first beta distribution



Known problems/bugs
===================
None.



If you have questions or bug reports...
=======================================
You can contact me by eMail:

   jow@rz.uni-wuerzburg.de (preferred)
   jow@hcast.franken.de
   jow@hcast.adsp.sub.org (avoid if possible)

Or through the snail mail:

   Jürgen Weinelt
   Franz-Ludwig-Strasse 10
   D-97072 Würzburg
   Germany



Thanks
======

The following persons reported bugs and/or suggested new features:

Michael-Wolfgang Hohmann
   Karl "Charly" Skibinski

Thank you.