home *** CD-ROM | disk | FTP | other *** search
/ PC-Online 1998 February / PCOnline_02_1998.iso / filesbbs / dos / mailx31x.exe / MAILX.DOK < prev    next >
Text File  |  1997-03-07  |  20KB  |  383 lines
  1.                                                 ___                   ;
  2.                                            ___-~''~~~~~------      ; /,
  3.                                          /         __"~~~~       ;;;;,
  4.                                         (    -,~  \\ ~~~  _    ;/;;,  ,,,
  5.                                          \|~---,  \        ``;/; _,'''~
  6.                                                .`  ;  `;';\|/  /,___--~~~--_
  7.   Copyright 1995-1997 Branislav L. Slantchev   ;   ; ;,;_~-     :/;~'''-
  8.   A Production of Silicon Creations, Inc.     ;   ; `;;'~     :/   |';`~
  9.   All Rights Reserved.                       ;    : ;,      :/     ;;;'
  10.                                              :     `'            _;;;;'
  11.                                               `_          `\______;;'
  12.                                                 ~-____,,   ;,```
  13.    _____,   ___,    ____,  __        _   __,    _---' -''`.. ,`,
  14.   (-| | |  (-|_\_, (-|    (-|       (-\_/      '-/__)--'   ``,_;,
  15.    _| | |_, _|  )   _|__,  _|__, --  _/ \_,                _,  _-
  16.   (        (       (      (         (       Version 3.0a (,~_)
  17.   ───────────────────────────────────────────────────────────────────────────
  18.   ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  19.  
  20.  
  21.  
  22.           [Topic]                                      [Keyword]
  23.  
  24.           Overview ................................... /OVERVIEW
  25.           Installation ............................... /INSTALL
  26.           Command Line Options ....................... /OPTIONS
  27.           MAILX.INI Reference ........................ /MAILX
  28.           Usage and Sample ........................... /USAGE
  29.           Caveat Emptor .............................. /DISCLAIMER
  30.           Source Code ................................ /SOURCE
  31.           Packing Slip ............................... /PACKING
  32.           Registration ............................... /REGISTER
  33.           Getting in Touch ........................... /CONTACT
  34.           Greetings and Thank You's .................. /GREETINGS
  35.           Copyrights, Trademarks, Etc. ............... /TRADEMARKS
  36.  
  37.  
  38.   o v e r v i e w                                                   /OVERVIEW
  39.   ───────────────────────────────────────────────────────────────────────────
  40.  
  41.   This is yet another quality product of Silicon Creations, Inc. and a nice
  42.   addition to your collection of ProBoard pexen. If you are not running the
  43.   ProBoard BBS package, this program will not be useful to you, so you should
  44.   probably discontiue wasting your time with this document. On the other
  45.   hand, if you are a ProBoard sysop, read on.
  46.  
  47.   mail-x is the new incarnation of the popular Mail-X program. It offers
  48.   most of the features of the previous versions, but with added flexibility.
  49.   To summarize, the new revision was aimed strictly at visual appeal. There
  50.   are virtually no hard-coded colors or layouts, everything can be configured
  51.   with the MAILX.INI setup file. The program also uses a free-form background
  52.   file which can be drawn in any software which supports text mode graphics.
  53.  
  54.   So, what is mail-x? It is a hybrid program which will enable your users to
  55.   select the areas they want included in their scans for new mail, as well
  56.   as the combined board processing. This pex completely replaces the built-in
  57.   ProBoard functions. There is a very annoying feature of the BBS which sets
  58.   all areas to ON for new mail scans when a new user logs on. Most callers
  59.   are unaware of that and wonder why the scans take so long to complete. This
  60.   program lets the callers control which areas will be checked for new mail.
  61.   As an additional bonus, the Sysop can define forced areas which will be
  62.   always set to ON regardless of the preferences of the users. This is done
  63.   in order to make it easier for Sysops to ensure that certain areas will be
  64.   checked for mail (like system announcement areas, for example). There is
  65.   no such feature in ProBoard itself.
  66.  
  67.   The second mode of operation is more or less similar to the first one
  68.   except users can manipulate the combined boards. You can setup mail-x to
  69.   operate interactively, in which case the caller is presented with a full
  70.   screen multi-colored selection menu. The program is very intuitive and
  71.   easy to use, so there should be no confusion. In the transparent mode,
  72.   mail-x lets you set or reset globally the areas. You can elect to set all
  73.   boards to on or off, or simply enable the areas defined as forced.
  74.  
  75.   mail-x fully supports UserDoes and Doing for multiline systems. Also,
  76.   if the caller does not have ANSI/AVATAR capabilities, mail-x will
  77.   automatically run the appropriate internal ProBoard routines!
  78.  
  79.  
  80.   i n s t a l l a t i o n                                            /INSTALL
  81.   ───────────────────────────────────────────────────────────────────────────
  82.  
  83.   Copy MAILX.PEX, MAILX.INI and MAILX.ANS to your PEX directory. Actually,
  84.   the .ANS file (which is the background screen) does not have to go there.
  85.   You can place it anywhere on your system and name it anything you want,
  86.   just make sure you update the DisplayFile field in the MAILX.INI file so
  87.   that the program can find it.
  88.  
  89.   The second step is to edit your menu setup. There are two ways in which
  90.   you can install mail-x. On of them is to use the TOP menu with the
  91.   transparent mode if you want to force areas on or off. You would simply
  92.   use Function 60 (Execute SDK File) and the data will be on of the
  93.   following lines (note the explanations or each one of them):
  94.  
  95.             MAILX /G ON        ; this forces all areas to ON
  96.             MAILX /G OFF       ; this forces all areas to OFF
  97.             MAILX /G FORCED    ; turn on all areas defined as forced
  98.             MAILX /C /G ON     ; turn on all combined boards
  99.             MAILX /C /G OFF    ; turn off all combined boards
  100.             MAILX /C /G FORCED ; turn on all forced combined areas (??)
  101.  
  102.   The last three command lines are not very useful, but some people find
  103.   them necessary.
  104.  
  105.   The other way to install mail-x (and this is the recommended setup), is
  106.   to have it as a separate menu item. The data line should be 'mailx' without
  107.   any parameters. This will launch mail-x in its interactive full-screen
  108.   mode. Note that your callers have to have either ANSI or AVATAR terminal
  109.   emulation enabled. If mail-x detects a caller with an ASCII terminal, it
  110.   will note this in your PROBOARD.LOG file and will then ProBoard's internal
  111.   selector function (depending on the mode requested). This way you don't
  112.   have to worry about ASCII users not getting what they need. Note that this
  113.   only applies to the interactive mode. Terminal emulation does not matter
  114.   for the transparent operation.
  115.  
  116.   Of course, only the areas to which the user has read access will be shown
  117.   in the program. Also note that only the first 1,000 areas are available
  118.   for use. This is a limitation of ProBoard which despite supporting 10,000
  119.   areas, can only store the information for the first 1,000.
  120.  
  121.   If, for some strange reason, mail-x does not seem to work and simply
  122.   exits when run, check your PROBOARD.LOG file for possible errors. All
  123.   error conditions will be logged there.
  124.  
  125.  
  126.   c o m m a n d   l i n e   o p t i o n s                            /OPTIONS
  127.   ───────────────────────────────────────────────────────────────────────────
  128.  
  129.   If you want to use mail-x in its most common way, there are no command-line
  130.   options to worry about, except possibly for one (/C). Note that the options
  131.   are not case sensitive, and can be preceded by a dash ('-') or a forward
  132.   slash ('/'). You should separate options with one or more blanks, but
  133.   there should be no whitespace between the option switch and the letter.
  134.  
  135.       /C
  136.           Combined boards mode of operation. By default, mail-x works on
  137.           the new mail scan areas. This option is used to force mail-x to
  138.           operate as a replacement for function 28.
  139.  
  140.       /G [ON|OFF|FORCED]
  141.           Global mode. This turns off the interactive features and causes
  142.           mail-x to run transparently. The user will not be notified of any
  143.           action that takes place. You can use only on of the three option
  144.           parameters:
  145.  
  146.               ON
  147.                   Turn all areas on in the user record
  148.  
  149.               OFF
  150.                   Turn all areas off in the user record (including forced)
  151.  
  152.               FORCED
  153.                   Turn on all areas marked as forced in the MAILX.INI file
  154.  
  155.       /D [USERDOES|DOING]
  156.           Drop file. You can choose what kind of information file should
  157.           mail-x use. This feature is useful for multinode systems where
  158.           there exist programs which report the status of other nodes. You
  159.           can choose the format of drop file depending on the program you
  160.           have set up on your system:
  161.  
  162.               USERDOES
  163.                  UserDoes (DqP, Eddie Van Loon's program). This option
  164.                  creates a UserDoes.<node> file with a brief information
  165.                  about what the user is currently up to.
  166.  
  167.               DOING
  168.                  Creates a drop file compatible with Fe-line's Doing
  169.                  program. If the file already exists, the proper record
  170.                  will be updated.
  171.  
  172.           By default, mail-x does not create any information drop files.
  173.  
  174.  
  175.   m a i l x . i n i   r e f e r e n c e                                /MAILX
  176.   ───────────────────────────────────────────────────────────────────────────
  177.  
  178.   Previous versions of mail-x used data stored in the mail-x domain in the
  179.   SILICON.INI file. This version departs from this approach. The reason is
  180.   speed. There are too many options that need to be loaded from the INI
  181.   file and a bigger file means slower execution. Note that the .INI file
  182.   must be placed in the same directory as the executable (usually, your
  183.   ProBoard PEX directory) and must have the same name as the PEX (just a
  184.   different extension .INI). This means that if you choose to rename the
  185.   pex, you will have to rename the .INI file too.
  186.  
  187.   This file is a standard ASCII text file. There is a sample MAILX.INI
  188.   which is included with the distribution. It is fully annotated, so please
  189.   refer to it for more information.
  190.  
  191.   The keywords must begin in column 1 on each row. They are not case-
  192.   sensitive. The keyword is followed by an equal ('=') sign which can
  193.   be (optionally) surrounded by whitespace. The data for the keyword is
  194.   after the equal sign.
  195.  
  196.   There are several boolean options. These you can set with the words
  197.   'True', 'False', with the numbers 0 (False) and 1 (True) or you can
  198.   set the keyword to False by simply commenting it out.
  199.  
  200.   Colors are somewhat more complicated. Color attributes are specified
  201.   with decimal numbers. Use the table below to obtain the values:
  202.  
  203.   Black = 0   Red     = 4   Dark Gray   = 8    Light Red     = 12
  204.   Blue  = 1   Magenta = 5   Light Blue  = 9    Light Magenta = 13
  205.   Green = 2   Brown   = 6   Light Green = 10   Yellow        = 14
  206.   Cyan  = 3   Gray    = 7   Light Cyan  = 11   White         = 15
  207.  
  208.   To get a color, use the number for the color. To get a combination of a
  209.   foreground-background color, multiply the color you want for background
  210.   by 16 and then add the foreground to it. Note that you can use only colors
  211.   0-7 for background. The values above will cause blinking (you can use
  212.   that too if you like it :-) If you want to force blink, add 128 to the
  213.   attribute you have selected:
  214.  
  215.         Yellow on Blue         = 14 + 1 * 16       = 30
  216.  
  217.         Blinking Black on Cyan =  0 + 3 * 16 + 128 = 176
  218.  
  219.         LightCyan on Dark Grey = 11 + 8 * 16       = 139
  220.            (note that the result is NOT what you expected. This is
  221.            because you cannot use colors greater than 7 for the
  222.            background attribute)
  223.  
  224.  
  225.   u s a g e   a n d   s a m p l e                                      /USAGE
  226.   ───────────────────────────────────────────────────────────────────────────
  227.  
  228.   mail-x comes preconfigured with a sample MAILX.ANS file. The built-in
  229.   settings are tailored for this particular background screen. It is very
  230.   pretty and probably most Sysops will choose to stay with it. If not,
  231.   there are several things you need to be aware of.
  232.  
  233.   First, the command-bar item strings are not definable. You can move the
  234.   location of the command bar, but you cannot modify the text in it. This
  235.   is a shortcoming that is easily rectified, but which (if implemented)
  236.   would slow mail-x down considerably. I have debated whether to make it
  237.   as configurable as it is now for the same reasons (not to mention bloating
  238.   of the executable).
  239.  
  240.   Another feature (this is a nice one), is the background screen file. This
  241.   need not be limited to ANSi format. Since mail-x does not use ProBoard's
  242.   file display functions, it is not limited to the formats it can display.
  243.   The built-in interpreter can handle ANSi, Avatar, PCBoard and Widlcat!
  244.   format files. So, if you happend to have a picture you like in any of
  245.   these formats, simply use it, there is no need for conversions!
  246.  
  247.   Here's the setup used at the Silicon Creations BBS. In the TOP menu,
  248.   there are two entries, both are autoexecutable:
  249.  
  250.       MAILX /G OFF       ; for maximum user level 100 (new users)
  251.       ; entry which upgrades new users to security level 200
  252.       MAILX /G FORCED    ; for all users
  253.  
  254.   Then, on the mail/message menu, there are two other items:
  255.  
  256.       MAILX /D DOING     ; select mail areas for new mail scan (with Doing)
  257.       MAILX /C /D DOING  ; select combined boards (Doing suport)
  258.  
  259.   As you can see, mail-x is pretty versatile and easy to use.
  260.  
  261.  
  262.   c a v e a t   e m p t o r                                       /DISCLAIMER
  263.   ───────────────────────────────────────────────────────────────────────────
  264.  
  265.   mail-x (all executables, documentation, source, and sample files) are
  266.   Copyright (c) 1985-1997 Branislav L. Slantchev. A fine production of
  267.   Silicon Creations, Inc.
  268.  
  269.   This program is free software; you can redistribute it and/or modify it
  270.   under the terms of the GNU General Public License as published by the Free
  271.   Software Foundation; either version 2 of the License, or any later version.
  272.  
  273.   This program is distributed in the hope that it will be useful, but WITHOUT
  274.   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  275.   FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  276.   more details.
  277.  
  278.   You should have received a copy of the GNU General Public License along
  279.   with this program (the COPYING.DOC file); if not, write to the Free
  280.   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  281.  
  282.  
  283.   s o u r c e   c o d e                                               /SOURCE
  284.   ───────────────────────────────────────────────────────────────────────────
  285.  
  286.   The complete C++ source code for mail-x is freely available. It is released
  287.   in a separate archive in order to conserve space and to avoid burdening
  288.   people with things they do not necessarily want. The name of the source
  289.   code package is formed as MAILXnnS.RAR where 'nn' is the revision number.
  290.   For example, for version 3.0, the file will be named MZILX30S.RAR.
  291.  
  292.   Note that you will need PB-Lib v3.0 or later in order to compile the pex.
  293.  
  294.   Since the source code uses PB-Lib exclusively, you can compile it to a
  295.   regular MS-DOS(tm) executable (this is exactly how it was initially
  296.   developed). The code has been tested with Borland C++ 3.1 and might not
  297.   (although it should) work with different compilers. A makefile is
  298.   provided for compiling the PEX version, and a project file for building
  299.   the regular standard executable.
  300.  
  301.   The source code is subject to the terms and conditions outlined in the
  302.   file Copying.Doc distributed with it. It is basically free for any use
  303.   but it remains copyrighted by Branislav L. Slantchev.
  304.  
  305.  
  306.   p a c k i n g   s l i p                                            /PACKING
  307.   ───────────────────────────────────────────────────────────────────────────
  308.  
  309.   The files in this archive has been compressed with RAR Version 2.0 with
  310.   a security envelope. The reason for this format is quite simple - it
  311.   compresses far better than ZIP (not as fast, though). When you unpack the
  312.   files, you should see the following message at startup:
  313.  
  314.       Verifying authenticity information ... Ok
  315.  
  316.   and then (when the process is complete, you should see the following):
  317.  
  318.       Archive MAILX30X.RAR
  319.       created at hh:mm:ss    dd mmm yyyy
  320.       by Silicon Creations, Inc.
  321.  
  322.   If you don't see these messages, the archive has most likely been tampered
  323.   with and you should obtain a fresh copy. Note that I have had problems with
  324.   people modifying the archives before and that is why I strongly suggest
  325.   you take every precaution possible to prevent malicious "hackers" from
  326.   wreaking havoc on your computer. For all those "hackers", I can feel
  327.   nothing but pity... maybe some day they will learn how to do something on
  328.   their own... something creative. Until that time, we must protect ourselves.
  329.  
  330.  
  331.   r e g i s t r a t i o n                                           /REGISTER
  332.   ───────────────────────────────────────────────────────────────────────────
  333.  
  334.   Of course, no registration is necessary for this program. It is being
  335.   distributed as freeware (meaning that I retain the copyright but you
  336.   are allowed to use mail-x without paying me any money). Go figure. Since
  337.   some people have expressed desire to contribute to Silicon Creations,
  338.   I hereby officially notify everyone that donations are accepted. You can
  339.   also request custom programs for a nominal fee. I reserve the right to
  340.   refuse anything sent to me or any request made for programming. Priority
  341.   will be given to projects that bring $$$. Ah, if you strongly feel like
  342.   contributing but you are not able to afford sending money, it's ok. Send
  343.   me a post card of your home town, I would really appreciate it. If you
  344.   can't afford that... have a beer on my behalf :-)
  345.  
  346.  
  347.   g e t t i n g   i n   t o u c h                                    /CONTACT
  348.   ───────────────────────────────────────────────────────────────────────────
  349.  
  350.   Due to the lengthy nature of the topic, it has been moved to a separate
  351.   file. Read Support.Doc for details on how to get in touch with me. Also,
  352.   read the file FAQ.Doc for some questions people frequently ask me and
  353.   the answers to them.
  354.  
  355.  
  356.   g r e e t i n g s                                                /GREETINGS
  357.   ───────────────────────────────────────────────────────────────────────────
  358.  
  359.   Greetings go to the following: Philippe Leybaert (what a novel idea!),
  360.   Ruben Provoost (JMJ), Wim Jans, Olivier Debonne, Timothy Bryant,
  361.   Arthur Stark, Chuck King, Tiago Pascoal, and many others whose names
  362.   have slipped my mind while writing this document.
  363.  
  364.   Of course, special thanks goes to the faithful support and distribution
  365.   sites all around the world. You have been great, guys and gals! We have
  366.   done it once again.
  367.  
  368.  
  369.   c o p y r i g h t s ,   t r a d e m a r k s ,    e t c .       /TRADEMARKS
  370.   ──────────────────────────────────────────────────────────────────────────
  371.  
  372.          mail-x ............................. Branislav L. Slantchev
  373.          PB-Lib ............................. Branislav L. Slantchev
  374.          ProBoard ........................... Philippe Leybaert
  375.          UserDoes ........................... Eddie Van Loon
  376.          Doing .............................. Fe-line Software
  377.          Borland C++ ........................ Borland International
  378.  
  379.   All other programs and products mentioned above are property of their
  380.   respective owners. Mentioning them in this manual does not constitute
  381.   endorsement. If you like them, good. If not, good. I don't care.
  382.  
  383.