home *** CD-ROM | disk | FTP | other *** search
/ synchro.net / synchro.net.tar / synchro.net / modem.madness / SMMNETML / YAT021.ZIP / YATIC.TXT < prev    next >
Encoding:
Text File  |  1993-01-16  |  42.3 KB  |  1,189 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.                                  YaTic v1.00
  14.  
  15.                              A 5D TIC processor
  16.  
  17.                          DOS and OS/2 Documentation
  18.  
  19.                           Berin Lautenbach 1992-93
  20.  
  21.                                   3:620/248
  22.                                  58:2600/100
  23.                                  93:9160/103
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.      Introduction                                               2
  32.      Licensing and all that guff                                2
  33.      Configuration                                              4
  34.          YtConfig                                               4
  35.              System Info                                        4
  36.              Domains                                            6
  37.              System AKAs                                        7
  38.              Reports                                            7
  39.              Areas                                              8
  40.                  Editing an Area                                9
  41.                  Global                                        11
  42.              Nodes                                             11
  43.              Import/Export                                     12
  44.          Text Files                                            13
  45.              YatMan templates                                  13
  46.              Report Templates                                  13
  47.      Running YaTic                                             14
  48.          Normal Running                                        14
  49.          Maintenance                                           15
  50.          Other Switches                                        15
  51.          Hatch                                                 15
  52.      Area Manger - YatMan                                      16
  53.      Afterword - Future Directions                             17
  54.      Credits and Acknowledgments                               17
  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.                                 Introduction
  81.      ───────────────────────────────────────────────────────────────────
  82.  
  83.           YaTic is a 5D aware TIC processor that I wrote in my spare
  84.      time.  I run a lot of points on my system, and thought it would be
  85.      nice to be able to send them some of the WinNet stuff.  YaTic fully
  86.      understands 5D addressing, both under a oMMM environment, such as
  87.      Binkley, or a straight *.MSG controlled environment, such as Front
  88.      Door.  However, within the TIC files themselves, YaTic will only
  89.      handle 4D addressing, any domain lines found in the file will be
  90.      ignored.  This should not be a hassle at this time, since no
  91.      software that I am aware of uses 5D aware addressing (and only a
  92.      few programs, such as AllFix, allow 4D).
  93.  
  94.           Apart from that, it has the following features :
  95.  
  96.      o    YatMan - an inbuilt Area Manager
  97.      o    Reporting of processed files
  98.      o    Easy to use configuration program
  99.      o    Terminal Nodes - Nodes that do not get *.TIC files
  100.      o    Autoadding of new (unknown) areas from trusted nodes
  101.      o    Automatic adding of selected nodes to autoadded areas
  102.      o    Passthrough areas
  103.      o    Full dupe checking (optional)
  104.      o    Full CRC checking (optional)
  105.      o    Imports/Exports areas and nodes from/to a standard TIC.CFG
  106.      o    Hatch - both command line and interactive
  107.  
  108.      ───────────────────────────────────────────────────────────────────
  109.                          Licensing and all that guff
  110.      ───────────────────────────────────────────────────────────────────
  111.  
  112.           YaTic is free.  That's not to say it's freeware, I still
  113.      retain the copyright, and will not make the source freely
  114.      available.  However, if you like the program, and you want to use
  115.      it, do so with my blessing <GRIN>.  All I ask is that the
  116.      distribution archive not be messed with in terms of the files
  117.      within it - it may be re-packed using your favourite archiver, but
  118.      the files inside it may not be tampered with.
  119.  
  120.           If you do like it and use it though, I would appreciated a
  121.      postcard from wherever you are.  That just keeps me a happy man,
  122.      and much more likely to fix bugs or add features.  See below for an
  123.      address.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.       Yatic v1.00                                           Page : 2
  132.      ───────────────────────────────────────────────────────────────────
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.           On the other hand, if it breaks, or it breaks your system, I
  142.      will accept no responsibility.  YOU USE YATIC AT YOUR OWN RISK, AND
  143.      I WILL NOT BE HELD LIABLE FOR ANY PROBLEMS THAT MIGHT OCCUR THROUGH
  144.      ITS USE.
  145.  
  146.           That out of the way, if you report any bugs to me, I will try
  147.      and get them fixed for you.  The program runs AOK here, but no one
  148.      can be sure how it will run on other systems.
  149.  
  150.           Many thanks to the Beta Testers for all there help :
  151.  
  152.      o    Grant Wilson
  153.      o    Craig Gibson
  154.      o    Harry Konstantinou
  155.      o    David Leach
  156.      o    Ben Elliston
  157.      o    Noel Roberts
  158.      o    Colin Lean
  159.      o    Paul Marwick
  160.      o    Hamish Moffat
  161.  
  162.           The latest version can be file requested from my system using
  163.      the magic name YATIC, and the latest public beta as YT_BETA.  For
  164.      any support contact one of the following addresses :
  165.  
  166.      3:620/248.0@fidonet           (Fidonet)
  167.      58:2600/100.0@intlnet         (IntlNet)
  168.  
  169.      20 Yiman St                   (Snail Mail)
  170.      Waramanga
  171.      Australia, ACT, 2611
  172.  
  173.           I hope you like the program.
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.       Yatic v1.00                                           Page : 3
  198.      ───────────────────────────────────────────────────────────────────
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.      ───────────────────────────────────────────────────────────────────
  208.                                 Configuration
  209.      ───────────────────────────────────────────────────────────────────
  210.  
  211.           Configuration of YaTic is a reasonably straightforward
  212.      procedure, consisting of two steps.  The first is to run YtConfig
  213.      in the programs directory, and fill in all the blanks.  The second
  214.      is to modify the text files used by YatMan to suit your system.
  215.  
  216.      YtConfig
  217.      ───────────────────────────────────────────────────────────────────
  218.  
  219.           YtConfig is the basic configuration program of YaTic.  It
  220.      handles all the areas, nodes and general points about your system.
  221.      It's basically self explanatory, with a help line at the bottom of
  222.      the screen to tell you what various options are for.  It starts up
  223.      in the main menu, with the following options.  Note that for all
  224.      edit screens, the information is saved by hitting Ctrl-Enter.
  225.  
  226.      System Info
  227.      ───────────
  228.  
  229.           The first menu option simply brings up a new menu, used to
  230.      define the necessary information about your system.  It has the
  231.      following three sub options :
  232.  
  233.      General
  234.      ───────
  235.  
  236.           Selecting this will bring up a general information screen.
  237.      The options within this are as follows
  238.  
  239.      Binkley : Tells YaTic whether you are using an oMMM environment.
  240.           Under Binkley file attaches are done directly in the outbound
  241.           area.  If you select 'N' here, YaTic will use matrix mail
  242.           (*.MSG) to attach new files.
  243.  
  244.      Use Intl : Many systems these days (usually those running more than
  245.           one domain) prefer to ensure that ALL messaged leaving the
  246.           system use the ^AINTL kludge line, rather than just those
  247.           going to another zone.  Select 'Y' here to ensure this kludge
  248.           line is always on.
  249.  
  250.      Dupe Checks : Globally turn off all dupe checking.  This overrides
  251.           any areas that are checking for dupes.  If set to 'Y', YaTic
  252.           goes by the selection for each area as to whether to check for
  253.           dupes within it.
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.       Yatic v1.00                                           Page : 4
  264.      ───────────────────────────────────────────────────────────────────
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.      Check CRC : Files usually come with a CRC in their associated TIC
  274.           file.  This is used to ensure the integrity of the file when
  275.           it reaches your system.  CRC checking takes most of the time
  276.           required to process inbound files,  otherwise turning this off
  277.           will not affect things much, but might allow garbled files to
  278.           get passed on.
  279.  
  280.      Delete Requests : Delete YatMan requests once handled.  If this is
  281.           set to 'N', YatMan will mark the request as received and
  282.           continue.
  283.      Delete Replies : If this is set, YatMan will mark the replies it
  284.           makes as delete when sent.  When this is set to 'N', all
  285.           replies will be kept after they are sent.
  286.  
  287.      Delete TIC files : Only applies to FD systems (i.e. those that use
  288.           a *.MSG style file attach).  When this is active, YaTic will
  289.           use two attach messages to send a new file to a system, one
  290.           for the file, and the other for the TIC file (marked as Kill
  291.           File when Sent).  This way, you know TIC files are being
  292.           deleted ASAP.  On the other hand, when set to 'N', YaTic will
  293.           use one message for both attaches, using less disk space, but
  294.           implying that the TIC files are kept until a maintenance run
  295.           is performed (YATIC /maint).
  296.  
  297.      Default Mail Type : The mail type (Hold, Normal, Crash or Direct)
  298.           to be used on nodes that you do not know.  I.e. nodes who send
  299.           YatMan requests, but who are not known on your system.  This
  300.           mail type will also be used when a new system is added to the
  301.           node database, either through inserting a new one, or through
  302.           importing a TIC configuration.
  303.  
  304.      Default List Entry : This is a standard FILES.BBS entry string (as
  305.           seen below in the section on the areas database), and is used
  306.           as the default whenever a new area is autocreated, or as the
  307.           default entry when you are adding a new area to the database.
  308.  
  309.      Default List Name : As for above, but for the name of the file.
  310.  
  311.      Directories
  312.      ───────────
  313.  
  314.           This menu defines all the major directories needed under your
  315.      system for YaTic to run properly.  All directories should end
  316.      without a slash, i.e. c:\binkley not c:\binkley\.  The entries are
  317.      as follows :
  318.  
  319.  
  320.      Matrix Mail : Where your netmail is kept.  Used for attaches in a
  321.           FD environment, and for YatMan requests.
  322.  
  323.      Inbound Files : Where YaTic should look to find inbound TIC files
  324.           etc.
  325.  
  326.  
  327.  
  328.  
  329.       Yatic v1.00                                           Page : 5
  330.      ───────────────────────────────────────────────────────────────────
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.      Out TIC files : Where YaTic should place TIC files on their way out
  339.           of your system.  This is also where files in passthru areas
  340.           will be placed until they have been sent to all your
  341.           downlinks.  NO FILES SHOULD BE PUT IN THIS DIRECTORY unless by
  342.           YaTic.  Any files not known by YaTic will be deleted.
  343.  
  344.      Autoadd Root : YaTic allows defined nodes to create new areas.  It
  345.           will set up undefined areas from these nodes with the info
  346.           from the TIC file the new area was found in, and will create a
  347.           directory under the autoadd root with the name of the area.
  348.           Thus if the autoadd root is c:\bbsfiles, and a new area YT_DEV
  349.           comes in from a node that is allowed autoadd, the directory
  350.           c:\bbsfiles\yt_dev will be created (if it does not exist) and
  351.           will be used for the new area.
  352.  
  353.      Dupe Files : The directory where dupe info will be kept.  When
  354.           asked to, YaTic keeps a file for each area containing the file
  355.           names of files it has seen.  Along side this it keeps the
  356.           CRC's of those files and the date they were seen.  (These are
  357.           kept in files made up as area_name.DUP, i.e. YT_DEV.DUP for
  358.           the YT_DEV tic area).  You should run YaTic /maint regularly
  359.           to clear this directory out.  See the section on maintenance
  360.           for more on this.
  361.  
  362.      Log File : The file all YaTic activities will be logged to.  This
  363.           should be a full filename, but should not be opened by any
  364.           other program whilst YaTic is running, since no sharing is
  365.           supported (yet).
  366.  
  367.      Templates
  368.      ─────────
  369.  
  370.           The names (and directories) of the files to be used as
  371.      templates for YatMan can now be specified.  They default to the
  372.      names from earlier versions, and in the current directory.
  373.  
  374.      System Unknown : The file to be used as a template when sending a
  375.           reply to a system unknown in your node database.
  376.  
  377.      Password Incorrect : Where to find the template file for the
  378.           password incorrect message.
  379.  
  380.      Help : Template for the message sent to the remote system when they
  381.           ask for help (using the %HELP keyword).
  382.  
  383.      Log
  384.      ───
  385.  
  386.           YaTic allows you to select what it will put in the log.  At
  387.      the base level, with nothing else being logged, only fatal errors,
  388.      and the names of the actual TK*.TIC files will be logged, along
  389.      with a line saying a message from a node has been processed by
  390.      YatMan.  Apart from that, you can define other bits that will be
  391.      defined, such as the names of actual files coming in, the CRC's of
  392.  
  393.  
  394.  
  395.       Yatic v1.00                                           Page : 6
  396.      ───────────────────────────────────────────────────────────────────
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.      those files, description etc.  By setting the particular box to
  405.      'Y', YaTic will log it.  Setting Debug to 'Y' will turn on ALL
  406.      messages, regardless of there individual setting.
  407.  
  408.      Domains
  409.      ───────
  410.  
  411.           This section is mainly for Binkley users, and is not really
  412.      accessed during normal operation.  However, it is used when
  413.      exporting TIC files, and should always be defined.
  414.  
  415.           For Binkley users, there are a number of entries, each broken
  416.      into three parts - zone, domain name and domain directory.  For the
  417.      zone, enter your zone for this domain, for the name, enter the
  418.      domain name with no frills.  (I.e. fidonet, not fidonet.org).  For
  419.      the directory, enter the main directory stub, without any zone
  420.      extension.
  421.  
  422.           The first entry MUST be the main zone under Binkley.  Thus for
  423.      zone 3 in fidonet as the main domain, and zone 58 of intlnet, the
  424.      form would look like :
  425.  
  426.      3    fidonet   C:\BINKLEY\OUTBOUND
  427.      58   intlnet   C:\BINKLEY\INTLNET
  428.  
  429.           Note that the intlnet directory does NOT have a zone
  430.      extension.
  431.  
  432.      System AKAs
  433.      ───────────
  434.  
  435.           You should enter all the addresses your system is known by
  436.      here.  Full 5D addressing can be used (though it need not be).  The
  437.      first entry should be your main address, as this will be the
  438.      address defaulted to when YaTic can not match any other address to
  439.      the outgoing mail/files.
  440.  
  441.      Reports
  442.      ───────
  443.  
  444.           Reports are new in v1.00, and are the YaTic method of
  445.      reporting inbound (or hatched) files that come through your system.
  446.      You can define up to ten report templates, and each file that comes
  447.      in will be checked against each of the these templates as to
  448.      whether it should be reported here.  Each template defines an echo
  449.      area to put the message in, and the groups (inbound) that are to be
  450.      reported.  YaTic will automatically perform reporting of any
  451.      (successfully processed) files during a normal toss operation.
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.       Yatic v1.00                                           Page : 7
  462.      ───────────────────────────────────────────────────────────────────
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.           Upon selecting this menu option, you will be presented with a
  472.      list showing the ten possible templates.  Each has four columns
  473.      specifying whether it is active, whether it will also report
  474.      hatches, what echo area it is put into, and lastly, the groups that
  475.      are to be reported using this template.  You can select any of
  476.      these 10 templates to edit.
  477.  
  478.           All reports go into packets.  I found this to be the most
  479.      convenient system for outputting echo mail, since it removes the
  480.      problems of having to write an interface for all the available mail
  481.      types.  You should address the packets to your own system (either
  482.      from your own system, or from a bogus address), and ensure that
  483.      your mail tosser does not check the systems that are sending mail
  484.      in that area.
  485.  
  486.           Selecting one will bring up a new entry screen showing the
  487.      options available for that template.  These options are as follows.
  488.  
  489.      Active : If set to 'N', this template will be ignored when
  490.           processing inbound attaches.
  491.  
  492.      Hatches : Should hatches within the given areas also be reported
  493.           here?
  494.  
  495.      To Addr : The address echomail messages (and the associated
  496.           packets) should be addressed.  (I would suggest your own
  497.           address, and using an area that is not secure in your mail
  498.           tosser).
  499.  
  500.      From Addr : The address the echomail messages (and packets) should
  501.           be marked as coming from.  I use an address that does not
  502.           exist for that area, and an insecure area (within my mail
  503.           tosser).  That means I can put messages into the area and have
  504.           them exported to all connected systems without having any mail
  505.           lost or sent to nonexistent systems.
  506.  
  507.      Area : The echomail tag of the area to place the messages in.
  508.  
  509.      To User : Who to address the messages to.
  510.  
  511.      In Groups : Inbound files must come in one of these (inbound)
  512.           groups before they will be reported.
  513.  
  514.      Subject : The subject line of the message containing the report.
  515.  
  516.      Origin : The origin line of the message.
  517.  
  518.      Template : The text file describing the format of the message
  519.           itself.  This file is described in much greater detail below,
  520.           and a sample should have come in the archive.
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.       Yatic v1.00                                           Page : 8
  528.      ───────────────────────────────────────────────────────────────────
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.      Areas
  538.      ─────
  539.  
  540.           YaTic has it's own inbuilt area database that is maintained
  541.      here.  It is very similar to that seen in the echo mail processor
  542.      TosScan and later such programs.  You can cycle through the areas
  543.      set up using the left and right arrows, along with the home and end
  544.      keys.  The following keys will also work :
  545.  
  546.      del  : Delete the current area
  547.      ins  : Insert a new area
  548.      F1   : Edit the current area
  549.      F2   : Edit the list of systems connected to this area
  550.      F3   : Select AKA to be used for this area.  (You will  be given a
  551.           menu of defined addresses to choose from.)
  552.      F3   : Go into "global" mode, changing attributes over a set of
  553.           areas, defined by in and out security.
  554.  
  555.           To make jumping to an area easier, the manager will accept
  556.      normal ASCII input, and will use the string selected so far to find
  557.      the best match area.  Thus pressing 'BBS' will jump to the area
  558.      BBS_FILES (or the nearest possible match to a string starting with
  559.      'BBS'.)
  560.  
  561.  
  562.      Editing an Area
  563.      ───────────────
  564.  
  565.           Hitting ins or F1 on an area will put you into edit mode.
  566.      This is a TCXL entry form, allowing you to edit most of the fields
  567.      (the list of connected systems is handled later).  The fields you
  568.      can edit are as follows :
  569.  
  570.      Area Name : The TIC name (tag) of this area.  This is the name
  571.           YaTic will look for in the TIC file associated with a given
  572.           file.
  573.  
  574.      Comment : This is a comment you might want to make about this area.
  575.           The comment will appear in YatMan lists sent to requesting
  576.           systems, so it should explain what the area is.
  577.  
  578.      Directory : The directory into which files for this area will be
  579.           moved.
  580.  
  581.      List Filename : The name of the file that will have the information
  582.           about new files in this area appended to.  This is typically
  583.           just FILES.BBS (for RA systems and the like).  It can be fully
  584.           pathed, or the name given here will be appended onto the
  585.           directory for this area.
  586.  
  587.                Thus, for an area residing in the directory C:\TIC, we
  588.           could have a list filename of LIST\FILES.BBS, and the new line
  589.           would be appended to the file C:\TIC\LIST\FILES.BBS
  590.  
  591.  
  592.  
  593.       Yatic v1.00                                           Page : 9
  594.      ───────────────────────────────────────────────────────────────────
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.      List Style : This allows you to uniquely specify the line that will
  604.           be added to the List file given above.  It is a normal text
  605.           string with control words embedded in it.  For Example :
  606.  
  607.           %12NAME% [00] %DESC%
  608.  
  609.           This will give the name of the file just imported, left
  610.           justified in a field of 12 characters, followed by a space,
  611.           followed by [00], a space, and the description of the file.
  612.           if I had written %12!NAME%, I would have got the name of the
  613.           file right justified in a field of 12 characters.  Just %NAME%
  614.           would have given the name without any spacing before or after.
  615.           (The line above gives a standard FILES.BBS entry with a two
  616.           digit download counter).
  617.  
  618.                Currently the only other control word known by YaTic is
  619.           %AREA% to give the area name of this area in the files list.
  620.           I have plans to improve the number of elements in this list in
  621.           the near future.
  622.  
  623.      Inbound Group : This is the main security section of YaTic, and is
  624.           a single letter, from 'A' to 'Z'.  For a file to be accepted
  625.           from a node in this area, that node MUST have this letter in
  626.           its inbound security area list.
  627.  
  628.      Outbound Group : Similar to above, but it is for node receiving
  629.           files from you.  This means you could have to nodes who ONLY
  630.           send files into the area, but never want any.  All the nodes
  631.           that receive the files in this area would have this letter,
  632.           but not the two that send files to it.
  633.  
  634.      Passthru : Defines this area as a passthrough area.  That means
  635.           that you don't keep files in it.  They are simply sent on to
  636.           downlinks who require them, and then deleted.  Note that in
  637.           this case the directory argument is ignored.  Files will be
  638.           placed in the tic outbound directory, and deleted after all
  639.           downlinks have received them.
  640.  
  641.                Note that for these file to be deleted, yatic /maint MUST
  642.           be run.  This checks the TIC files in the outbound, and any
  643.           extraneous files without an attached TIC file will be deleted.
  644.           It is NOT done automatically by tic, so as to speed up normal
  645.           processing.
  646.  
  647.      Allow Replace : This means REPLACES lines are allowed in this area.
  648.           Later versions of TIC allow for updates of files to come in,
  649.           deleting the older version of this file.  If you do not want
  650.           updates to work in this area, simply set this to 'N'.
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.       Yatic v1.00                                           Page : 10
  660.      ───────────────────────────────────────────────────────────────────
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.      Dupes Age : Dupe lists can tend to get a bit large, and yatic
  670.           /maint is needed to reduce them in size.  The sets the number
  671.           of days you will keep dupe information for inbound files.  Any
  672.           dupe info older than this number will be deleted on the next
  673.           maintenance run.
  674.  
  675.                Setting this to 0 will ensure that dupes are never packed
  676.           by age in this area.
  677.  
  678.      Dupes Number : Similar to above, but sets the maximum number of
  679.           dupe entries to keep.  Any amount greater than this number
  680.           will be reduced by deleting the oldest files when /maint is
  681.           run.
  682.  
  683.                Setting this to 0 will ensure that dupes are never packed
  684.           by number.  (Setting both number and age to 0 will ensure that
  685.           dupes are just never packed!).
  686.  
  687.      Check Dupes : This option will turn of dupe checking for this area
  688.           entirely.  Note that even if this is 'Y', dupes will not be
  689.           checked for unless the same option in the general
  690.           configuration is also 'Y'.
  691.  
  692.      Global
  693.      ──────
  694.  
  695.           You can also make changes over many areas at a time.  Hitting
  696.      F3 will bring you to the global menu.  Simply select the option you
  697.      wish to change from this menu, and then the inbound and outbound
  698.      groups an area must belong to be changed.  You will find that for
  699.      each option, a new window will pop up asking for related
  700.      information - the information wanted here is discussed in the
  701.      sections above.
  702.  
  703.      Nodes
  704.      ─────
  705.  
  706.           As for areas, nodes are stored in a special database that
  707.      YaTic can access easily.  Selecting nodes in the main menu will
  708.      take you to a section similar to that for areas above.  Here you
  709.      can move through the nodes as above, deleting or inserting.  (You
  710.      will find that if you enter this option with no nodes defined you
  711.      will be placed straight into edit mode of a new node.  The same
  712.      goes for areas above).
  713.  
  714.           Unlike areas however, there are no global options on nodes.
  715.      When editing a node, the options are as follows :
  716.  
  717.      Address : The address of this mode.  This can be a full 5D address,
  718.           just zone:net/node or zone:net/node.point.
  719.  
  720.  
  721.  
  722.  
  723.  
  724.  
  725.       Yatic v1.00                                           Page : 11
  726.      ───────────────────────────────────────────────────────────────────
  727.  
  728.  
  729.  
  730.  
  731.  
  732.  
  733.  
  734.  
  735.      Password : This is the password that YaTic will expect to see in
  736.           TIC files from this node, and will send in TIC files to this
  737.           node.  It is also the password to be used in YatMan requests
  738.           (on the subject line).
  739.  
  740.      In Security : The list of inbound security groups belonged to by
  741.           this node.  For this node to send you files in an area, he
  742.           must have that areas In Security group in this list.
  743.  
  744.      Out Security : The list of outbound security groups belonged to by
  745.           this node.  In order to receive files in a given area, the
  746.           node must have the Out Security for that area in this list.
  747.  
  748.      Auto In Sec : If this node is allowed to Create new areas (see Can
  749.           Create below), this is the In Security that will be given to
  750.           any areas so created.
  751.  
  752.      Auto Out Sec : Similar to above, but corresponds to the outbound
  753.           security of the autoadded areas.
  754.  
  755.      YatMan : Is this node allowed to make YatMan requests?  If set to
  756.           'N' the only way the node will be able to alter his/her
  757.           connected lists is by direct request to the SySop, since
  758.           YatMan will ignore any requests.  (In fact it will send back a
  759.           reply saying "I don't know you").
  760.  
  761.      Can Create : This is normally used on your main TIC hub.  Sometimes
  762.           this node might send through new areas to you without telling
  763.           you first.  If this option is enabled, YaTic will simply add
  764.           the area to it's list of areas, and process the area as
  765.           normal.  Any nodes with 'New Areas' set to 'Y' will be
  766.           connected to the area, and the directory for the area will be
  767.           set to your autoadd dir with the area name concatenated on the
  768.           end.  You should only allow this option for trusted nodes.
  769.  
  770.      4D Compatible : Tick does not (at the time of writing) know about
  771.           points as such, and will throw out error messages if it comes
  772.           across seenby lines with points.  For downlinks using TIC you
  773.           might want to remove such lines.  Setting this to 'Y' will
  774.           mean that TIC files going to this system will be filtered, and
  775.           such lines removed.
  776.  
  777.      Remote Maint : Again this option should only be turned on for VERY
  778.           trusted nodes.  It allows such nodes to remove areas.  (At a
  779.           later date it will be able to do more).  This would be
  780.           primarily used by your uplink when he/she removes an area from
  781.           the system.  Sending YatMan a maintenance request at the same
  782.           time will help ensure you have no redundant areas on your
  783.           system.
  784.  
  785.                A request to delete an area is exactly as for a normal
  786.           removal request, except that instead of '-' a '^' is prepended
  787.           to the area name.
  788.  
  789.  
  790.  
  791.       Yatic v1.00                                           Page : 12
  792.      ───────────────────────────────────────────────────────────────────
  793.  
  794.  
  795.  
  796.  
  797.  
  798.  
  799.  
  800.  
  801.      Terminal : Terminal nodes do not resend files to anyone, and do not
  802.           want the TIC file normally associated with echoed files.
  803.           Setting this option to 'Y' will mean that any files sent to
  804.           this system will not be accompanied by the corresponding
  805.           tk*.tic file.
  806.  
  807.      New Areas : If this option is set to 'Y', then this node will
  808.           automatically be hooked up to areas autoadded by other nodes.
  809.  
  810.      Mail Type : This is way of holding mail for this node. It can be
  811.           one of 'H'old, 'N'ormal, 'D'irect, 'C'rash.
  812.  
  813.  
  814.      Import/Export
  815.      ─────────────
  816.  
  817.           YaTic can import information about the areas and connected
  818.      nodes on your system from a TIC.CFG file.  NOTE : This option will
  819.      delete your old area list.
  820.  
  821.           It should be noted that by necessity this option is fairly
  822.      limited.  All added nodes are given an in/out security of 'A' and
  823.      so are all areas.  This means you will have to go through and edit
  824.      these by hand.  Also nodes are given the first password that YaTic
  825.      can find in the TIC file, so care should also be taken here.
  826.  
  827.           You will also have to set up other information, such as your
  828.      system addresses and the like, by hand.
  829.  
  830.           As of version 1.00, YaTic will also export a TIC file.  It is
  831.      however somewhat primitive, and the control information may have to
  832.      be edited by hand (remembering that YaTic and Tick handle certain
  833.      functions in different manners).
  834.  
  835.  
  836.      Text Files
  837.      ───────────────────────────────────────────────────────────────────
  838.  
  839.      YatMan templates
  840.      ────────────────
  841.  
  842.           YaTic uses some additional text files in its configuration.
  843.      These are for YatMan messages.  At this time, the following files
  844.      are used.  The names and locations of these files can all be
  845.      defined within YTCONFIG :
  846.  
  847.      YATPASS.TXT : Will be sent to a node who sent a request with the
  848.           wrong password.
  849.  
  850.      YATUNKN.TXT : Sent to nodes that do a YatMan request, and who are
  851.           unknown on your system.
  852.  
  853.  
  854.  
  855.  
  856.  
  857.       Yatic v1.00                                           Page : 13
  858.      ───────────────────────────────────────────────────────────────────
  859.  
  860.  
  861.  
  862.  
  863.  
  864.  
  865.  
  866.      YATHELP.TXT : Sent to any node requesting help from YatMan (using
  867.           the %HELP command in the request message).
  868.  
  869.           These files should be straight text, formatted as you want
  870.      them to appear in the message.  For ease of use, you can uses
  871.      embedded control words, similar to those used in the list string.
  872.      Allowable control words are :
  873.  
  874.      %name%         : Full name of the requestor.
  875.      %firstname%    : First name of the requestor.
  876.      %lastname%     : Last name of the requestor.
  877.      %passfailed%   : The password that failed (should only be used for
  878.           YATPASS.TXT).
  879.      %address%      : The address of the node that sent the request.
  880.  
  881.      Report Templates
  882.      ────────────────
  883.  
  884.           In order for YaTic to report on processed files, it needs a
  885.      template to tell it how to format the information in the message.
  886.      The template is broken into blocks, according to the part of the
  887.      message it is describing.  Each block starts with a block
  888.      descriptor (a command beginning with a '\' telling YaTic which
  889.      block this is), and continues until another block starts.  Any text
  890.      within the block (after the command line) will be used for that
  891.      part of the message, with control words being translated as for the
  892.      message templates given above.  An example template came with the
  893.      distribution archive, under the name REPORT.TPL.
  894.  
  895.           The blocks that can be used are as follows :
  896.  
  897.      \header : Starts of the message.  Anything here will be put at the
  898.           start of the report.  This might tell people what the messages
  899.           is, or the hours you allow file requests.
  900.  
  901.      \file : This block is put into the message once for every file
  902.           processed.  It is used to put the name, description and/or any
  903.           other information you desire.  The control words usable are
  904.           listed below.
  905.  
  906.      \break : When the message is getting too long, YaTic will break it
  907.           into parts.  This block will be placed at the end of every
  908.           message that makes up the report, but is not the last.
  909.  
  910.      \continuation : Placed at the start of messages that continue a
  911.           report started in previous messages.  It might contain
  912.           something as simple as "Continued from previous message".
  913.  
  914.      \trailer : The round up.  This block is placed on the end of the
  915.           final message in the report.  I use it to tell the reader how
  916.           many bytes of files were processed.
  917.  
  918.  
  919.  
  920.  
  921.  
  922.  
  923.       Yatic v1.00                                           Page : 14
  924.      ───────────────────────────────────────────────────────────────────
  925.  
  926.  
  927.  
  928.  
  929.  
  930.  
  931.  
  932.           The following control words can be used in the report.
  933.      Formatting is as given for the message templates above :
  934.  
  935.      %name%         - Name of the file just processed.
  936.      %desc%         - Description of the file just processed.
  937.      %file_size%    - Size of the file just processed.
  938.      %area%         - Area of the file just processed.
  939.      %area_desc%    - Description of the current area.
  940.      %total_size%   - Total bytes of all files processed.
  941.  
  942.           Other control words will be added in future versions.  Any
  943.      requests, let me know.
  944.  
  945.      ───────────────────────────────────────────────────────────────────
  946.                                 Running YaTic
  947.      ───────────────────────────────────────────────────────────────────
  948.  
  949.           YaTic is run from the command line, and should be run from
  950.      it's own directory.  (This will be fixed at a later date to allow
  951.      to run from ANY directory).  Running YATIC /? will bring up a help
  952.      screen.
  953.  
  954.      Normal Running
  955.      ──────────────
  956.  
  957.           During a normal run, when you want Yatic to scan for inbound
  958.      tic files and YatMan requests normally, you should run plain YATMAN
  959.      in your batch file.  However there may be times when you wish to
  960.      disable YATMAN.  This is done by running
  961.  
  962.      YATIC /nomgr
  963.  
  964.      Maintenance
  965.      ───────────
  966.  
  967.           YATIC /maint will run the maintenance required for YaTic.
  968.      This includes packing the dupes files according to the information
  969.      you have provided in the area manager.  It will also delete files
  970.      in passthru areas that have been sent to all the downlinks.  If you
  971.      do have passthru areas, then /maint should be run at least once a
  972.      week to ensure space on your drive is freed up.
  973.  
  974.      Other Switches
  975.      ──────────────
  976.  
  977.           There are two other switches to help in day to day running of
  978.      YaTic, these are /NOCRC to turn off any CRC checking while
  979.      processing files, and /NODUP to turn off dupe checking.  These
  980.      might be useful when something goes wrong with inbound files and a
  981.      re-process is needed.
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.  
  989.       Yatic v1.00                                           Page : 15
  990.      ───────────────────────────────────────────────────────────────────
  991.  
  992.  
  993.  
  994.  
  995.  
  996.  
  997.  
  998.  
  999.      Hatch
  1000.      ─────
  1001.  
  1002.           YaTic also allows you to hatch files into an area by creating
  1003.      the appropriate TIC file and sending the file to ALL your
  1004.      downlinks.  To hatch a file, use the command
  1005.  
  1006.      YATIC /hatch
  1007.  
  1008.           YaTic will then prompt you for the name of the file to hatch
  1009.      (full name, no wildcards allowed) and the area name.  It will then
  1010.      send the file.  At this time YaTic does not support delayed
  1011.      releases of files; this will be supported in future versions.
  1012.  
  1013.           YaTic also now supports command line hatching (mainly for
  1014.      batch file processing).  The command
  1015.  
  1016.      YATIC /hatch /?
  1017.  
  1018.      will bring up a help screen listing the options associated with
  1019.      hatch.  These are :
  1020.  
  1021.      /f   File name.  FULL PATH and name of the file to be hatched.  At
  1022.           this time, wildcards are not supported.
  1023.  
  1024.      /a   Area name.  The area tag of the area for the file to be
  1025.           hatched in.
  1026.  
  1027.      /d   A description of the file being hatched.  This is in inverted
  1028.           commas, and should be kept as short as possible.
  1029.  
  1030.      /r   Replaces.  This activates the replaces function in YaTic
  1031.           hatch.  The file name given will be put with the REPLACES
  1032.           keyword in all outbound TIC files.  Any receiving system will
  1033.           replaces the file given here with the new file (deleting the
  1034.           old).  This option is generally used for new versions of a
  1035.           program.
  1036.  
  1037.           Thus the command line :
  1038.  
  1039.      YATIC /hatch /f d:\yat19.arj /a YT_DEV /d "New Yatic" /r yat18.arj
  1040.  
  1041.      will hatch the file d:\yat19.arj in the area YT_DEV with the
  1042.      description New Yatic.  The file yat18.arj in the area will be
  1043.      replaced with the new version.
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.       Yatic v1.00                                           Page : 16
  1056.      ───────────────────────────────────────────────────────────────────
  1057.  
  1058.  
  1059.  
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.      ───────────────────────────────────────────────────────────────────
  1066.                             Area Manger - YatMan
  1067.      ───────────────────────────────────────────────────────────────────
  1068.  
  1069.           YatMan is the remote area manager associated with YaTic.  It
  1070.      can be used by your downlinks so that they can connect to and
  1071.      disconnect from areas without having to worry you about it.
  1072.  
  1073.           For a downlink to utilize YatMan they simply send a netmail
  1074.      message to your system as follows :
  1075.  
  1076.      FROM : Remote sysops name
  1077.      TO   : YatMan
  1078.      SUBJECT : Password <── This is the password for the node in the
  1079.           node manager.
  1080.      ───────────────────────────────────────────────────────────────────
  1081.      SOFTDIST       <── Turn this area on
  1082.      WIN_UTIL       <── And this
  1083.      -BBSFILES      <── Turn this area off
  1084.      ^win_prog      <── Delete this area entirely
  1085.      %LIST          <── Send a list of possible areas
  1086.      %QUERY         <── Send a list of connected areas and information.
  1087.      %HELP          <── Send a list of commands
  1088.      ───
  1089.  
  1090.           This request, if the password in the subject field is correct,
  1091.      will turn on the echos SOFTDIST and WIN_UTIL, and turn of BBSFILES.
  1092.      Following this it will delete the area win_prog from the YaTic
  1093.      database ENTIRELY (assuming the node is allowed to perform remote
  1094.      maintenance).  It will then send the node a list of all the echos
  1095.      it may connect to, with those that it IS connected to marked with a
  1096.      '*' on the left.  The query option will send the node a list of all
  1097.      the areas it is connected to, along with some other information
  1098.      about the capabilities of that node, and the help option will send
  1099.      a help message, outlining these options.
  1100.  
  1101.           Anything after the tear line will be ignored.
  1102.  
  1103.           YaTic will delete any messages it processes and mark the
  1104.      replies as Kill/Sent according to the options specified in the
  1105.      configuration.
  1106.  
  1107.  
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.  
  1119.  
  1120.  
  1121.       Yatic v1.00                                           Page : 17
  1122.      ───────────────────────────────────────────────────────────────────
  1123.  
  1124.  
  1125.  
  1126.  
  1127.  
  1128.  
  1129.  
  1130.  
  1131.      ───────────────────────────────────────────────────────────────────
  1132.                         Afterword - Future Directions
  1133.      ───────────────────────────────────────────────────────────────────
  1134.  
  1135.           I hope that YaTic is in itself a complete program, and I hope
  1136.      you get a lot of use out of it.  However, I am planning to add a
  1137.      few enhancements to it in the near future :
  1138.  
  1139.  
  1140.      o    Improve the area manager.  Would like to have the areamanager
  1141.           automatically send unlink requests to downlinks when it gets
  1142.           told to delete an area.
  1143.  
  1144.      o    It would also be nice to have a system whereby, when a person
  1145.           creates a new area, the first TIC file they send will contain
  1146.           the area description.
  1147.  
  1148.      o    A file area manager.  One of the problems with the TIC system
  1149.           is a lot of stuff neither you nor your users ever want to use
  1150.           comes through the system.  It would be nice for YaTic to see
  1151.           how many times a file is downloaded over time, and if it isn't
  1152.           enough, move it to another area where you as the SySop can
  1153.           deal with it as wished.
  1154.  
  1155.      o    Secondary areas (as per TIC).
  1156.  
  1157.      o    Better import/export options.  Ability to export to various
  1158.           BBS formats (such as FILES.RA).
  1159.  
  1160.      o    Automatic updating of various database formats being used to
  1161.           store file lists for fast updates.
  1162.  
  1163.  
  1164.      ───────────────────────────────────────────────────────────────────
  1165.                          Credits and Acknowledgments
  1166.      ───────────────────────────────────────────────────────────────────
  1167.  
  1168.           The following copyrighted programs were mentioned in the
  1169.      document :
  1170.  
  1171.      o    Tosscan   Joaquim Homrighausen
  1172.      o    Tick      Barry Geller
  1173.      o    AllFix    Harms Software Engineering
  1174.      o    Raid      George Peace
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185.  
  1186.  
  1187.       Yatic v1.00                                           Page : 18
  1188.      ───────────────────────────────────────────────────────────────────
  1189.