home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / banditv2.zip / bandit.doc < prev    next >
Text File  |  1998-02-24  |  17KB  |  452 lines
  1. ┌─────────────────────────────────────────────────────────────────────────────┐
  2. │                          * Bandit Tagger *                                  │
  3. │                            Version  2.00                                    │
  4. │                       ╕FA Partners 1997, 1998                               │
  5. └─────────────────────────────────────────────────────────────────────────────┘
  6.  
  7. Table of Contents
  8. ──────────────────
  9.  
  10. 1.0 Introduction
  11.   1.1 Disclaimer
  12.   1.2 What is new.
  13.   1.3 Installation
  14.     1.3.1 Internet Adventure
  15.     1.3.2 PMMail & PMINews
  16.     1.3.3 Post Road Mailer
  17.     1.3.4 MR/2 Internet Cruiser Edition for OS/2
  18.     1.3.5 Netscape 2.02 for OS/2
  19. 2.0 Taglines
  20.   2.1 Random tags
  21.   2.2 Manual tag
  22.   2.3 Multiple line tags
  23.   2.4 Adding taglines to the tagfile
  24. 3.0 X-Mailer Lines
  25. 4.0 X-Newsreader lines
  26. 5.0 X-Tag
  27. 6.0 User setup.
  28.   6.1 Files
  29.   6.2 User
  30.   6.3 Netscape
  31.   6.4 Register
  32. 7.0 In the future.
  33. 8.0 Known problems.
  34. 9.0 Bug Reports / Contacting the author
  35.  
  36.  
  37.   1.0 Introduction:
  38.   ─────────────────
  39.  
  40.   Bandit Tagger is a tool to add taglines to your outgoing mail, and
  41.   newsgroups posts.
  42.   The taglines can be selected random or manually.
  43.   It is also enables you to change the X-Mailer & X-Newsreader line in
  44.   the header section.
  45.  
  46.  
  47.  
  48.     1.1 Disclaimer
  49.     ──────────────
  50.  
  51.     This software is provided "as is". The author are not
  52.     responsible for any damage done to data on your harddrive,
  53.     related to Bandit Tagger, or not.
  54.  
  55.     Bandit Tagger supports :
  56.     Internet Adventure           1.01+
  57.     SouthSide Software - PMMail  1.91+
  58.     SouthSide Software - PMINews 1.00+
  59.     Innoval            - Post Road Mailer   2.00+
  60.     Knight Software    - MR/2 Internet Cruiser Edition for OS/2 v1.30a+
  61.     Netscape           - Netscape 2.02 for OS/2
  62.  
  63.     1.2 What is new.
  64.     ────────────────
  65.     Version 2.00
  66.       NEW:
  67.       - Bandit Tagger now supports Netscape 2.02 for OS/2 completely
  68.         seamless. The installation program asks you, if you want Bandit Tagger
  69.         in your start-up folder.
  70.       - Option to change your X-Tag to be anonymous.
  71.  
  72.     Version 1.27a
  73.       BUG:
  74.       - Thread error. The registration code, wasn't compiled with the multi
  75.         thread option, which caused the program to crash when using threads.
  76.     Version 1.27
  77.       NEW :
  78.       - The possibility to remove the x-mailer or the x-news line in the header.
  79.         This is for those who registered thier e-mailer or news reader only.
  80.       - Register tab in the user setup. If you send us a post card, we'll send you
  81.         a key. (Remember to write your e-mail address on the card.)
  82.         If you do this before PMMail 98 for Windows is released, you will also get
  83.         a key to the Windows version of Bandit Tagger. After the release of
  84.         PMMail 98, Bandit Tagger togther with Bandit Adder will be sold for 10$.
  85.         (Windows version only. The OS/2 version is still free :-)
  86.       - X-Tag: Inserts a X-Tag line in the header. This line will show the version
  87.         number of Bandit Tagger, and who it is registered to. This line will also
  88.         be removed when removing the X-Mailer or X-News line.
  89.     Version 1.26
  90.       BUG :
  91.       - Performance bug. Recounted the tagfile each run. Sorry :-(
  92.     Version 1.25
  93.       NEW :
  94.       - Tag selection method. Tags can be inserted either randomly
  95.         or sequential.
  96.       BUG :
  97.       - Manual selection didn't work properly when using wysiwyg tag files.
  98.       - Manual selected tags, when using on oneline tag files, didn't translate
  99.         the fake newline characters into real newline characters.
  100.       - Displayed the multiple line tags as one line, when using oneline
  101.         tag files.
  102.     Version 1.20
  103.       NEW :
  104.         - Enables the user to have either one line tags in the tag files, or use
  105.         'wysiwyg' tag files, where the tags are separated by a blank line.
  106.         The file 'wysiwyg.ta_' has been include to show the principle behind
  107.         wysiwyg files.
  108.         - Improved installation program.
  109.         (Supports Internet Adventure & MR/2 Internet Cruiser Edition for OS/2)
  110.       BUG :
  111.         - Inserted user defined X-Mailer & X-Newsreader if the user didn't use
  112.         current version of the mail client.
  113.  
  114.     Version 1.10
  115.       NEW :
  116.       - Displays the multiple lines tags with multiple lines in the tag viewer.
  117.       - Add X-Newsreader to the user page.
  118.     Version 1.00
  119.       First release.
  120.  
  121.     1.3 Installation
  122.     ────────────────
  123.  
  124.     To install Bandit Tagger, just run the install.cmd.
  125.     The install.cmd prompt you where to install Bandit
  126.     Tagger. It also creates an icon in either your Internet
  127.     Adventure folder, PMMail folder or desktop.
  128.  
  129.       1.3.1 Internet Adventure
  130.       ────────────────────────
  131.       To use Bandit Tagger with Internet Adventure do the following :
  132.       1. Insert tag(s) from the menu bar.
  133.          When composing a mail insert ex. !os2.tag in the mail then
  134.          File->Run external utility program->
  135.          then insert the path ex. 'E:\TOOLS\INETADV\BANDIT\BANDIT.EXE'
  136.          Which will launch the Bandit Tagger and you can see the result
  137.          before sending the mail.
  138.          It is also possible to create a toobar button, which launches
  139.          Bandit Tagger.
  140.  
  141.       2. Insert tag(s) via a filter.
  142.          Create a new filter and call ex. Bandit. To create a filter do the
  143.          following :
  144.          Settings->Filters->Add->Bandit
  145.          Deselect Incoming news & mail.
  146.          Select Outgoing mail & news.
  147.          Add condition :
  148.            Where to search : Message Body
  149.            What to search for : !
  150.          Actions :
  151.            Select Execute REXX
  152.            insert ex. 'E:\TOOLS\INETADV\BANDIT\BANDIT.CMD'
  153.          You can either create a signature file where ex !os2.tag is in, or you
  154.          can insert the ex. !os2.tag when ever you want a random & manual tag
  155.          inserted.
  156.  
  157.       1.3.2 PMMail & PMINews
  158.       ──────────────────────
  159.       To use Bandit Tagger under SouthSide's PMMail goto the
  160.       main window. Then open Account->Utilities Settings->REXX,
  161.       click the 'Message Send Exit' and insert the path and
  162.       filename of Bandit Tagger. The same procedure goes for PMINews.
  163.       ex. 'E:\TOOLS\PMMAIL\BANDIT\BANDIT.EXE'
  164.  
  165.       1.3.3 Post Road Mailer
  166.       ──────────────────────
  167.       When using Bandit with Innovals Post Road Mailer do the
  168.       following :
  169.       File->Settings->User Exists
  170.       Insert the path and file name :
  171.       ex. 'E:\TOOLS\POSTROAD\BANDIT\BANDIT.EXE'
  172.       Click on exit is active.
  173.  
  174.       1.3.4 MR/2 Internet Cruiser Edition for OS/2 v1.30a
  175.       ───────────────────────────────────────────────────
  176.       When using Bandit Tagger with MR-ICE do the following :
  177.       Utilities->Filer Maintenance->New
  178.       Insert data in the following sections :
  179.       Criteria :
  180.         Description : Bandit Tagger
  181.         Search Areas For : Unclick 'All areas', click 'Body' insert !
  182.       Filer Type :
  183.         Select 'PreSend'
  184.       All other options on this page are valid.
  185.  
  186.       Actions :
  187.         Click 'Link to rexx', insert the path to the bandit.cmd or click
  188.         on browse button to find the bandit.cmd file.
  189.  
  190.       To launch the Bandit Tagger every time you send a e-mail do :
  191.       Utilities->Edit Signature file->
  192.       insert ex. !os2.tag
  193.  
  194.       Or you can insert the !os2.tag manually directly in the mail.
  195.  
  196.       Please notice that Bandit Tagger can't change the X-Mailer in MR/2
  197.       Internet Cruiser Edition for OS/2.
  198.  
  199.       Please start Bandit Tagger from the Internet Adventures, PMMail or desktop
  200.       folder to insert the user preferences. (See section 4.0)
  201.  
  202.       1.3.5 Netscape 2.02 for OS/2
  203.       ────────────────────────────
  204.       To make Bandit Tagger work togther with Netscape/2 you must place the
  205.       file hookdll.dll in your libpath. Then start Bandit Tagger with the
  206.       parameter /n, or use the Bandit Tagger for Netscape icon. That is it.
  207.  
  208.       Use the Bandit Tagger icon to set your preferences. Ex. set
  209.       'Display tag(s) in miliseconds' to 0 to avoid having to wait
  210.       before Bandit Tagger sends your e-mail.
  211.  
  212.       To make Bandit Tagger insert a tagline, you must insert a tag that
  213.       Bandit Tagger can recognize. ex. !os2.tag. Of course, this can
  214.       also be inserted into your signature file.
  215.  
  216.       Bandit Tagger can't change the X-Mailer when using it togther with
  217.       Netscape/2.
  218.  
  219.       Since there is no way to see if your are a registered user when using
  220.       Netscape/2, like the X-Tag when using other e-mail clients, Bandit Tagger
  221.       inserts :
  222.       ** Tag(s) inserted by Bandit Tagger v2.00 - http://www.gbar.dtu.dk/~c918704
  223.       at the bottom of your e-mail. This will disappear when your send us a
  224.       post card, and we send you a registration code :-)
  225.  
  226.  
  227.   2.0 Taglines
  228.   ────────────
  229.  
  230.   Bandit Tagger works by analysing your mail. When it incounters
  231.   tagfilenames with a preceeding ! it insert a tagline (ex. !os2.tag).
  232.   Bandit Tagger is NOT case sensitive.
  233.   This has been done to enable you to group your taglines.
  234.  
  235.   Personally I have :
  236.   'Computer Tags' -> !os2.tag
  237.   'Joke Tags'     -> !my.tag
  238.  
  239.   PLEASE NOTE : The files has to have *.tag extension.
  240.  
  241.   So when inserting a signature write :
  242.   !filename.tag
  243.   Ex. signature :
  244.     --
  245.     -- FA Partners
  246.     -- c918704@student.dtu.dk
  247.  
  248.     !my.tag
  249.  
  250.   Bandit Tagger will replace the '!my.tag' with a line from the
  251.   tagfile 'my.tag'
  252.  
  253.  
  254.   You can insert as many tagfile in your signatures as you want.
  255.  
  256.   The first time you run Bandit Tagger it inserts a number
  257.   in the top of the tagfile. (Unless there is a number already.)
  258.   This number tells how many lines there are in the file. This is
  259.   done for performance reasons. Bandit Tagger also creates a ini
  260.   file. This inifile registers the date, time & size of the tagfile.
  261.   If any of these informantions have changed, the tagfile is
  262.   being recounted.
  263.  
  264.     2.1 Random tags
  265.     ───────────────
  266.     Default is that Bandit Tagger inserts a random tagline from your
  267.     tagfile.
  268.  
  269.     2.2 Manual tag
  270.     ───────────────
  271.     It is posible to select a tag manually. This is done by creating
  272.     a signature with the manual tagname - default is 'manual.tag'
  273.     This will launch a notebook with all the tagfiles in the specified
  274.     tagfiles path.
  275.     Just select the line you want to have inserted.
  276.  
  277.     2.3 Multiple taglines
  278.     ─────────────────────
  279.     It is also possible to have multiple line tags in your tag file.
  280.     In the 'User setup' you specify what the newline character should
  281.     look like. Default is "^".
  282.     Bandit Tagger will change these characters with a real newline charater.
  283.  
  284.     2.4 Adding tagline to the tagfile
  285.     ──────────────────────────────────
  286.  
  287.     Adding new tags to the tagfiles are as easy as using your
  288.     favorite editor. Just open the tagfile and insert the new tag
  289.     line(s). Bandit Tagger will automatically recount the tagfile.
  290.  
  291.     Or you can use Bandit Adder to insert tag lines into your tag files.
  292.  
  293.  
  294.   3.0 X-Mailer
  295.   ────────────
  296.  
  297.   Bandit Tagger also enables you to change the X-Mailer line.
  298.   Just insert the new X-Mailer line in the 'User setup'.
  299.   Bandit Tagger will only insert your new X-Mailer if you have
  300.   registred Internet Adeventure or PMMail. This function will always
  301.   work when using Innvoval PRM. The reason for this is that PRM uses
  302.   the same X-Mailer in the registered version as in the unregisterd version.
  303.  
  304.   4.0 X-Newsreader
  305.   ────────────────
  306.  
  307.   Bandit Tagger also enables you to change the X-Newsreader line.
  308.   The X-newsreader line works exactly like the X-Mailer line.
  309.  
  310.   5.0 X-Tag
  311.   ─────────
  312.  
  313.   If you are a registered user of Bandit Tagger, and do not want your name
  314.   in the X Tag line, write '!anonymous' anywhere in your e-mail. This will
  315.   replace the default -
  316.   X-Tag: Bandit Tagger v2.00 - Registered to : John Doe
  317.   to
  318.   X-Tag: Bandit Tagger v2.00 - Registered user
  319.  
  320.  
  321.   6.0 User setup
  322.   ──────────────
  323.  
  324.   When opening Bandit Tagger from the Internet Adventure, PMMail
  325.   or dekstop folder a notebook appears where you can configure the following :
  326.  
  327.     6.1 Files.
  328.     ──────────
  329.  
  330.     Tagfiles path                       :
  331.  
  332.     Insert the path to your tagfiles. You can select browse and select
  333.     one of your tagfiles. Bandit Tagger will automatically cut the filename
  334.     off.
  335.  
  336.     Multiple taglines                   :
  337.  
  338.     The fake newline character(s). Default "^". When this fake newline charrater
  339.     is encountered in a tagline it's replaced with a real newline character.
  340.  
  341.     Or select "Not me, I'm using multiple lines in my tag files.", to use the new
  342.     'wysiwyg' tag files. Please note it is not possible to use one line tags and
  343.     'wysiwyg' at the same time.
  344.  
  345.     Tag selection method.
  346.  
  347.     Select 'Random' to have the tags inserted randomly (default). 'Sequential'
  348.     will insert the tags from number 1 to the last tag, and then start all
  349.     over.
  350.  
  351.     Manual tagname                      :
  352.  
  353.     Bandit Tagger search for this name in the mail and launches the manual selection.
  354.  
  355.     6.2 User.
  356.     ─────────
  357.  
  358.     Display tag(s) in millisecs         :
  359.  
  360.     The amount of time the selected tag(s) are displayed in milliseconds.
  361.     1000 = 1 secs.
  362.     A value of 0 will disable this feature.
  363.  
  364.     Remove X-Mailer :
  365.  
  366.     When enabled this feature removes the X-Mailer line from the e-mails header.
  367.     It also removes the X-Tag line inserted by Bandit Tagger.
  368.  
  369.     New X-Mailer (Registered e-mail clients only.) :
  370.  
  371.     Insert a new X-Mailer in the mail header.
  372.     Again - this is for registred users of Internet Adventure
  373.     and PMMail only. (PRM Users can always change the X-Mailer)
  374.     NOTICE - Default X-Mailer is either :
  375.  
  376.     For Internet Adventure :
  377.       Internet Adventurer v1.20 for OS/2 with Bandit Tagger v2.00
  378.     or
  379.       Internet Adventurer v1.20 for OS/2 - Unregistered with Bandit Tagger v2.00
  380.  
  381.     For PMMail :
  382.       PMMail 1.95a for OS/2 with Bandit Tagger v2.00
  383.     or
  384.       PMMail 1.95a Evaluation Version For OS/2 (Unregistered) with Bandit Tagger v2.00
  385.  
  386.     Remove X-News :
  387.  
  388.     When enabled this feature removes the X-News line from the news client.
  389.     It also removes the X-Tag line inserted by Bandit Tagger.
  390.  
  391.     New X-Newsreader (Registered news clients only.) :
  392.  
  393.     Insert a new X-Newsreader in the a newsgroup post header.
  394.     (See "New X-Mailer (Registered e-mail clients only.)" for more information.
  395.  
  396.     Advertice for Bandit Tagger:
  397.  
  398.     When enabling this feature, Bandit Tagger inserts a footer in your e-mail.
  399.     It looks somewhat like this :
  400.     "** Tag(s) inserted by Bandit Tagger v2.00 - http://www.gbar.dtu.dk/~c918704"
  401.     Bandit Tagger will always insert a footer into Netscape/2, until you have
  402.     registered Bandit Tagger.
  403.  
  404.     6.3 Netscape
  405.     ────────────
  406.     If you do not want Bandit Tagger for Netscape in your Window List, go to this
  407.     page and deselect the option :
  408.     'Yes, I want 'Bandit Tagger for Netscape' in my Window List'
  409.  
  410.     6.4 Register
  411.     ────────────
  412.     If you send us a post card, we'll send you a registration code. Insert your
  413.     name and registration code on this page.
  414.  
  415.  
  416. 7.0 In the future
  417. ─────────────────
  418.  
  419. We do not currently have any future plans for Bandit Tagger,
  420. but that is because we personally do not have anymore ideas.
  421. So I you have any ideas please e-mail FA Partners.
  422.  
  423.  
  424. 8.0 Known problems.
  425. ───────────────────
  426.  
  427. Some computers seems to release the cmd file before Bandit Tagger has
  428. completed. This results in the mail being send without a tag.
  429. To solve this problem use the bandit.cmd instead of the bandit.exe
  430. Thanks goes to Valery Kornienkov for supplying St-art for OS/2
  431.  
  432. 9.0 Bug Reports / Contacting the author
  433. ───────────────────────────────────────
  434.  
  435. All Bug reports should be sent to FA Partners.
  436.  
  437. FA Partners :
  438.  
  439. The author of Bandit Tagger : Flemming Bregnvig.
  440. Homepage owner              : Anders Thue Pedersen.
  441.  
  442. Homepage : www.gbar.dtu.dk/~c918704/
  443.  
  444. e-mail   :
  445.  
  446. FA Parterns          - fa-partners@usa.net
  447. Flemming Bregnvig    - bregnvig@usa.net
  448. Anders Thue Pedersen - anderst@usa.net
  449.  
  450. Send a mail to fa-partners@usa.net with subject: Subcribe
  451. to automatically recieve information about FA Partners products.
  452.