home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / sqld100p.lzh / SDUSRMAN.DOC < prev    next >
Text File  |  1993-05-15  |  12KB  |  381 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                              Squalid V1.00 User's Guide
  7.                                     Greg Newton
  8.                                  FidoNet 3:632/376
  9.                                     15 May, 1993
  10.  
  11.                                      based upon
  12.  
  13.                              AreaFix v1.20 User's Guide
  14.                                  Jeffrey J. Nonken
  15.                                  19 September 1990
  16.                                (used with permission)
  17.  
  18.                                 ABOUT THIS DOCUMENT
  19.                                 ===================
  20.  
  21.        This document is public domain. Please note that this does not alter
  22.        the rights or ownership status of the copyright holder of Squalid in
  23.        any way.
  24.  
  25.        This is a user's guide to Squalid. This document does not describe how
  26.        to install Squalid; this document was created to allow echomail hubs
  27.        running Squalid to pass simple instructions around to their downlinks.
  28.  
  29.        To keep things simple the terms "uplink" and "downlink" are used. Your
  30.        uplink is the system that is passing echoes to you, usually from the
  31.        direction of the backbone or the origin of the echo (sometimes known
  32.        as an "echo feed"). You are per downlink. If you are passing the
  33.        echoes from your uplink to another node, that node is your downlink,
  34.        and you are per uplink. Simple? Good. This guide assumes your uplink
  35.        is running Squalid and tells you how to add and remove echomail areas
  36.        remotely using Squalid.
  37.  
  38.                                   WHAT IS SQUALID?
  39.                                   ================
  40.  
  41.        Squalid (SQUish Area List Interrogation Device) is a program that
  42.        allows sysops to remotely alter their uplinks' distribution file
  43.        (SQUISH.CFG) without bothering the uplinks' sysops. In other words, if
  44.        I want to pick up a certain echo from my uplink, and per has Squalid
  45.        installed, I just send a special message and the linking is handled
  46.        automatically. Ideally, my uplink's sysop does nothing once per has
  47.        set up Squalid.
  48.  
  49.                                    SQUALID SETUP
  50.                                    =============
  51.  
  52.        This is mostly your Hub's responsibility. Per has to install Squalid
  53.        on per system and install your password. You should pick a password to
  54.        use in your Squalid messages, or your uplink may choose one for you.
  55.        Remember this password! It may be from 1 to 30 characters long and may
  56.        contain any printable characters except spaces.
  57.  
  58.  
  59.  
  60.                                  TALKING TO SQUALID
  61.                                  ==================
  62.  
  63.        To invoke Squalid you must send a netmail message to your Hub. The
  64.        message should be private, addressed to Squalid, and the subject will
  65.        be your password. Case is not important.
  66.  
  67.             To: Squalid
  68.        Subject: Gronk
  69.  
  70.        Squalid will also allow psuedonyms for itself. Your Hub may have a
  71.        special name per wants you to send to instead of "Squalid" (a typical
  72.        example would be "AreaFix"). If so, per will tell you. For my examples
  73.        I will use "Squalid".
  74.  
  75.                                SQUALID TALKING TO YOU
  76.                                ======================
  77.  
  78.        Any time Squalid replies it will send you a message explaining what
  79.        action it took (if any) and giving you a list of echoes currently
  80.        active for you. If you are first on your uplink's list for a
  81.        particular area -- which usually implies that you are a 'feed' for
  82.        that area, the originator of the echo -- Squalid will put an asterisk
  83.        next to the echo name with a note that says you are your uplink's feed
  84.        for that echo. You will usually only see that for local echomail
  85.        areas, if at all.
  86.  
  87.        Some areas will be 'pass through' at your uplink, which means that per
  88.        does not keep a store of old messages, and thus the areas cannot be
  89.        re-scanned. Squalid will indicate such areas by prefixing the echo
  90.        name with an equality sign (=).
  91.  
  92.        Sometimes your uplink Sysop will specify some text to be included in
  93.        every message, which will appear before any automatically generated
  94.        text from Squalid.
  95.  
  96.                                  TURNING ON ECHOES
  97.                                   ================
  98.  
  99.        Turning on an echo is easy; simply send a message to Squalid with a
  100.        list of echoes you want. Case does not matter, and you may use the
  101.        wildcard 'ALL' to turn on all echoes which your Hub has made available
  102.        to you. The names may start in any column, and you may string them out
  103.        on a line (separated by spaces) or put them on separate lines. You may
  104.        optionally use the '+' prefix to indicate that you want to turn an
  105.        echo on.
  106.  
  107.           From: Tom Slick
  108.             To: Squalid
  109.        Subject: Gronk
  110.  
  111.        GREEN_EC_O
  112.        +FDECHO
  113.        TUB
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.        Squalid V1.00 User's Guide page 2
  122.  
  123.  
  124.  
  125.        Squalid replies:
  126.  
  127.           From: Squalid V1.00
  128.             To: Tom Slick
  129.        Subject: Echomail Change Requests
  130.  
  131.        Squalid V1.00 Echomail Control Utility
  132.  
  133.  
  134.        Area GREEN_EC_O                     added
  135.        Area FDECHO                         added
  136.        Area TUB                            added
  137.  
  138.                         Areas active for 3:631/199
  139.  
  140.         = FDECHO
  141.           TUB
  142.           GREEN_EC_O
  143.  
  144.        Total: 3
  145.        `>' : you are the feed
  146.        `=' : pass through area
  147.  
  148.                                  TURNING OFF ECHOES
  149.                                  =================
  150.  
  151.        Removing an area is just as easy; just precede the area name with a
  152.        minus sign (-) when you send the message.
  153.  
  154.           From: Tom Slick
  155.             To: Squalid
  156.        Subject: Gronk
  157.  
  158.        -GREEN_EC_O
  159.        -TUB
  160.  
  161.        Squalid replies:
  162.  
  163.           From: Squalid V1.00
  164.             To: Tom Slick
  165.        Subject: Echomail Change Requests
  166.  
  167.        Squalid V1.00 Echomail Control Utility
  168.  
  169.  
  170.        Area GREEN_EC_O                     deleted
  171.        Area TUB                            deleted
  172.  
  173.                         Areas active for 3:631/199
  174.  
  175.         = FDECHO
  176.  
  177.        Total: 1
  178.        `>' : you are the feed
  179.        `=' : pass through area
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.        Squalid V1.00 User's Guide page 3
  187.  
  188.  
  189.  
  190.                                  RESCANNING ECHOES
  191.                                  =================
  192.  
  193.        Squalid introduces a new feature for those familiar with AreaFix.
  194.        Individual echoes can be 'rescanned' in a similar manner to turning an
  195.        echo on or off. Simply precede the name of the echo with a caret
  196.        character (^), which Squalid interprets as 'add and then rescan'.
  197.  
  198.        Another way to achieve a rescan for one or more areas, is to precede
  199.        that area with the %RESCAN command. Only areas listed after the
  200.        command will be rescanned.
  201.  
  202.        Note that your uplink Sysop can disable rescan for some or all of per
  203.        downlinks.
  204.  
  205.           From: Tom Slick
  206.             To: Squalid
  207.        Subject: Gronk
  208.  
  209.        ^GREEN_EC_O
  210.        ^FDECHO
  211.        TUB
  212.        %RESCAN
  213.        OZ_ACCESSNET
  214.  
  215.        Squalid replies:
  216.  
  217.           From: Squalid V1.00
  218.             To: Tom Slick
  219.        Subject: Echomail Change Requests
  220.  
  221.        Squalid V1.00 Echomail Control Utility
  222.  
  223.  
  224.        Area GREEN_EC_O                     added
  225.        Area GREEN_EC_O                     rescanned
  226.        Area FDECHO                         not added (already active)
  227.        Area FDECHO                         not rescanned (passthrough area)
  228.        Area TUB                            added
  229.        Area OZ_ACCESSNET                   added
  230.        Area OZ_ACCESSNET                   rescanned
  231.  
  232.                         Areas active for 3:631/199
  233.  
  234.         = FDECHO
  235.           TUB
  236.           GREEN_EC_O
  237.           OZ_ACCESSNET
  238.  
  239.        Total: 4
  240.        `>' : you are the feed
  241.        `=' : pass through area
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.        Squalid V1.00 User's Guide page 4
  252.  
  253.  
  254.  
  255.                                       OPTIONS
  256.                                       =======
  257.  
  258.        There are a couple of useful options available. Each of these is
  259.        invoked by adding a command to your subject line after the password.
  260.        Note that any of these options can be disabled at your uplink Sysop's
  261.        discretion.
  262.  
  263.        -L sends you a list of echo areas. The uplink Sysop may make a list of
  264.        available areas in a file; if per has done this, the -L command will
  265.        cause Squalid to send it to you in a separate file-attach message. The
  266.        %LIST command in the body of your message is functionally identical to
  267.        the -L subject line switch. Simply use the one you prefer.
  268.  
  269.        -Q also sends you a list of echo areas. However, unlike the -L
  270.        command, it will scan through the Area Control files to see what areas
  271.        are available and send a list back in a message. Squalid will put a
  272.        quote character (>) next to each area that you are receiving. The
  273.        %QUERY command in the body of your message does the same thing as the
  274.        -Q subject line switch.
  275.  
  276.           From: Tom Slick
  277.             To: Squalid
  278.        Subject: Gronk -q
  279.  
  280.        (Squalid doesn't require that you put any text here, but your message
  281.        editor may! If you need to, just put a tear-line '---')
  282.  
  283.        Squalid replies:
  284.  
  285.           From: Squalid V1.00
  286.             To: Tom Slick
  287.        Subject: Echomail Change Requests
  288.  
  289.        Squalid V1.00 Echomail Control Utility
  290.  
  291.          Echomail Query Request
  292.  
  293.  
  294.          Areas available to 3:631/199
  295.  
  296.           AUST_C_HERE
  297.           AUS.CONSERVE
  298.           MUFFIN
  299.        >  TUB
  300.           NEW_ECHO
  301.        >= FDECHO
  302.           WORLDTLK
  303.        >  OZ_ACCESSNET
  304.        >  GREEN_EC_O
  305.           GREEN.029
  306.           ENVIRON
  307.  
  308.        Total: 11  Active: 4
  309.        `>' : active area for 3:631/199
  310.        `=' : passthrough area
  311.  
  312.  
  313.  
  314.  
  315.  
  316.        Squalid V1.00 User's Guide page 5
  317.  
  318.  
  319.  
  320.        The final option that can be used is the -H, or %HELP, option. If this
  321.        is enabled by your uplink, the -H option will send you a file that
  322.        contains instructions for using Squalid (it's very likely that you'll
  323.        get a copy of this file!). -? can be used instead of -H if you wish.
  324.        Note that you can use the -H, -L and -Q switches together or
  325.        separately, and you may use them with a message that contains changes
  326.        to areas, in which case they will reflect the situation after the
  327.        changes take effect.
  328.  
  329.                                     ACCESS KEYS
  330.                                     ===========
  331.  
  332.        When your uplink sets up your password, per will assign an access key
  333.        to you. It is possible that per will have some private or special
  334.        interest echoes that per does not want to have automated for Squalid
  335.        use. By assigning those areas a different key than per gives to per
  336.        downlinks, those downlinks will not be able to turn on those areas
  337.        remotely; the uplink sysop must enable those areas for the downlinks
  338.        by hand. However, if you are enabled for a restricted area and you
  339.        want to turn it off, you may do so via Squalid as usual. The
  340.        restriction is only one-way.
  341.  
  342.                                   ACKNOWLEDGEMENTS
  343.                                   ================
  344.  
  345.        Jeffrey J. Nonken
  346.        Ophiophile Maximus
  347.        Fidonet: 1:273/715
  348.        Internet: Jeffrey.Nonken@f715.n273.z1.fidonet.org
  349.        BBS: (215)279-9799
  350.  
  351.        The use of 'per' to indicate 'her', 'him', 'he', 'she' is adopted from
  352.        a novel by Marge Piercy, the name of which escapes me at the moment.
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.        Squalid V1.00 User's Guide page 6