home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / HATCH / SINM10B1.ZIP / SINMAIL.DOC < prev    next >
Text File  |  1996-03-01  |  38KB  |  1,086 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                                                                 SinMail v1.0│
  15.                                                                documentation│
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                  The First Real UUCP Internet/WWIV Interface.
  22.                             Copyright Singe, 1995-1996.  All Rights Reserved.
  23. ───────────────────────────────────────────────────────── Table of Contents ──
  24.  
  25.    1. Introduction 
  26.      1-1. Introduction to SinMail .................................... page 3
  27.      1-2. Operation Requirements ..................................... page 3
  28.      1-3. File Descriptions .......................................... page 4
  29.  
  30.    2. Quick Installation ............................................. page 5
  31.  
  32.    3. SinMail Operation
  33.      3-1. Description ................................................ page 9
  34.      3-2. SMOUT Mode ................................................. page 9
  35.      3-3. UUXQT Mode ................................................. page 9
  36.      3-4. Compressed newsfeeds ....................................... page 10
  37.      3-5. Email address resolution / RESOLVE ......................... page 10
  38.      3-6. News resource / NEWSRC ..................................... page 11
  39.  
  40.    4. Polling ........................................................ page 12
  41.  
  42.    5. Setting Up Newsgroups in WWIV .................................. page 12
  43.  
  44.    6. Finger and Plan Files .......................................... page 13
  45.  
  46.    7. The UUCP Connection ............................................ page 13
  47.  
  48.    8. SINMAIL.CFG .................................................... page 14
  49.  
  50.    Appendix A. Ordering the Commercial Version of SinMail ............ page 17
  51.    Appendix B. SinMail Support Sites ................................. page 17
  52.    Appendix C. Setting up your UUCICO ................................ page 18
  53.  
  54.    Glossary of Terminology ........................................... page 19
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81. SinMail Documentation ──────────────────────────────────────────────── page 2
  82. ────────────────────────────────────────────── 1-1. Introduction to SinMail ──
  83.  
  84. Welcome to SinMail, the first package that brings real Internet email and
  85. newsgroups directly to your WWIV BBS and actually makes your system a part of
  86. the Internet.  This feat is acheived via a UUCP connection to your Internet
  87. Service Provider.  Your system calls up regularly and swaps the necessary
  88. data, email and newsgroups.  SinMail takes care of it from there.
  89.  
  90.   [[ What is UUCP?  Please read the glossary for help on any terms you
  91.      aren't familiar with. ]]
  92.  
  93. The interface is handled by SinMail without use of external networking
  94. software, making the data processing very fast.  SinMail interfaces directly
  95. with your BBS's data files, skipping any secondary processing.  In addition,
  96. SinMail is RFC822 complient, meaning that it supports standard Internet
  97. message headers, and at the SysOps option can show the headers to the users of
  98. the BBS, show certain fields of the header, or even completely hide the header
  99. fields from the user, making the Internet/WWIV interface transparent.
  100.  
  101. If you are familiar with the finger command on the Internet, you should be
  102. pleased to find out that SinMail has its own implentation of the finger
  103. daemon built right in.  Your users can maintain and edit their own plan files
  104. for users on the Internet to 'point at' to read any information the users
  105. would like to show.  SinMail looks at incoming mail for any mail directed to
  106. the finger service and checks the subject header field for the local user who
  107. is being fingered.  Whoever on the Internet fingered your user will receive
  108. an email reply containing that user's plan file!
  109.  
  110.  
  111. ─────────────────────────────────────────────── 1-2. Operation Requirements ──
  112.     
  113.   [*] Registered WWIV (with source code)
  114.        Included source modifications were designed for v4.24 and v4.24a
  115.        but may work with any version with a few minor changes.
  116.  
  117.   [*] UUCP Internet Connection to a Service Provider
  118.        Read section 7 on "The UUCP Connection" for more information.
  119.  
  120.   [*] UUCICO
  121.        Read appendix C on "Setting up your UUCICO" for more information and
  122.        to find out where to get a suitable UUCICO.
  123.        - Readily available at SinMail support sites.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140. SinMail Documentation ──────────────────────────────────────────────── page 3
  141. ──────────────────────────────────────────────────── 1-3. File Descriptions ──
  142.  
  143.   SINMAIL.EXE   SinMail Executable
  144.                 Runs in two different modes.  SMOUT mode grabs any outgoing
  145.                 data from your WWIV system and prepares it for UUCP transfer.
  146.                 UUXQT mode takes the files received from your UUCP connection
  147.                 and places them into your WWIV system.                                
  148.  
  149.   SINMAIL.DOC   SinMail Documentation
  150.                 This is the file you are reading.
  151.  
  152.   SINMAIL.MOD   Modifications that must be made to your WWIV source code.
  153.  
  154.   RESOLVE.      Username Resolution
  155.                 Contains mail aliases for your users.  SinMail can be
  156.                 configured to look in this file to figure out which users
  157.                 should be receiving the incoming mail, or SinMail can look
  158.                 directly in your BBS data files.
  159.  
  160.   NEWSRC.       News Resource
  161.                 Contains all the newsgroups your system is carrying from your
  162.                 UUCP connection and binds them to the data files in your
  163.                 BBS directories.
  164.  
  165.   POLL.BAT      Polling Batch File
  166.                 Run automatically from WWIV.  Makes your system run SinMail
  167.                 in SMOUT mode, connect to your UUCP service, then finish up
  168.                 by running SinMail in UUXQT mode.
  169.  
  170.   FILE_ID.DIZ   Automatic description file for BBS transfer sections.
  171.  
  172.   ORDER.FRM     Form for ordering the commercial version SinMail v1.0 from
  173.                 Singe.  
  174.  
  175.   COMPRESS.EXE  Publicly available compression software included in package.                
  176.  
  177.   SEQUENCE.     Sequence File
  178.                 Created and maintained by SinMail to create unique filenames
  179.                 for each piece of outgoing data.
  180.  
  181.   SINMAIL.LOG   Text log of operations, maintained by SinMail.  The SysOp can
  182.                 configure SinMail to record various events in this log.
  183.  
  184. * BETA1.        Special notes concerning this pre-release of SinMail.
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199. SinMail Documentation ──────────────────────────────────────────────── page 4
  200. ───────────────────────────────────────────────────── 2. Quick Installation ──
  201.  
  202.   So much software available in the BBS world is often very difficult to
  203.   install with very cryptic documentation.  The purpose of this Quick
  204.   Installation section is to guide you through the procedure required to
  205.   setup SinMail for the first time.  Some steps along the way are not fully
  206.   documented, but will refer you to the other sections of this documentation
  207.   for furthur directions.  This provides a nice guideline for which you will
  208.   travel on the road to installation.
  209.  
  210.   === This quick installation assumes that your UUCP connection is already
  211.   established.  For more information on how to establish a UUCP connection
  212.   for your BBS through an Internet Service Provider, please refer to "The
  213.   UUCP Connection" section of this documentation. ===
  214.  
  215.   1. Create a new directory for your SinMail files.  You may choose any name
  216.      you wish for this directory, but using anything other than C:\SINMAIL
  217.      will require you to make changes in the configuration files.
  218.  
  219.      MD \SINMAIL
  220.  
  221.   2. Unzip the original SinMail archive into this new directory.
  222.      The following files are essential for operation:
  223.  
  224.      SINMAIL.EXE
  225.      SINMAIL.CFG
  226.      RESOLVE.
  227.      NEWSRC.
  228.  
  229.      Also, crucial for compressed newsfeeds: COMPRESS.EXE
  230.  
  231.   3. Edit SINMAIL.CFG
  232.  
  233.      There will be a few important fields that you will need to modify.
  234.      Make sure you have a space between the option tokens and their values.
  235.  
  236.        mailwaitingoffset: 628
  237.        ureclen: 1024
  238.  
  239.           ***> This is very important! <***
  240.  
  241.        - if you've made any prior modifications to your WWIV source code that
  242.        change the relative location of the "waiting" variable in your user
  243.        record, or the size of the user structure, you will need to make the
  244.        appropriate changes here.  If you have not changed this structure,
  245.        you will be able to leave the default values for WWIV v4.24 and v4.24a.
  246.  
  247.        remotehost: tatooine
  248.  
  249.        - remotehost is followed by the machine name of the system your UUCP
  250.        account resides on at your Internet service provider.
  251.  
  252.        wwivdata: C:\WWIV\DATA
  253.        wwivmsgs: C:\WWIV\MSGS
  254.  
  255.        - These configuration options tell SinMail where to find your BBS
  256.        directories.
  257.  
  258. SinMail Documentation ──────────────────────────────────────────────── page 5
  259.  
  260.        domain: luke.foo.bar
  261.  
  262.        - This is your fully qualified domain name.  When your domain name is
  263.        registered with the InterNIC and your service provider sets up your
  264.        system on their end, your system will have email capabilities.
  265.  
  266.        uucpname: luke
  267.  
  268.        - This is your system's name in matters of UUCP correspondance.
  269.        Usually it is the login name for your system's account at your ISP.
  270.  
  271.        spool: C:\SINMAIL\SPOOL\
  272.  
  273.        - This is the path to your spool directory.  Mainly, there will be no
  274.        files here, but there will exist a subdirectory from here named after
  275.        your remotehost.
  276.  
  277.   4. Create your remote host's spool directory.
  278.      This will match the entry you have in your CFG but you will append
  279.      the name of your remotehost onto the end.  You will also need to make
  280.      the main spool directory.
  281.  
  282.      MD \SINMAIL\SPOOL\
  283.      MD \SINMAIL\SPOOL\TATOOINE
  284.  
  285.   5. Edit RESOLVE
  286.  
  287.        [[ Please read section 3-5 on Email Address Resolution
  288.          for more information on how this feature works. ]]
  289.  
  290.      For the commercial version of SinMail, sysops can add mail aliases to
  291.      the RESOLVE file so incoming mail has a place to go.  In the default
  292.      address resolution mode, SinMail will look at RESOLVE first to look for
  293.      any mail aliases, then continue searching through WWIV's databases.
  294.  
  295.      The format of RESOLVE is as follows:
  296.  
  297.      [Email Name or Alias] [Number on BBS]
  298.  
  299.      sysop 1
  300.      cosysop 2
  301.      fooman 132
  302.      root 1
  303.      uucp 1
  304.      postmaster 1
  305.  
  306.      The shareware version allows one email account for testing purposes.
  307.      This email address is "sysop@your.domain" and corresponds
  308.      specifically with user number 1 on the BBS.
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317. SinMail Documentation ──────────────────────────────────────────────── page 6
  318.  
  319.  
  320.   6. Edit NEWSRC
  321.  
  322.        [[ Please read section 3-6 on News Resource / NEWSRC for a more
  323.          in-depth description on how this file works. ]]
  324.  
  325.      The news resource file tells SinMail where your BBS message and data
  326.      files are located for placement of message from the incoming newsfeed.
  327.      The 'news' command defines a newsgroup and binds it to its respective
  328.      data files on your BBS.  The 'maxmsgs' command specifies the maximum
  329.      number of messages in all the newsgroups proceding.
  330.  
  331.      The format of NEWSRC is as follows:
  332.  
  333.      maxmsgs [Number]
  334.        or
  335.      news [Newsgroup] [Filename]
  336.        Where [Filename] corresponds with the filename entered into WWIV for
  337.        each message base.  (Option B in BOARDEDIT)
  338.  
  339.      maxmsgs 200
  340.      news alt.bbs abbs
  341.      news alt.bbs.wwiv abbswwiv
  342.      maxmsgs 250
  343.      news alt.games.doom doom
  344.  
  345.      The shareware version of SinMail allows the system to carry two
  346.      newsgroups for testing purposes: alt.bbs and alt.bbs.wwiv
  347.      Although not all service providers carry alt.bbs.wwiv (yet, but this will
  348.      change now that SinMail brings the Internet to the WWIV world), alt.bbs
  349.      is carried by virtually everybody.  This should enable sysops to give
  350.      SinMail a test drive with at least one working newsgroup.
  351.  
  352.   7. Copy POLL.BAT over to your main WWIV directory.
  353.      Depending on your directory structure, this may need to be modified.
  354.      
  355.   8. Source Code Modification
  356.  
  357.      To get your WWIV BBS to work with SinMail, you will need to make some
  358.      changes to the source code.  These are documented in the included file,
  359.      SINMAIL.MOD.  These modifications should take approximately 20 to 60
  360.      minutes to complete.
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376. SinMail Documentation ──────────────────────────────────────────────── page 7
  377.  
  378.   9. Set up newsgroups in WWIV
  379.  
  380.        [[ For more information please read section 5 ]]
  381.  
  382.      After you've done the source code modifications, you will be able to
  383.      enter the newsgroups into your message base section.  For each newsgroup,
  384.      you will need a corresponding message base entry.
  385.  
  386.      Entry A (name) : enter the name of the newsgroup here (i.e. alt.bbs)
  387.  
  388.      Entry B (filename) : enter the filename for this message base.
  389.        note, that this MUST correspond to the name you enter in NEWSRC.
  390.  
  391.      Entry K (storage type) : here is where you tell WWIV that this is no
  392.        ordinary message base!  Unless you have changed this in the source
  393.        code modification for SinMail, you will enter a 3 here.
  394.      
  395.  
  396.  10. UUCICO Setup
  397.  
  398.    For this final step, you're going to have to refer to your UUCICO's
  399.    documentation.  If you do not already have a UUCICO, SinMail has been found
  400.    to work well with a package called FXUUCP.  It is available at SinMail
  401.    Support Sites as a free download.
  402.  
  403.      [[ An example configuration for FXUUCP is provided in Appendix C. ]]
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435. SinMail Documentation ──────────────────────────────────────────────── page 8
  436. ────────────────────────────────────────────────────── 3. SinMail Operation ──
  437.  
  438. 3-1. Description
  439.  
  440.   SinMail operates in two distinct modes, one of which handles outgoing data,
  441.   the other handling incoming data.  Outgoing data from your WWIV BBS is
  442.   processed and placed into your spool directory by SinMail when operating
  443.   in smout mode.  Once the connection goes through and your UUCICO program
  444.   gets new data for your system, SinMail operates in uuxqt mode to process
  445.   incoming data and place it into your BBS.
  446.  
  447.   To run SinMail in smout mode, simply type 'smout' on the command line after
  448.   you type 'sinmail':
  449.  
  450.     C:\SINMAIL> sinmail smout           (default mode of operation)
  451.  
  452.   Likewise for running SinMail in uuxqt mode:
  453.  
  454.     C:\SINMAIL> sinmail uuxqt
  455.  
  456.   Aside from choosing between the two modes of operation, you may also specify
  457.   the thouroughness of the status reports appearing on screen during the
  458.   processing, as well as how in-depth the logs are kept.  There are command
  459.   line switches to handle this feature.
  460.  
  461.     -D#    Display Level
  462.  
  463.            where # is a number from 0 to 9, 0 being very uninformative, and
  464.            9 tells you much more than you need to know.  Default = 3.
  465.  
  466.     -L#    Log Level
  467.  
  468.            where # is a number from 0 to 9, 0 being very uninformative, and
  469.            9 tells you much more than you need to know.  Default = 3.
  470.  
  471.   For example, to run SinMail is uuxqt mode and receive a nice amount of
  472.   information on screen, but record only errors in the log file:
  473.  
  474.     C:\SINMAIL> sinmail uuxqt -L0 -D5
  475.  
  476.  
  477. 3-2. SMOUT Mode
  478.  
  479.   In smout mode, SinMail searches through your WWIV messages for any outgoing
  480.   pieces of mail or outgoing messages on the newsgroups.  Once processed by
  481.   SinMail, the email and messages are placed into the proper spool directory
  482.   and are ready to be transfered out by your UUCICO.
  483.  
  484.  
  485. 3-3. UUXQT Mode
  486.  
  487.   Similiar to unix's uuxqt command, SinMail's uuxqt uncompresses, unbatches,
  488.   and processes any incoming files in your spool directory.  These files are
  489.   carefully placed into the corresponding files in WWIV.  This is the step
  490.   that puts incoming mail in the mailboxes and messages into the newsgroups.
  491.  
  492.  
  493.  
  494. SinMail Documentation ──────────────────────────────────────────────── page 9
  495.  
  496. 3-4. Compressed Newsfeeds
  497.  
  498.   SinMail will handle an incoming batched newsfeed, compressed or otherwise.
  499.   However, to use a compressed batch feed, you will need to have present the
  500.   external compression software COMPRESS.EXE in your SinMail directory.
  501.  
  502.   The decision to send compressed batches or uncompressed batches is made
  503.   by you and your service provider.  The actual specification of a compressed
  504.   batch is found on your service provider's side, and any changes must be made
  505.   by going through them.
  506.  
  507.   COMPRESS.EXE will handle 16-bit compression.
  508.  
  509.  
  510. 3-5. Email Address Resolution / RESOLVE
  511.  
  512.   === Note: SinMail v1.0 Beta 1 supports explicit username resolution.  This
  513.   means that each user with an email account has to be explicitly defined in
  514.   the RESOLVE file.  The release of SinMail v1.0 will have more options for
  515.   resolving usernames, including a way to automatically reference every name
  516.   from the usernames in WWIV.  (i.e. with this option, "Joe The Farmer" would
  517.   be "joe.the.farmer") ===
  518.  
  519.   The syntax for your resolve file is as follows:
  520.  
  521.       [Username or Alias] [Number on BBS]
  522.  
  523.   An example resolve file:
  524.  
  525.   sysop 1
  526.   cosysop 2
  527.   fooman 132
  528.   root 1
  529.   uucp 1
  530.   postmaster 1
  531.  
  532.   For this resolve file, any mail sent to "postmaster", "uucp", "root," or
  533.   "sysop" would be placed into the mailbox of user number 1.  Mail sent to
  534.   "cosysop" would go into user number 2's mailbox, and mail for "fooman" will
  535.   wind up in user #132's mailbox.
  536.  
  537.   When SinMail runs in smout mode and finds a piece of mail from user #1,
  538.   the first entry will be selected as the username in the header of the
  539.   outgoing mail.  For example, if user #1 writes mail to "sinmail@singe.com"
  540.   but has multiple alias entries in the resolve file, SinMail will choose
  541.   "sysop" because is the first entry listed matching user number 1.  Of
  542.   course, the domain name is appended onto the username, so the outgoing mail
  543.   will be from "sysop@luke.foo.bar".
  544.  
  545.   Any duplicate entries found will be considered aliases.  Incoming mail
  546.   addressed to these names will also be routed into the proper user's
  547.   mailbox on the BBS.  When appending a username to outgoing mail, SinMail
  548.   will use the first name listed with the proper number as the mail's
  549.   addressee appended with the system's domain name.
  550.  
  551.  
  552.  
  553. SinMail Documentation ──────────────────────────────────────────────── page 10
  554.  
  555. 3-6. News resource / NEWSRC
  556.  
  557.   Your news resource file tells SinMail where incoming news messages are to
  558.   be placed.  The format of this file specifies the number of messages each
  559.   newsgroup will hold, the names of all the newsgroups you are carrying from
  560.   your service provider, and the corresponding filenames for each of these
  561.   newsgroups.
  562.  
  563.   There are two valid lines in the news resource file:
  564.  
  565.       maxmsgs [Number]
  566.       
  567.       news [newsgroup] [filename]
  568.  
  569.   'maxmsgs' defines the number of messages each of the proceding message bases
  570.   may hold.  You may choose whatever number you would like here.  Any
  571.   following maxmsgs lines will change the number of messages for the message
  572.   bases following that line.
  573.  
  574.   The 'news' command is followed by two entries.  The first is the exact name
  575.   of the newsgroup that you are carrying from your newsfeed.  Some valid
  576.   newsgroups are alt.games.doom, alt.winsock, comp.theory, among many many
  577.   thousands more.  Your service provider should be able to supply you with a
  578.   complete list from which you may choose which ones to carry.  The second
  579.   entry after the 'news' command must exactly match the filename you have
  580.   entered (or plan to enter) into your WWIV BOARDEDIT for that newsgroup.
  581.  
  582.   (from BOARDEDIT)                   (from NEWSRC)
  583.  
  584.   A. Name       : alt.bbs            maxmsgs 200
  585.   B. Filename   : ABBS               news alt.bbs abbs
  586.  
  587.   Note that the filenames from BOARDEDIT and from the 'news' command
  588.   must be matched.  "maxmsgs" does not necessarily need to to correspond to
  589.   your entry in BOARDEDIT for Max Msgs (option H).  WWIV does not play with
  590.   these message bases, SinMail does.  SinMail reads 'maxmsgs' from the news
  591.   resource file instead of from WWIV's SUBS.DAT for added speed and less
  592.   unnecessary file activity.
  593.  
  594.   An example news resource:
  595.  
  596.   maxmsgs 200
  597.   news alt.bbs abbs
  598.   news alt.winsock awinsock
  599.   news comp.theory ctheory
  600.   maxmsgs 250
  601.   news alt.bbs.wwiv abbswwiv
  602.  
  603.   The first three newsgroups will have 200 messages, while SinMail will keep
  604.   250 messages for alt.bbs.wwiv.  Any incoming news messages for comp.theory
  605.   will be placed into the WWIV data files corresponding to CTHEORY.
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612. SinMail Documentation ──────────────────────────────────────────────── page 11
  613. ──────────────────────────────────────────────────────────────── 4. Polling ──
  614.  
  615.   Polling is the process of calling your connections to swap data.  The
  616.   dial-out portion of the SinMail modification to your WWIV source code will
  617.   automatically run a batch file called POLL.BAT, which should be located in
  618.   your main WWIV directory.
  619.  
  620.   POLL.BAT first runs SinMail in smout mode, dials your Internet service
  621.   provider using your UUCICO, then finally runs SinMail in uuxqt mode.
  622.  
  623.     [[ For more information on obtaining and setting up a UUCICO program,
  624.     please refer to Appendix C. ]]
  625.  
  626.   If you would like to force a poll to occur, you can either type POLL from
  627.   the DOS command line in your main WWIV directory, or you can hit the '\'
  628.   backslash key from WWIV's waiting for caller (WFC).
  629.  
  630.  
  631.  
  632. ────────────────────────────────────────── 5. Setting Up Newsgroups in WWIV ──
  633.  
  634.   Each message base you carry in your newsfeed will need to be entered into
  635.   BOARDEDIT.  Some of the entries in BOARDEDIT have a very important relation
  636.   to SinMail.  Option H, Max Msgs, is not used by WWIV when the message base
  637.   is an Internet newsgroup, instead this information is taken from SinMail's
  638.   news resource file.  Option B must be set to correspond with the filename
  639.   in your news resource file [[ as described in section 3-6. ]]  Option K
  640.   must be set to the storage type "3", provided that you have not changed this
  641.   when you installed the SinMail Modifications to your source code.
  642.  
  643.   Here is a sample message base from BOARDEDIT:
  644.  
  645.      * A. Name       : alt.bbs
  646.      * B. Filename   : ALTBBS
  647.        C. Key        : None
  648.        D. Read SL    : 10
  649.        E. Post SL    : 20
  650.        F. Anony      : No
  651.        G. Min. Age   : 0
  652.      * H. Max Msgs   : 50
  653.        I. AR         : None.
  654.      * J. Net info   : Not networked.
  655.      * K. Storage typ: 3
  656.        L. Val network: No
  657.        M. Req ANSI   : No
  658.        N. Disable tag: No
  659.        O. Description: None.
  660.  
  661.   Option A should probably be the name of the newsgroup, but should you decide
  662.   to change this, SinMail will still function.  Additionally, option J should
  663.   be left blank.
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671. SinMail Documentation ──────────────────────────────────────────────── page 12
  672. ────────────────────────────────────────────────── 6. Finger and Plan Files ──
  673.  
  674.   SinMail has a special feature allowing users on the Internet to finger the
  675.   users on your BBS.  Users on the Internet must send mail to the finger
  676.   server account setup in your SinMail configuration file.  By default, the
  677.   finger server name is "finger", but you may change that if you wish.  Should
  678.   you decide to change it, you will have to keep everyone informed, so it is
  679.   not recommended that you do so, in order to keep "finger" standardized.
  680.  
  681.   The subject line of the mail to the finger server must contain the name of
  682.   the user that is to be fingered.  SinMail will intercept the mail and send
  683.   a copy of the user's PLAN file to the person who sent the finger request.
  684.   If no PLAN file exists or the user does not exist, the people who sent
  685.   the finger request will be notified.
  686.  
  687.   To test this feature from any internet account with email do the following:
  688.  
  689.   1. Send mail to finger@singe.com
  690.   2. In the subject line, type: sinmail
  691.   3. There need be no body to the message; it will be ignored.
  692.  
  693.  
  694.   *** SinMail v1.0 Beta 1 NOTE:  Creating user plans has not been added to the
  695.   source code modification for this version.  If you would like more info so
  696.   you can add this little feature to the WWIV source code, send mail to
  697.   sinmail@singe.com.
  698.  
  699. ──────────────────────────────────────────────────── 7. The UUCP Connection ──
  700.  
  701.   Q: "How do I get a UUCP connection?"
  702.  
  703.   A: From your local internet service provider.  In NJ, where people pay too
  704.      much for Internet connections, UUCP connections start at or under $20.
  705.  
  706.  
  707.   Q: "How do I get a domain?"
  708.  
  709.   A: When you establish your UUCP connection with your service provider, you
  710.      will need to select a domain for your system.  There are a few different
  711.      schemes for domain names, some of which might cost you extra money from
  712.      the InterNIC Registration Services.  Any domain ending in .com or .net
  713.      is currently subject to a maintenance fee of $100 for two years, $50 for
  714.      every year following.  Domains ending in your state and country are
  715.      currently available at no cost.  (i.e. "loserbbs.nj.us")  The first part
  716.      of your domain should be something relavent to your BBS's name.
  717.  
  718.  
  719.   Q: "What information is necessary for the UUCP connection between my system
  720.      and the service provider?
  721.  
  722.   A: You will need to know your login name and password, which you will be
  723.      entering into your UUCICO configuration files.  Once the connection is up
  724.      and working, you will probably want to come up with a list of newsgroups
  725.      you want to carry for your system and submit it.  The service provider
  726.      has to make the changes on their end for your newsfeed.  You'll also need
  727.      to make a decision on whether to use compression or not.  Most likely you
  728.      will be using compression.
  729.  
  730. SinMail Documentation ──────────────────────────────────────────────── page 13
  731. ──────────────────────────────────────────────────────────── 8. SINMAIL.CFG ──
  732.  
  733.   This necessary file is read by SINMAIL for all its configuration options.
  734.   All options are documented briefly within the config file, and documented
  735.   in full here.  Much like the other textfiles SinMail reads in, any line
  736.   that is either blank or starts with a semicolon (;) will be ignore and may
  737.   be used for keeping notes.  Important lines should start with a command,
  738.   followed by a semicolon and a space.  Here is the syntax for the available
  739.   commands:
  740.  
  741.     command: data
  742.  
  743.     [max data size]  description
  744.  
  745.  
  746.   === Internet/UUCP Related Commands:
  747.  
  748.     remotehost: text
  749.  
  750.     [20]  The remotehost command defines the UUCP name of the system your BBS
  751.     calls up for its internet connection.  Usually this is the machine name
  752.     of the host. (i.e. 'hansolo' would probably be the remote host name if
  753.     its domain was 'hansolo.mfalcon.sw')
  754.  
  755.  
  756.     domain: text
  757.  
  758.     [40]  Here is where you enter your BBS's domain name.  Your domain name
  759.     will need to be registered through the InterNIC if you are planning on
  760.     having mail from the Internet able to reach your system.  If you are
  761.     running without a domain name, you should probably use the following form
  762.     for your domain name:   uucpname.uucp
  763.  
  764.  
  765.     uucpname: text
  766.  
  767.     [20]  This is the name your system communicates to its UUCP connection.
  768.     Most often, this is the system name for your computer, similar to the way
  769.     the remotehost name is derived from your service provier's domain.
  770.  
  771.  
  772.   === Local Directories:
  773.  
  774.     userdir: directory
  775.  
  776.     [64]  This is the base directory for your finger/plan files.
  777.  
  778.  
  779.     wwivdata: directory
  780.     wwivmsgs: directory
  781.  
  782.     [64]  These entries point to your WWIV DATA and MSGS directories.
  783.  
  784.  
  785.     spool: directory
  786.  
  787.     [64]  Points to your incoming/outgoing spool directory.
  788.  
  789. SinMail Documentation ──────────────────────────────────────────────── page 14
  790.  
  791.   === Local Filenames:
  792.  
  793.     log: pathname
  794.  
  795.     [80]  Path and filename of SinMail's log file.  If it does not exist,
  796.     SinMail will create it, provided the path is valid.
  797.  
  798.  
  799.     resolve: pathname
  800.  
  801.     [80]  Path and filename of your username resolve file.
  802.  
  803.  
  804.     newsrc: pathname
  805.  
  806.     [80]  Path and filename of your news resource file.
  807.  
  808.  
  809.     sequence: pathname
  810.  
  811.     [80]  Maintained by SinMail, this is the file that provides a sequence
  812.     of unique, numbered filename for outgoing data files.
  813.  
  814.  
  815.   === Miscellaneous Commands:
  816.  
  817.     ureclen: number
  818.  
  819.     This should correspond to the size of your user structure in your WWIV
  820.     source code.  If you haven't changed the structure in your VARDEC.H file,
  821.     you may use the default setting of 1024, however if you have changed it,
  822.     you will need to enter the new size.  If you are unsure of the exact
  823.     value of this, you can find out by entering this line into your WWIV
  824.     source code at an appropriate location:
  825.  
  826.      printf("ureclen: %d\r\n",sizeof(thisuser));       
  827.  
  828.     mailwaitingoffset: number
  829.  
  830.     As with the ureclen command, this command is followed by a number telling
  831.     how far into the user record the mail waiting variable is located.  If you
  832.     haven't change it, the default value of 628 should work just fine.
  833.     Because this points to the middle of the structure, it is a little more
  834.     difficult to find the result if you're really not sure.  This should work:
  835.  
  836.      printf("mailwaitingoffset: %ld\r\n",
  837.        (long)(&thisuser.waiting-&thisuser));
  838.  
  839.     Future versions of WWIV might not work, but because these the mail
  840.     waiting field is very important and the current size of 1024 was made
  841.     with future expansion in mind, it will probably still work for a long
  842.     time to come.
  843.  
  844.  
  845.  
  846.  
  847.  
  848. SinMail Documentation ──────────────────────────────────────────────── page 15
  849.  
  850.     tzone: text
  851.  
  852.     [20]  This is a short representation of your timezone.  You should take
  853.     cue from the other systems on the Internet and use whatever scheme they
  854.     use for their timezones.  That info can be found by looking in the headers
  855.     of mail and news messages.
  856.  
  857.  
  858.     rmethod: (explicit|wwiv|smart)
  859.  
  860.     Not available in SinMail v1.0 B1, will be available in release version.
  861.  
  862.  
  863.     fingername: text
  864.  
  865.     [30]  This allows the sysop to rename the finger server.  Because this is
  866.     a non-standard way of handling incoming finger requests (through email),
  867.     we do not recommend that you change this, so there is at least a standard
  868.     non-standard. <grin>  The default value is 'finger' and unless you want to
  869.     keep everyone interested in fingering users at your system informed, don't
  870.     change this.
  871.  
  872.  
  873.     organization: text
  874.  
  875.     [64]  This commands lets you tell the world about your BBS in the headers
  876.     of all your messages and email.  
  877.  
  878.  
  879.     newsremove: text
  880.     mailremote: text
  881.  
  882.     [big/multiline]  These commands let you weed out the header fields you
  883.     don't want to pass through from the Internet to your system.  It's okay
  884.     to get rid of whatever you would like it, SinMail will still work fine.
  885.     Should you decide to get rid of every header field, just use an asterisk.
  886.     Otherwise, make sure you have a space between each header field entry.
  887.     You may use multiple lines in the config file for these commands.
  888.     Naturally, newsremove and mailremove differenciate the remove of header
  889.     fields from news messages and mail, respectively.
  890.  
  891.     Here is a short example of a newsremove line:
  892.  
  893.       newsremove: from: to: date: subject:
  894.  
  895.  
  896.     x-extra: text
  897.  
  898.     You may put anything here and it will be added the header fields of every
  899.     outgoing mail or news message.  Keep it short though, since this is a good
  900.     way to increase bandwidth unnecessarily.  You may replce the 'extra' with
  901.     any text, provided it has no spaces or colons.
  902.  
  903.  
  904.  
  905.  
  906.  
  907. SinMail Documentation ──────────────────────────────────────────────── page 16
  908. ──────────────────── Appendix A. Ordering the Commercial Version of SinMail ──
  909.  
  910.   If you are running the shareware version of SinMail and would like to bring
  911.   the features of the Internet to your users, the commercial version of
  912.   SinMail v1.0 is available on disk from Singe for the price of $30.00 USD.
  913.   For more information on how to order, please refer to the
  914.   ORDER.FRM file included with the original archive.
  915.  
  916.  
  917.            ==== Notice for Registered SinMail v1.0 Beta Users ====
  918.  
  919.   Due to SinMail's status as a "beta" version, registering SinMail now will
  920.   give you access to the commercial version of SinMail v1.0 (betas and
  921.   release when it becomes available) on The Ethereal Plane, the HQ of Singe.
  922.   When SinMail v1.0 is released, you will receive the release version in the
  923.   mail on a high density 3.5" floppy disk.
  924.  
  925.  
  926.  
  927. ───────────────────────────────────────── Appendix B: SinMail Support Sites ──
  928.  
  929.   Support for SinMail may be obtained in many ways.  The open forum methods
  930.   are perferred for general questions on installation to receive the fastest
  931.   response as there will be many who will be able to answer your questions.
  932.   Additionally, the help given to you might also help others with similar
  933.   problems.
  934.  
  935.     (o) WWIVnet
  936.  
  937.       Email: 1@10217.WWIVnet
  938.  
  939.       Message Base: SinMail Support
  940.       Subtype: SINMAIL
  941.       Host: @10217
  942.  
  943.       We suggest that everyone running SinMail and those considering running
  944.       SinMail join this message base.  Technical support is given and product
  945.       information is posted here.  Find out about future features and release
  946.       info up to the minute instead of having to wait weeks.
  947.  
  948.     (o) Internet Email
  949.  
  950.       sinmail@singe.com - Official SinMail Support/Information
  951.  
  952.       mail to: finger@singe.com  (with 'sinmail' as the subject line)
  953.         - for updated SinMail information 
  954.   
  955.     (o) SinMail Support Sites
  956.  
  957.       The Ethereal Plane
  958.       (609)435-5991
  959.       2 Nodes, 28.8k V.34/V.FC
  960.       - Singe HQ system.
  961.  
  962.       We are looking for more sites to become Support and Distribution Sites.
  963.       Any interested sysops should make contact through the above methods.
  964.  
  965.  
  966. SinMail Documentation ──────────────────────────────────────────────── page 17
  967. ──────────────────────────────────────── Appendix C. Setting up your UUCICO ──
  968.  
  969.   Any UUCICO will probably work well, but we currently provide specific set-up
  970.   information for a package called FXUUCP.  It is available at SinMail Support
  971.   Sites and has been found to work quite well with SinMail.
  972.  
  973.   Here is a sample FXUUCP configuration, notice the vast reduction of
  974.   necessary entries.  We are trying to keep this as simple as possible.
  975.  
  976.   ----- FXUUCP.CFG -----
  977.  
  978. device: 2
  979. speed: 38400
  980. uucpname: luke
  981. spool: C:\SINMAIL\SPOOL
  982.  
  983. fx.gpktsize: 1024
  984. fx.logdir: C:\SINMAIL
  985. uu.driver: NATIVE
  986. uu.time: 45
  987.  
  988. fx.rSystem: tatooine Any g "" ATM0V1&D2 OK ATDT5551572 CARRIER \c\p\p\m Username: \dluke Password: letmein
  989.  
  990.   ----------------------
  991.  
  992.   Some fields will need to be changed:
  993.  
  994.   device: your modem's port number
  995.   speed: your modem speed
  996.   uucpname: corresponds to your entry in SINMAIL.CFG
  997.   spool: also corresponds to your entry in SINMAIL.CFG
  998.   fx.logdir: points to the directory where FXUUCP will store its logs
  999.  
  1000.   fx.rSystem: this is a pretty tricky configuration line.  You will find it
  1001.     best described in the FXUUCP documentation.  If you're really in a hurry,
  1002.     you could probably just adapt the line above that has been given to your
  1003.     purposes.  Note that the last section of this line contains a dialogue of
  1004.     'tokens' which alternate between "wait to receive this" and "send this".
  1005.  
  1006.  
  1007.  
  1008.  
  1009.  
  1010.  
  1011.  
  1012.  
  1013.  
  1014.  
  1015.  
  1016.  
  1017.  
  1018.  
  1019.  
  1020.  
  1021.  
  1022.  
  1023.  
  1024.  
  1025. SinMail Documentation ──────────────────────────────────────────────── page 18
  1026. ─────────────────────────────────────────────────── Glossary of Terminology ──
  1027.  
  1028.   spool - a storage place for items to be processed.
  1029.  
  1030.     interestingly, The American Heritage Dictionary specificly
  1031.     mentions that this term is used in computer science.
  1032.  
  1033.   uucico - (unix to unix call-in, call-out)
  1034.  
  1035.     dials up your internet service provider, sends any outgoing files,
  1036.     and receives any incoming files.  the files sent are taken from
  1037.     your spool directory and are received there as well.           
  1038.  
  1039.   uucp - (unix to unix copy)
  1040.  
  1041.     method of copying files from one system to another.  its usefulness
  1042.     for us is that it can be used by service providers to store files
  1043.     designated for your bbs (email and newsfeeds) until your bbs feels
  1044.     like calling to receive the files.  uucp is an actual command on
  1045.     most unix systems.
  1046.  
  1047.   uuxqt - (unix to unix, execute)
  1048.  
  1049.     a command in the unix world that processes incoming news messages
  1050.     and email, figuring out where each has to go.
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.  
  1066.  
  1067.  
  1068.  
  1069.  
  1070.  
  1071.  
  1072.  
  1073.  
  1074.  
  1075.  
  1076.  
  1077.  
  1078.  
  1079.  
  1080.  
  1081.  
  1082.  
  1083.  
  1084. SinMail Documentation ──────────────────────────────────────────────── page 19
  1085.  
  1086.