home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / sqld100p.lzh / SQUALID.DOC < prev    next >
Text File  |  1993-01-24  |  39KB  |  1,281 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                          =================================
  8.  
  9.                           SQUALID V0.36b Reference Manual
  10.                                  24 January, 1993
  11.  
  12.                          =================================
  13.  
  14.        Squalid is an Areafix replacement for SysOps who wish to dispense
  15.        with AREAS.BBS, and use only SQUISH.CFG for area definitions.
  16.  
  17.        FEATURES/QUIRKS:
  18.  
  19.           *   zone grouping.
  20.  
  21.           *   intelligent request forwarding.
  22.  
  23.           *   does not require its own configuration file (uses Squish.Cfg).
  24.  
  25.           *   user defined aliases, i.e. "AreaFix", "EchoFix", "Jeeves".
  26.  
  27.           *   maintains 3-generation backup of Squish.Cfg.
  28.  
  29.           *   ADD, DELETE, CREATE and NOTIFY manual commands.
  30.  
  31.           *   subjectline Query, List and Help commands (-Q, -L and -H).
  32.  
  33.           *   support for %QUERY, %LIST, %HELP and %RESCAN in request
  34.               message.
  35.  
  36.           *   ADD + RESCAN for individual areas using area tag prefix (^) in
  37.               request message.
  38.  
  39.           *   32 keys (A-Z,1-6) for highly configurable security.
  40.  
  41.           *   Wildcard "ALL" supported in request messages.
  42.  
  43.           *   Rescan achieved by generation of a batch file.
  44.  
  45.           *   Squish format netmail area supported.
  46.  
  47.        Squalid serves no other purpose, and therefore it does not support
  48.        AREAS.BBS. Squalid supports fakenet points as normal nodes. Address
  49.        remapping must be performed externally (by Squish, for example).
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.        SQUALID V0.36b Reference Manual                                 Page 1
  66.  
  67.  
  68.  
  69.  
  70.        ===========
  71.        QUICK START
  72.        ===========
  73.  
  74.        1      Edit SQUISH.CFG to include AT LEAST a User for each of your
  75.               downlinks, at least one group definition (Uplinks not
  76.               mandatory), and an Info (or BlockInfo) for each echo area that
  77.               you want secured. If you run a system where ALL echo areas are
  78.               freely available to ALL downlinks (in the appropriate group),
  79.               Info does not need to be specified. Also, if rescanning is
  80.               enabled, you must specify RescanFile and RescanCmd.
  81.  
  82.        2      If you would like to see Squalid in action before committing
  83.               yourself to it, copy SQUISH.CFG to another file (perhaps
  84.               SQUALID.CTL), and use the command line option -cSQUALID.CTL so
  85.               that Squalid only modifies (and reads) the 'spare' file.
  86.  
  87.        3      Edit your main batch file so that Squalid is called after
  88.               incoming mail has been unpacked into the netmail area. You may
  89.               need to add a pack command after the invocation of Squalid, so
  90.               that any mail created by Squalid is packed to be sent.
  91.  
  92.        4      To let your down (and up) links know their current status, run
  93.               "Squalid NOTIFY * -aSDUSRMAN.DOC" (or "Squalid NOTIFY * -
  94.               cSQUALID.CTL -aSDUSRMAN.DOC" if you've followed step 2). This
  95.               will send a current status message to all links, and attach
  96.               the file SDUSRMAN.DOC, which is the Squalid end-user
  97.               instruction manual.
  98.  
  99.        5      Other Squalid configuration items worth noting are Sysop,
  100.               Elist, Forward, RescanFile, RescanCmd, RescanLock, Query,
  101.               Header and Trailer.
  102.  
  103.        The syntax for the Squalid command line is:
  104.  
  105.        SQUALID <action> <modifiers> <parameters> <options>
  106.  
  107.             <action>       One of AUTO, NOTIFY, ADD, DELETE, CREATE
  108.  
  109.             <modifiers>    Action dependent. See individual actions for
  110.                            details.
  111.  
  112.             <parameters>   Action dependent. See individual actions for
  113.                            details.
  114.  
  115.             <options>      Zero or more of
  116.  
  117.                            -a<filespec>
  118.                            -c<squishcfg>
  119.                            -q<squalidcfg>
  120.  
  121.                            See below for details.
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.        SQUALID V0.36b Reference Manual                                 Page 2
  130.  
  131.  
  132.  
  133.  
  134.        ========
  135.        ACTIONS:
  136.        ========
  137.  
  138.             AUTO           Read netmail area and search for messages
  139.                            addressed to "Squalid", or another alias as
  140.                            defined in the configuration file.  Equivalent to
  141.                            Areafix EC.
  142.  
  143.                            Modifiers: -a, -p, -f, -l
  144.                            No parameters.
  145.  
  146.             NOTIFY         Sends a list of all connected (and available)
  147.                            areas to specified nodes. The same as the subject
  148.                            line switch 'Q'.
  149.  
  150.                            Modifiers: none.
  151.                            Parameters: <nodelist>
  152.  
  153.             ADD            Add the specified nodes to the specified echoes.
  154.  
  155.                            Modifiers: -m, -r
  156.                            Parameters: <echolist> <nodelist>
  157.  
  158.             DELETE         Remove the specified node(s) from the specified
  159.                            echo(es).
  160.  
  161.                            Modifiers: -m
  162.                            Parameters: <echolist> <nodelist>
  163.  
  164.             CREATE         Create a new echo, and add the specified nodes to
  165.                            it.
  166.  
  167.                            Modifiers: -m, -p, -f, -l
  168.                            Parameters: <echotag> <nodelist>
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.        SQUALID V0.36b Reference Manual                                 Page 3
  194.  
  195.  
  196.  
  197.  
  198.        =======================================
  199.        OPTIONS (can be used for any <action>):
  200.        =======================================
  201.  
  202.             -a<filespec>   Create a file attach message to all specifed
  203.                            nodes, attaching the file <filespec>. Multiple
  204.                            fileattach messages may appear on the command
  205.                            line, or you may specify
  206.  
  207.             -c<squishcfg>  Use the file <squishcfg> instead of either the
  208.                            file specified by the SQUISH environment variable
  209.                            or SQUISH.CFG in the current directory.
  210.  
  211.             -q<squalidcfg> Get Squalid configuration items from the file
  212.                            <squalidcfg> instead of from SQUISH.CFG. This is
  213.                            simply an 'additional' file to the normal
  214.                            configuration file, and items may appear in
  215.                            either or both files. Squalid will never modify
  216.                            this file, and any Info lines appropriate to
  217.                            created areas will be put into the main
  218.                            configuration file.
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.        SQUALID V0.36b Reference Manual                                 Page 4
  258.  
  259.  
  260.  
  261.  
  262.        ==========
  263.        MODIFIERS:
  264.        ==========
  265.  
  266.             -n<netmail>    Search only the specified area for messages to
  267.                            Squalid. Squish format areas are specified by
  268.                            preceding the path with a $. Only used by the
  269.                            AUTO action.
  270.  
  271.             -p<path>       Use <path> as base for creating new areas. Must
  272.                            be specified either on the command line or in the
  273.                            configuration file (configuration item
  274.                            CreatePath). Only used by the CREATE action.
  275.  
  276.             -f<flags>      Use <flags> when creating new areas. The flags
  277.                            must follow immediately after the 'f', as shown
  278.                            in the examples below. Multiple flags can be
  279.                            specified by separating them with one or more
  280.                            underscores. May be specified either on the
  281.                            command line or in the configuration file
  282.                            (configuration item AutoFlags). Used by the
  283.                            CREATE action, and by the AUTO action if new
  284.                            areas are created.
  285.  
  286.             -l<locks>      Use <locks> when creating new areas.  May be
  287.                            specified either on the command line or in the
  288.                            configuration file (configuration item
  289.                            CreateLocks). Used by the CREATE action, and by
  290.                            the AUTO action if new areas are created. This
  291.                            could also be used to force the group of the
  292.                            area, by including @<group> as part of the lock
  293.                            string, separated from any locks by an
  294.                            underscore.
  295.  
  296.             -m             Create a netmail message informing the specified
  297.                            nodes of any changes made. May be used with ADD,
  298.                            DELETE, or CREATE actions.
  299.  
  300.             -r             Create a rescan batch file (default SDRESCAN.BAT)
  301.                            for the areas and nodes given. May be used with
  302.                            the ADD action only.
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.        SQUALID V0.36b Reference Manual                                 Page 5
  322.  
  323.  
  324.  
  325.  
  326.        ===========
  327.        PARAMETERS:
  328.        ===========
  329.  
  330.             <nodelist>     <nodelist> specifies one or more network
  331.                            addresses, separated by spaces. The addresses
  332.                            must be those of valid Users, as specified in the
  333.                            configuration file. The wildcard character *
  334.                            specifies all nodes that have been specified by
  335.                            User statements.
  336.  
  337.             <echotag>      the echo tag used to identify a particular echo.
  338.                            i.e.
  339.  
  340.                            MUFFIN
  341.  
  342.             <echolist>     specifies one or more <echotag>s, separated by
  343.                            white space. The wildcard 'ALL' specifies all
  344.                            echo areas with locks that may be opened by the
  345.                            specified node(s) keys. i.e.
  346.  
  347.                            WORLDTLK TUB MUFFIN GREEN.029 GREEN_EC_O
  348.  
  349.                            ALL
  350.  
  351.           The ADD and DELETE actions can use either, but not both of the
  352.           wildcards * and ALL. CREATE and NOTIFY can use the * wildcard
  353.           only.
  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.  
  382.  
  383.  
  384.  
  385.        SQUALID V0.36b Reference Manual                                 Page 6
  386.  
  387.  
  388.  
  389.  
  390.        ====================
  391.        BATCH FILE EXAMPLES:
  392.        ====================
  393.  
  394.        1. FrontDoor
  395.  
  396.           :loop
  397.           fd
  398.           if errorlevel 100 goto incomingmail
  399.  
  400.           :incomingmail
  401.           squish in out squash link
  402.           squalid auto
  403.           if not exist sdrescan.bat goto loop
  404.           call sdrescan
  405.           del sdrescan.bat
  406.           goto loop
  407.  
  408.        2. BinkleyTerm
  409.  
  410.           :loop
  411.           bt unattended
  412.           if errorlevel 100 goto incomingmail
  413.  
  414.           :incomingmail
  415.           squish in out squash link
  416.           squalid auto
  417.           if errorlevel 2 goto sendanswers
  418.           goto loop
  419.           :sendanswers
  420.           if not exist sdrescan.bat goto packit
  421.           call sdrescan
  422.           del sdrescan.bat
  423.           :packit
  424.           squish out squash
  425.           goto loop
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.        SQUALID V0.36b Reference Manual                                 Page 7
  450.  
  451.  
  452.  
  453.  
  454.        ======================
  455.        COMMAND LINE EXAMPLES:
  456.        ======================
  457.  
  458.        Note that the command line syntax for Squalid is order-independent.
  459.  
  460.        SQUALID CREATE BAROQUE -m -f-f_-p83:199/136 631/199
  461.  
  462.           Will create the new echo area 'BAROQUE', using the flags '-f'
  463.           (*.msg format) and '-p83:199/136' (use 83:199/136 as alternate
  464.           primary address), and add the node 631/199 to the scan list. Send
  465.           a message to 631/199 informing per of the new area. The group for
  466.           'BAROQUE' will be automatically determined based on your primary
  467.           address.
  468.  
  469.        SQUALID -r ADD 631/200 BAROQUE 631/201 -anewsweek.001
  470.  
  471.           will add the nodes 631/200 and 631/201 to the area BAROQUE, and
  472.           send the file 'newsweek.001' to each of them. The messages in the
  473.           area will be rescanned to both nodes.
  474.  
  475.        SQUALID 631/199 -m BAROQUE DELETE
  476.  
  477.           will remove node 631/199 from the BAROQUE echo, and send a message
  478.           informing per of the change.
  479.  
  480.        ERRORLEVELS
  481.  
  482.           Exit errorlevels are bitmapped, for no particular reason at all.
  483.           The levels are:
  484.  
  485.                0      Nothing happened
  486.                1      New message(s) addressed to Squalid were read
  487.                2      Message(s) were sent by Squalid
  488.                4      Request(s) were sent to uplink(s)
  489.                8      SQUISH.CFG was altered
  490.                128    A critical error occurred
  491.  
  492.           The most likely errorlevels for SQUALID AUTO are in fact, 0, 3, 7,
  493.           11 or 15 (barring critical errors!).
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.        SQUALID V0.36b Reference Manual                                 Page 8
  514.  
  515.  
  516.  
  517.  
  518.        ====================
  519.        Configuring Squalid.
  520.        ====================
  521.  
  522.           Squalid requires an ASCII plain text configuration file. This file
  523.           is searched for in the following manner: if the command line
  524.           option -c<configfile> is given, that file will be used; if the
  525.           SQUISH environment variable is present, the file that it specifies
  526.           will be used; otherwise "SQUISH.CFG" in the current directory will
  527.           be used. If the -q<squalidcfg> command line option is used, the
  528.           file specified will be read AFTER the other configuration file.
  529.  
  530.           Squalid gets much of its information from existing Squish
  531.           configuration items, and additional configuration items specific
  532.           to Squalid are inserted in Squish.CFG (or may be put into a
  533.           separate file, with some limitations).
  534.  
  535.           All Squalid configuration items begin with "App Squalid". This is
  536.           the recommended method for utilities to use the Squish.Cfg file.
  537.           The prefix is required in all cases, even when Squalid uses a
  538.           separate configuration file.
  539.  
  540.           Echomail rescans are achieved by means of a batch file and echo
  541.           toss log file created when necessary by Squalid. Rescans should be
  542.           performed immediately but may be delayed until a regular
  543.           maintenance time by your main batch file.
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.        SQUALID V0.36b Reference Manual                                 Page 9
  578.  
  579.  
  580.  
  581.  
  582.        ============================
  583.        Squalid Configuration Items:
  584.        ============================
  585.  
  586.        User <address> <password> [<keys>] [@<aka> ...] [#<user_name>]
  587.  
  588.           The User keyword specifies all legitimate users of Squalid. A node
  589.           that does not have a User defined cannot use Squalid. The password
  590.           is the first word that must be specified on the subject line of
  591.           messages requesting service from Squalid. The keys specify the
  592.           security locks that the given user can 'open'. See Info for more
  593.           information on specifying keys (which are specified identically to
  594.           locks). If keys are not specifed, and the Info keyword is not
  595.           used, an unsecure system can get by with just this keyword for
  596.           each user. Alternative addresses for the user can be given
  597.           anywhere after the password, preceded by the commercial at
  598.           character ('@'). The name of the user can also be specified,
  599.           preceded by a hash ('#'), and with spaces replaced with
  600.           underscores. If specified, it will be used to address messages
  601.           normally sent to 'SysOp'.
  602.  
  603.           App Squalid User 3:631/100 GRONK A-F @9:100/4 #Fred_Bloggs
  604.  
  605.           specifies that the password for 3:631/100 (and 9:100/4) is
  606.           'GRONK', that the user's name is 'Fred Bloggs', and that Fred has
  607.           security keys A through to F. It also specifes that requests
  608.           coming from 9:100/4 will be treated in the same manner as those
  609.           from 3:631/100 (see "EndGroup" for an explanation of how this
  610.           works).
  611.  
  612.           Any number of Users may be specified, up to the limit of available
  613.           memory.
  614.  
  615.        Group <group tag> [*]
  616.  
  617.           Begins the block that defines a group of zones that can be treated
  618.           as separate entities.  The optional asterix signifies a default
  619.           group to be used when the group cannot be determined by other
  620.           means.
  621.  
  622.               App Squalid Group FidoNet
  623.  
  624.        Zones <zone> [<zone> ... ]                       (GROUP SPECIFIC)
  625.  
  626.           The Zones keyword specifies the zones that are regarded as
  627.           belonging to the group currently being defined.
  628.  
  629.               App Squalid Zones 1 2 3 4 5 6
  630.  
  631.           would be a suitable statement for FidoNet. Multiple Zones
  632.           statements may appear for each group definition.
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.        SQUALID V0.36b Reference Manual                                Page 10
  642.  
  643.  
  644.  
  645.  
  646.        AutoFlags <flags>                                (GROUP SPECIFIC)
  647.  
  648.           Specifies the Squish flags (as per pp. 68-70, Squish V1.0
  649.           Reference Manual) to use when creating new areas. Multiple flags
  650.           should be separated by underscores. See also command line modifier
  651.           -f, which overrides this keyword. For example, to create areas
  652.           which are stored in squish format, and add 631/199 to the seen-
  653.           by's, use
  654.  
  655.               App Squalid AutoFlags -$_-+631/199
  656.  
  657.        AutoLocks <locks>                                (GROUP SPECIFIC)
  658.  
  659.           The AutoLocks keyword specifies the locks to apply to new areas
  660.           created by Squalid. If this keyword is not specified, any new
  661.           areas created will not be secured. Overridden by the command line
  662.           modifier -l, if present. To give locks A,B,C,D,S,X,1,2,3 and 6 to
  663.           new areas, for example
  664.  
  665.               App Squalid AutoLocks A-DSX1-36
  666.  
  667.           See also Info for a detailed explanation of area locks and user
  668.           keys.
  669.  
  670.        Elist <filespec>                                 (GROUP SPECIFIC)
  671.  
  672.           The Elist keyword specifies the name of an echo list file to be
  673.           sent in response to the -L subjectline switch, and with NOTIFY
  674.           messages (if IncludeList is set to "On").
  675.  
  676.               App Squalid Elist F:\echolist\another.txt
  677.  
  678.        Uplink <address> <req_pswd> <filespec>           (GROUP SPECIFIC)
  679.  
  680.           The Uplink keyword specifies an uplink for a particular zone.
  681.           Multiple uplinks may be specified. <req_pswd> is the password to
  682.           be used in forwarded area requests. <filespec> is the file to
  683.           search for echo tags to request. If an echo tag is not found in
  684.           any of the files specified for all uplinks, the response "area not
  685.           found" is returned to the requester.
  686.  
  687.               App Squalid Uplink 3:631/530 freddie f:\echolist\another.txt
  688.  
  689.           tells Squalid to search "F:\EchoList\Another.Txt" for currently
  690.           unknown echoes, and if found, to send a request to 3:631/530, with
  691.           password "freddie".
  692.  
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.        SQUALID V0.36b Reference Manual                                Page 11
  706.  
  707.  
  708.  
  709.  
  710.        EndGroup
  711.  
  712.           EndGroup is an optional termination of a group definition. Group
  713.           definition terminates when either an EndGroup or a Group is
  714.           encountered. However, this seems an appropriate place to put a
  715.           complete group definition example!
  716.  
  717.               App Squalid Group fidonet
  718.               App Squalid   Zones 1 2 3 4 5 6
  719.               App Squalid   AutoFlags -0
  720.               App Squalid   AutoLocks S
  721.               App Squalid   Elist F:\EList\FidoNet.Na
  722.               App Squalid   Uplink 3:631/100 bosspass F:\EList\FidoHost.Eco
  723.  
  724.               App Squalid Group rainbownet
  725.               App Squalid   Zones 199
  726.               App Squalid   AutoFlags -$_-p199:4242/8
  727.               App Squalid   AutoLocks S
  728.               App Squalid   Elist F:\EchoList\RainEcho.Lst
  729.               App Squalid   Uplink 199:4242/1 not_telling F:\EList\REcho.Lst
  730.               App Squalid EndGroup
  731.  
  732.           defines two groups, known (to Squalid only) as "fidonet" and
  733.           "rainbownet". Squalid will attempt to match the zone of any
  734.           address or AKA of a user to one of the zones specified in a Group
  735.           block. If this matching fails, the user has no access to any
  736.           facilities. If the matching succeeds, however, only those echoes
  737.           appropriate to the group of the user will be made available.
  738.           Requests may be made under any AKA for areas from another group,
  739.           and the appropriate address will be added to the scan list. For
  740.           instance, if the user with AKAs in both zone 199 and zone 3
  741.           requests an echo that is 'in' group rainbownet using per zone 3
  742.           address, Squalid will add the zone 199 AKA to the scan list, not
  743.           the zone 3 address.
  744.  
  745.        Alias <alias>                                 (default "Squalid")
  746.  
  747.           The Alias keyword specifies a name for Squalid to respond to, in
  748.           addition to "Squalid".  For example,
  749.  
  750.               App Squalid Alias Areafix
  751.  
  752.           is suggested. Any number of aliases may be specified, up to the
  753.           limit of available memory.
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.        SQUALID V0.36b Reference Manual                                Page 12
  770.  
  771.  
  772.  
  773.  
  774.        CreatePath <path>
  775.  
  776.           The CreatePath keyword specifies the path to use when creating new
  777.           areas. A new subdirectory (*.MSG) or file (Squish) with the name
  778.           SQLDnnnn, where nnnn is a number from 0001 to 9999, is created in
  779.           the directory specified. The combination
  780.  
  781.               App Squalid CreatePath C:\Echo\Created
  782.  
  783.               App Squalid Group ...
  784.               App Squalid   AutoFlags -$
  785.               App Squalid   AutoLocks A-F2-5
  786.  
  787.           and the command
  788.  
  789.               SQUALID CREATE COMP.SOURCES.C.LANG 632/300
  790.  
  791.           will cause the lines
  792.  
  793.           EchoArea COMP.SOURCES.C.LANG C:\Echo\Created\SQLD0001 -$ 632/300
  794.           App Squalid Info COMP.SOURCES.C.LANG A-F2-5
  795.  
  796.           to be added to Squish.Cfg, and a set of Squish message files with
  797.           the base name "SQLD0001" to be created in the C:\Echo\Created
  798.           directory.
  799.  
  800.           A trailing backslash character is optional for <path>.
  801.  
  802.        Header <filespec>
  803.  
  804.           The Header keyword specifies the name of a file that contains text
  805.           to be included at the beginning of each response message created
  806.           by Squalid. The file should be SHORT and to the point.
  807.  
  808.        Trailer <filespec>
  809.  
  810.           The Trailer keyword specifies the name of a file that contains
  811.           text to be included at the end of each response message created by
  812.           Squalid. The file should be SHORT and to the point.
  813.  
  814.        HelpFile <filespec>
  815.  
  816.           The HelpFile keyword specifies the name of a file that contains
  817.           help information for end-users of Squalid. SDUSRMAN.DOC (or ARJ,
  818.           or ZIP) is suggested. If the keyword is present, the specified
  819.           file is sent in response to the -H subject line switch.
  820.  
  821.        HelpText <filespec>
  822.  
  823.           The HelpText keyword specifies the name of a file that contains
  824.           help information for end-users of Squalid. If the keyword is
  825.           present, the contents of the specified file are sent AS A MESSAGE
  826.           in response to the -H subject line switch or the  %HELP command.
  827.           This keyword overrides the HelpFile keyword. NOTE that the
  828.           combined length of Header, Trailer, HelpText and actual message
  829.           content cannot exceed 16K. Do try to keep it simple.
  830.  
  831.  
  832.  
  833.        SQUALID V0.36b Reference Manual                                Page 13
  834.  
  835.  
  836.  
  837.  
  838.        IncludeList [Off|On]                                (default Off)
  839.  
  840.           The IncludeList keyword specifies whether to respond to the -L
  841.           subjectline switch or the NOTIFY command line action by attaching
  842.           the file specified by Elist. If neither Off nor On is specified,
  843.           but the keyword is present, IncludeList is set to On.
  844.  
  845.               ;App Squalid IncludeList OFF       ;Lists will NOT be sent
  846.               App Squalid IncludeList Off        ;Lists will NOT be sent
  847.               App Squalid IncludeList                ;Lists WILL be sent
  848.               App Squalid IncludeList On             ;Lists WILL be sent
  849.  
  850.        BlockInfo {<locks> | @<group>}
  851.  
  852.           The BlockInfo keyword specifies locks and/or a group for all
  853.           EchoArea definitions following up to the next BlockInfo, or to a
  854.           BlockEnd, or to the end of the configuration file. It can be
  855.           overridden by the Info line for any echo areas within a block if
  856.           necessary.
  857.  
  858.               App Squalid BlockInfo 2-4A-F
  859.                  EchoArea CHIAPPI ....
  860.                  EchoArea BERLIOZ ....
  861.                  EchoArea DELIBES ....
  862.                  EchoArea LISZT ....
  863.               App Squalid BlockEnd
  864.           [...]
  865.               App Squalid Info DELIBES G-K1-6
  866.  
  867.           will give locks 2,3,4 and A through to F to area CHIAPPI, BERLIOZ
  868.           and LISZT, and locks G-K and 1-6 to DELIBES. Note that such an
  869.           override (DELIBES) would not be a normal usage of the BlockInfo
  870.           keyword.
  871.  
  872.           See the Info keyword for details on locks and keys.
  873.  
  874.        BlockEnd
  875.  
  876.           See above.
  877.  
  878.        Info <echotag> [<locks>] [@<group>]
  879.  
  880.           The Info keyword is used for each echo area for which security is
  881.           desired, or for which a group that cannot be determined
  882.           automatically by the zone of the first listed node.
  883.  
  884.           This keyword overrides BlockInfo, for the specified echo only.
  885.  
  886.           Valid locks are A through to Z, and 1 to 6. A range of locks may
  887.           be specified by using the (-) symbol between the starting and
  888.           ending locks to be used (use "A-E" to specify keys A,B,C,D and E,
  889.           for example). When an area has locks specified, only users with
  890.           keys for ALL such locks can add or rescan that area. For example,
  891.           the key S could be used to indicate sysop, so that points can be
  892.           prevented from obtaining those echoes.
  893.  
  894.  
  895.  
  896.  
  897.        SQUALID V0.36b Reference Manual                                Page 14
  898.  
  899.  
  900.  
  901.  
  902.           Groups only need to be specified to override Squalid's automatic
  903.           group detection, for instance when the first listed node for an
  904.           echo does not have a zone that is defined in the appropriate Zone
  905.           statement for the desired group.
  906.  
  907.           Examples...
  908.  
  909.               App Squalid Info ZONE3_SYSOP S
  910.  
  911.           gives lock 'S' to the echo area ZONE3_SYSOP, and
  912.  
  913.               App Squalid Info STRANGEWAYS @fidonet
  914.  
  915.           informs Squalid that the STRANGEWAYS echo belongs in the fidonet
  916.           group, no matter what the zone of the first listed node is.
  917.  
  918.           Any number of Info keywords may be specified, up to the limit of
  919.           available memory.
  920.  
  921.           Refer also to the Query, RescanLock, Forward and User keywords.
  922.  
  923.        LogFile <filespec>
  924.  
  925.           The LogFile keyword specifies the name of the log file for Squalid
  926.           to record its history. If no log file is specifed, no log
  927.           information will be written.
  928.  
  929.        LogLevel <level>                                      (default 1)
  930.  
  931.           This keyword specifies the amount of information which is written
  932.           to the logfile, according to the importance attached to the
  933.           message. This is similar to the BinkleyTerm technique, and
  934.           identical to that used in Squish V1.01. Hey Scott, why didn't you
  935.           keep it consistent with Binkley? Allowable LogLevels are
  936.  
  937.               0  !
  938.               1  !+
  939.               2  !+*
  940.               3  !+*-
  941.               4  !+*-#
  942.               5  !+*-#:
  943.               6  !+*-#:(space)
  944.  
  945.           Log messages will only appear in the log file if the character
  946.           which precedes them is shown next to the active loglevel in the
  947.           list above.
  948.  
  949.           Note that Squalid will use the Squish loglevel setting if it is
  950.           present, or will override it with its own if a specific Squalid
  951.           loglevel keyword is present.
  952.  
  953.               LogLevel 6
  954.               App Squalid LogLevel 0
  955.  
  956.  
  957.  
  958.  
  959.  
  960.  
  961.        SQUALID V0.36b Reference Manual                                Page 15
  962.  
  963.  
  964.  
  965.  
  966.           will cause Squalid to only log messages that are preceded by a
  967.           `!', whereas
  968.  
  969.               LogLevel 6
  970.  
  971.           will cause Squalid to log all messages.
  972.  
  973.        MaxLineLength <length>                             (default 2047)
  974.  
  975.           The MaxLineLength keyword specifies the maximum length of EchoArea
  976.           definition lines written by Squalid in Squish.Cfg. Squalid will
  977.           override the specified length if it is unable to write the FIRST
  978.           node on any line, and reset it to the default. No minimum value is
  979.           specified, but be reasonable...if you have long pathnames please
  980.           allow a little room for addresses too! The maximum value for this
  981.           keyword is the default of 2047.
  982.  
  983.        MsgFlag <flags>
  984.  
  985.           The MsgFlag keyword specifies message attributes for messages
  986.           created by Squalid. You can specify the attributes Kill/Sent,
  987.           Crash, Hold and Private only. Each attribute must appear as a
  988.           single word on the MsgFlag line, separated by spaces. Only the
  989.           initial letter of each word is used, however, so you could use
  990.  
  991.               App Squalid MsgFlag K C
  992.  
  993.           to specify Kill/Sent and Crash, or you could write
  994.  
  995.               App Squalid MsgFlag Kill/Sent Crash
  996.  
  997.           if you wanted to make it a bit more obvious.
  998.  
  999.        FileFlag <flags>
  1000.  
  1001.           This is the same as the MsgFlag keyword, except Squalid uses it
  1002.           when creating file attach messages.
  1003.  
  1004.               App Squalid FileFlag Pri Hld
  1005.  
  1006.           would cause file attaches to have the Private and Hold attributes.
  1007.  
  1008.        MsgSize <size_in_kB>[K]                        (default 4194304K)
  1009.  
  1010.           The MsgSize keyword specifies the maximum length of a message
  1011.           created by Squalid. Messages which will exceed this length will be
  1012.           split, with a 'Continued...' at the end of each part except the
  1013.           last, and a '...from previous message.' at the beginning of each
  1014.           except the first. On rare occasions a message will erroneously
  1015.           have a 'Continued...' without a following message. The maximum
  1016.           value for this keyword is the default of 4194304 (you might cop a
  1017.           blast if you send a message this size!). The 'K' following the
  1018.           number is optional.
  1019.  
  1020.               App Squalid MsgSize 16K
  1021.  
  1022.  
  1023.  
  1024.  
  1025.        SQUALID V0.36b Reference Manual                                Page 16
  1026.  
  1027.  
  1028.  
  1029.  
  1030.           Sets the maximum size of messages created by Squalid to 16384
  1031.           bytes.
  1032.  
  1033.        NodeFormat Short|Brief|Long                       (default Short)
  1034.  
  1035.           The NodeFormat keyword specifies the format of addresses written
  1036.           by Squalid. 'Short' specifies the absolute minimum that Squish can
  1037.           understand. 'Brief' prints zone:node/net for the first address,
  1038.           minimal information for the rest. 'Long' prints zone:node/net for
  1039.           all addresses.
  1040.  
  1041.        Sort [On|Off]                                        (default On)
  1042.  
  1043.           The Sort keyword (if present) specifies whether to sort nodes into
  1044.           ascending order of zone, net, node, point (with the exception of
  1045.           the first listed node, which is never repositioned unless
  1046.           deleted). If the keyword is not present, the scan list is sorted.
  1047.  
  1048.        IncludePoints                                  (default DISABLED)
  1049.  
  1050.           If the IncludePoints keyword is encountered, points of the 'home'
  1051.           address are included in the order in which they are encountered
  1052.           (or in normal sort order) when a scan list is written. The
  1053.           alternative situation is that points of the home node have a
  1054.           separate line in SQUISH.CFG. The operation of Sort and
  1055.           IncludePoints is demonstrated in the following example:
  1056.  
  1057.           If we begin with an area 'GLUCK', specified:
  1058.  
  1059.               EchoArea GLUCK C:\Echoes\Gluck -$ 631/100 1:639/240
  1060.               EchoArea GLUCK C:\Echoes\Gluck -$ .2 .5 .7 .3 631/120
  1061.  
  1062.           and a command 'SQUALID ADD .1 GLUCK', (all assuming that line
  1063.           length is limited by MaxLineLength)
  1064.  
  1065.  
  1066.  
  1067.  
  1068.  
  1069.  
  1070.  
  1071.  
  1072.  
  1073.  
  1074.  
  1075.  
  1076.  
  1077.  
  1078.  
  1079.  
  1080.  
  1081.  
  1082.  
  1083.  
  1084.  
  1085.  
  1086.  
  1087.  
  1088.  
  1089.        SQUALID V0.36b Reference Manual                                Page 17
  1090.  
  1091.  
  1092.  
  1093.  
  1094.           1)  App Squalid Sort Off
  1095.               App Squalid IncludePoints
  1096.  
  1097.           results in:
  1098.  
  1099.               EchoArea GLUCK C:\Echoes\Gluck -$ 631/100 1:639/240
  1100.               EchoArea GLUCK C:\Echoes\Gluck -$ .2 .5 .7 .3 631/120
  1101.               EchoArea GLUCK C:\Echoes\Gluck -$ .1
  1102.  
  1103.           2)  App Squalid Sort Off
  1104.               ;App Squalid IncludePoints
  1105.  
  1106.           results in:
  1107.  
  1108.               EchoArea GLUCK C:\Echoes\Gluck -$ 631/100 1:639/240
  1109.               EchoArea GLUCK C:\Echoes\Gluck -$ 631/120
  1110.               EchoArea GLUCK C:\Echoes\Gluck -$ .2 .5 .7 .3 .1
  1111.  
  1112.           3)  App Squalid Sort On
  1113.               App Squalid IncludePoints
  1114.  
  1115.           results in:
  1116.  
  1117.               EchoArea GLUCK C:\Echoes\Gluck -$ 631/100 120 632/376.1
  1118.               EchoArea GLUCK C:\Echoes\Gluck -$ .2 .3 .5 .7 1:639/240
  1119.  
  1120.           4)  App Squalid Sort On
  1121.               ;App Squalid IncludePoints <== commented out
  1122.  
  1123.           results in:
  1124.  
  1125.               EchoArea GLUCK C:\Echoes\Gluck -$ 631/100 120 1:639/240
  1126.               EchoArea GLUCK C:\Echoes\Gluck -$ .1 .2 .3 .5 .7
  1127.  
  1128.        Sysop <sysop name>                              (default "SysOp")
  1129.  
  1130.           The Sysop keyword specifies the name to be used when 'signing'
  1131.           various response messages.
  1132.  
  1133.           App Squalid Sysop Johann Pachelbel
  1134.  
  1135.           will cause certain messages to be "signed" by Johann Pachelbel.
  1136.           (see the separate document "How to Use Squalid" contained in
  1137.           SDUSRMAN.DOC for examples of the messages concerned.)
  1138.  
  1139.        Query <locks>
  1140.  
  1141.           The Query keyword specifies the security level required to use the
  1142.           -Q subject line switch. For example
  1143.  
  1144.               App Squalid Query Q
  1145.  
  1146.           means that a user must have key Q for Squalid to provide a query
  1147.           report.
  1148.  
  1149.  
  1150.  
  1151.  
  1152.  
  1153.        SQUALID V0.36b Reference Manual                                Page 18
  1154.  
  1155.  
  1156.  
  1157.  
  1158.        Forward <locks>
  1159.  
  1160.           The Forward keyword specifies the security level required by a
  1161.           user before Squalid will generate forward requests for that node.
  1162.           For example
  1163.  
  1164.               App Squalid Forward F
  1165.  
  1166.           means that a user must have key F for Squalid to forward requests
  1167.           that cannot be satisfied locally. If a user does not have the
  1168.           requisite keys, no attempt is made to search for unknown areas.
  1169.  
  1170.        NotifyInclude <locks>
  1171.  
  1172.           This keyword specifies the keys required by a client for that
  1173.           client to be included in a 'NOTIFY *' command. This would normally
  1174.           be used to explicitly exclude a node from NOTIFY commands. Note
  1175.           that without these keys, a client can NEVER be notified.
  1176.  
  1177.               App Squalid NotifyInclude N
  1178.  
  1179.           Means that clients without the N key will not be notified when the
  1180.           SQUALID NOTIFY command is given.
  1181.  
  1182.        RescanLock <locks>
  1183.  
  1184.           The RescanLock keyword specifies the security level required to
  1185.           rescan an echo area, either by the '^' prefix to an area, or by
  1186.           the %RESCAN command. For instance
  1187.  
  1188.               App Squalid RescanLock D-H4
  1189.  
  1190.           means that a user must have keys D, E, F, G, H and 4 to rescan any
  1191.           area.
  1192.  
  1193.        RescanCmd <command line>
  1194.  
  1195.           This specifies the command to place in SDRESCAN.BAT (or whatever
  1196.           is specified in RescanFile) to generate a rescan for an area. If
  1197.           RescanCmd is not specified, "SQUISH RESCAN" is the default. The
  1198.           RescanCmd will be written to the RescanFile with the areaname and
  1199.           address for each area to be rescanned. Examples:
  1200.  
  1201.               App Squalid RescanCmd SQ386 RESCAN
  1202.  
  1203.           or
  1204.  
  1205.               App Squalid RescanCmd SQUISHP RESCAN
  1206.  
  1207.           for OS/2.
  1208.  
  1209.  
  1210.  
  1211.  
  1212.  
  1213.  
  1214.  
  1215.  
  1216.  
  1217.        SQUALID V0.36b Reference Manual                                Page 19
  1218.  
  1219.  
  1220.  
  1221.  
  1222.        RescanFile
  1223.  
  1224.           Specifies the name of the file to write RescanCmd to...
  1225.  
  1226.               App Squalid RescanFile D:\BATCH\SDRESCAN.BAT
  1227.  
  1228.           for DOS, or
  1229.  
  1230.               App Squalid RescanFile SDRESCAN.CMD
  1231.  
  1232.           for OS/2.
  1233.  
  1234.        SaveRequests [Off|On]                               (default Off)
  1235.  
  1236.           The SaveRequests keyword tells Squalid whether to save request
  1237.           messages after processing. The default if SaveRequests is not
  1238.           specified is to erase successfully processed requests. If
  1239.           specified without "Off" or "On", defaults to On.
  1240.  
  1241.        SaveSent [Off|On]                                   (default Off)
  1242.  
  1243.           Superceded by MsgFlag and FileFlag keywords.
  1244.  
  1245.        KillPass [Off|On]                                    (default On)
  1246.  
  1247.           The KillPass keyword tells Squalid to remove a passthrough area
  1248.           when the last downlink unlinks from it, and to send an unlink
  1249.           message to the uplink.
  1250.  
  1251.  
  1252.  
  1253.  
  1254.  
  1255.  
  1256.  
  1257.  
  1258.  
  1259.  
  1260.  
  1261.  
  1262.  
  1263.  
  1264.  
  1265.  
  1266.  
  1267.  
  1268.  
  1269.  
  1270.  
  1271.  
  1272.  
  1273.  
  1274.  
  1275.  
  1276.  
  1277.  
  1278.  
  1279.  
  1280.  
  1281.        SQUALID V0.36b Reference Manual                                Page 20