@database 002feeb8-0
@master GMSignature.guide
@$VER: 5.0
@author "Gian Maria Calzolari"
@(c) "1999"
@index Main
@width 77
@remark Created with Heddley v1.20ß © Edd Dumbill 1994-5

@node "Main" "GMSignature"

                           @{b}GMSignature.thor v5.0@{ub}

                       (c) Gian Maria Calzolari, 1999
                            gcalzo@geocities.com


       @{" Introduction " link "Introduction" 0}

       @{" Configuring GMSignature " link "Configuration" 0}

       @{" Using from Thor " link "Thor" 0}

       @{" Distribution " link "Distribution" 0}

       @{" History " link "History" 0}
@endnode

@node "Introduction" "Introduction"

                       @{b}@{u}Introduction@{ub}@{uu}


Tired of not being able to use an external pgm to create message tags? :-)

GMSignature.thor will let you add an external file as message signature and
execute an external program to create the tag!!

It is intended to be called from Thor as @{i}Signature command@{ui}.

Of course it needs to be correctly @{"configured" link "Configuration" 0} before you can use it.
@endnode

@node "Configuration" "Creating a Configuration entry"

                      @{b}Configuring GMSignature@{ub}


One-time: see @{"Using from Thor" link "Thor" 0}.


In ENV:Thor/ there must be a file called as @{b}system-name@{ub}_S.cfg, i.e. for a
System named @{b}Internet@{ub} a file @{b}ENV:Thor/Internet_S.cfg@{ub} must be created.

The '@{b}_S@{ub}' has to be used to avoid name duplication with GMCleanConf
configuration file (which ends with '@{b}_C@{ub}'). This means that a System name
@{u}should not be longer than 24 chars@{uu}!

When GMSignature is called, it gets both System and Conference names from
Thor then opens the .cfg file for the System and lookups for the Conference
tag.

If the file is missing the script will simply exit immediately, if exists but
a tag for the Conference is not there a DEFAULT tag must be configured.


The options are:

TAG   @{"pattern" link "Pattern" 0} string
    SigFile     string
    TagPgm      string      (optional, default @{i}blank@{ui})
    TagPgmType  number      (optional, default @{i}zero@{ui})


Which do the following; please note that if a string contains one or more
spaces it must be enclosed in quotes (@{b}"@{ub}) and optionals options can, of course
:-), be omitted.

TAG
    It must be the Conference name as configured within the system or, using
    the char @{b}*@{ub}, a Conference @{"pattern" link "Pattern" 0}.

SigFile
    Signature file to be appended to the message.

TagPgm
    It's the external pgm that can be used to create a tag for the message.
    If used it @{u}must@{uu} write to stdout! The output will be after the signature

TagPgmType
    Set this to @{b}1@{ub} if @{i}TagPgm@{ui} is a dos program or set it to @{b}0@{ub} (or do not
    specify the keyword!) if @{i}TagPgm@{ui} is an ARexx program.


Sample configuration

TAG   EMail
   SigFile     Thor:MyStuff/InternetSign
   TagPgm      Mail:Smiley/Smiley
   TagPgmType  1

TAG   default
   SigFile     Thor:MyStuff/InternetSignNoSpam
   TagPgm      Mail:Smiley/Smiley
   TagPgmType  1
@endnode

@node "Pattern" "Pattern"

            @{b}Using patterns as Conference name@{ub}


To avoid typing multiple time the same signature for different Conferences
you can use a simple pattern matching.

The pattern char @{b}*@{ub} can be either in front, after or both.

When using tags with patterns is better to put them after normal tags to
avoid undesiderated matches! :-)

Sample configuration

TAG   EMail
   SigFile     Thor:MyFiles/InternetSign

TAG   Special*
   SigFile     Thor:MyFiles/InternetSpecial

TAG   *(ML)
   SigFile     Thor:MyFiles/InternetMailingLists

TAG   *2hand*
   SigFile     Thor:MyFiles/InternetBuyMe

TAG   default
   SigFile     Thor:MyFiles/InternetSignNoSpam


The second tag will be used for all the Conferences @{u}starting@{uu} with @{i}Special@{ui},
the third for the ones @{u}ending@{uu} with @{i}(ML)@{ui} and the fourth for the ones that have
@{u}inside@{uu} @{i}2hand@{ui} (can be on start or end too!)
@endnode

@node "Thor" "Using with Thor"

            @{b}Using GMSignature from Thor@{ub}


One-time: you will need to run @{" ConfigThor " link "ConfigTHOR.guide/Files-Paths" 0} and put "rx
rexx/GMSignature.thor" as @{i}Signature command@{ui} into the Global or System
configuration.
@endnode

@node "Distribution" "Distribution "

            @{b}@{u}Distribution@{ub}@{uu}


GMSignature.thor is freely distributable, but remains (c) Gian Maria
Calzolari, 1999.

It may not be distribuited alone but only with the @{"GMsuite" link "GMsuite.guide/distribution" 0} archive.
@endnode

@node "History" "History"

                          @{b}@{u}History@{ub}@{uu}


@{i}17 Nov 1999@{ui} : @{b}5.0@{ub} : Nothing! Bumped up rev for consinstency with first
                    aminet release of GMsuite!

@{i}14 Nov 1999@{ui} : @{b}1.0@{ub} : version for GMsuite, changed the cfg file name to avoid
                    duplication with GMCleanConf! Now cfg name is
                    'system_name' plus '_S'

@{i}21 Oct 1999@{ui} : @{b}0.2@{ub} : Added @{"pattern" link "Pattern" 0} support for Conference name

@{i}20 Oct 1999@{ui} : @{b}0.1@{ub} : First attempt, based from mine GMAutoWrite (try it! ;-)
@endnode