home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / jf101p.zip / JFREQ.DOC < prev    next >
Text File  |  1995-02-03  |  34KB  |  839 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                    - - - - -
  8.                                    J F R e q
  9.                                    - - - - -
  10.  
  11.  
  12.            External File Request Processor for FrontDoor, MainDoor,
  13.        Intermail or compatible mailers & Remote Access, Maximus, or any
  14.                    BBS system based on a FILES.BBS structure
  15.  
  16.  
  17.                     (C) 1994 Jordi Sese (Fidonet 2:343/116)
  18.  
  19.  
  20.                                  version 1.01
  21.  
  22.  
  23.  
  24.  
  25.                                    IMPORTANT
  26.      This program IS NOT, public domain. It is a Shareware Product. Please
  27.       read the document REGISTER.TXT to know about its conditions of use
  28.  
  29.  
  30.  
  31.  
  32.  
  33.                                Table of Contents
  34.  
  35.  
  36.  
  37.   1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  38.     1.1 What is a File Request Processor? . . . . . . . . . . . . . . . . . 1
  39.     1.2 Features of JFReq 1.01  . . . . . . . . . . . . . . . . . . . . . . 1
  40.     1.3 Files in the distribution package . . . . . . . . . . . . . . . . . 2
  41.  
  42.   2. Setup  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  43.     2.1 UPGRADING from version 1.00 . . . . . . . . . . . . . . . . . . . . 3
  44.     2.2 General Installation Notes  . . . . . . . . . . . . . . . . . . . . 3
  45.     2.3 Multiline systems . . . . . . . . . . . . . . . . . . . . . . . . . 3
  46.     2.4 Environment Variables . . . . . . . . . . . . . . . . . . . . . . . 4
  47.     2.5 Mailer Setup  . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
  48.       2.5.1 MainDoor & MainDoor/2:  . . . . . . . . . . . . . . . . . . . . 4
  49.       2.5.2 FrontDoor 2.1x & 2.2x . . . . . . . . . . . . . . . . . . . . . 5
  50.       2.5.3 Intermail 2.27: . . . . . . . . . . . . . . . . . . . . . . . . 5
  51.     2.6 The Setup Program (JFREQCFG.COM / JFRQCFGP.EXE) . . . . . . . . . . 5
  52.       2.6.1 Global Options  . . . . . . . . . . . . . . . . . . . . . . . . 5
  53.       2.6.2 Time Settings:  . . . . . . . . . . . . . . . . . . . . . . . . 6
  54.       2.6.3 Limits  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
  55.       2.6.4 Mail Addresses  . . . . . . . . . . . . . . . . . . . . . . . . 7
  56.       2.6.5 Template Editor . . . . . . . . . . . . . . . . . . . . . . . . 7
  57.  
  58.   3. Other data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
  59.     3.1 JFReq Command Line Parameters . . . . . . . . . . . . . . . . . . . 8
  60.     3.2 Tokens used in templates  . . . . . . . . . . . . . . . . . . . . . 8
  61.     3.3 File Format for File & Firectory listings and Alias file  . . . .  10
  62.       3.3.1 file & directory listing: . . . . . . . . . . . . . . . . . .  10
  63.       3.3.2 ALIAS listing:  . . . . . . . . . . . . . . . . . . . . . . .  10
  64.     3.4 The nodelist compiler . . . . . . . . . . . . . . . . . . . . . .  10
  65.     3.5 The custom file index compiler  . . . . . . . . . . . . . . . . .  11
  66.     3.6 Remote Access file index Speed-up . . . . . . . . . . . . . . . .  11
  67.     3.7 VIP Systems . . . . . . . . . . . . . . . . . . . . . . . . . . .  11
  68.     3.8 Statistical Reports . . . . . . . . . . . . . . . . . . . . . . .  12
  69.     3.9 Special Requests with Attached Messages . . . . . . . . . . . . .  12
  70.     3.10 Editor Commands  . . . . . . . . . . . . . . . . . . . . . . . .  13
  71.     3.11 Credits  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  13
  72.     3.12 How to contact the author  . . . . . . . . . . . . . . . . . . .  13
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.                                        i
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.                                    Chapter 1
  94.  
  95.                                  Introduction
  96.  
  97.  
  98.  
  99.  
  100.  
  101.   1.1 What is a File Request Processor?
  102.  
  103.   Once  upon a time, fidonet mailers searched a huge list of directories each
  104.   time another system requested a file, wasting a lot of time  in  sequential
  105.   searches.   Now,  from  FrontDoor  2.1x,  Intermail  2.27  and MainDoor and
  106.   MainDoor/2, you can execute  an  external  utility  to  fast  locate  those
  107.   requested  files  and  generate  a  personalised  response  message for the
  108.   asking system.
  109.  
  110.   JFReq uses the existing file indexes of the BBS package (Maximus  &  Remote
  111.   Access  are  currently supported).  This use of the automated index of your
  112.   BBS makes it possible to run this program with  almost  no  maintenance  at
  113.   all.
  114.  
  115.  
  116.   1.2 Features of JFReq 1.01
  117.  
  118.   * Native versions for DOS and OS/2
  119.   * Multiline support
  120.   * Easy to use configuration program
  121.   * Mailers supported:   FrontDoor (2.1x or better), MainDoor, InterMail
  122.     (2.27 or better) or compatible mailers
  123.   * BBS File Bases supported:    Maximus (2.x) and Remote Access (2.x)
  124.     (supported directly), and any system based on the FILES.BBS structure.
  125.   * Directory listing and Alias file (with or without password)
  126.   * You can limit by day and/or session: Files, Kbytes to transmit, and
  127.     session lenght in minutes.
  128.   * Four types of session: Secure(with password), Listed & Unlisted
  129.     Systems, and a Happy Hour period, defining file lists and limits for
  130.     each type of session separately.
  131.   * You can search for the existence of a specific node in a custom
  132.     nodelist index.
  133.   * Use of an equivalent user level for BBS File Base access
  134.   * Twit systems control definition, checking every piece of information
  135.     from the remote system
  136.   * Request Report and error messages are totally customizable, and
  137.     templates are selected automatically depending on the remote system's
  138.     address
  139.   * Additional messages are added when the remote system requests a
  140.     special file
  141.   * File Password & Download Counter Support in Remote Access
  142.   * Automatic Download Counter Support for Maximus and FILES.BBS index
  143.  
  144.  
  145.                                        1
  146.  
  147.   Chapter 1. Introduction                                                   2
  148.  
  149.  
  150.   * File Buffering for CD-ROMs and other critical drives
  151.   * Statistical reports as messages.
  152.   * VIP Systems support
  153.  
  154.  
  155.   1.3 Files in the distribution package
  156.  
  157.   100TO101.COM    Update to update the configuration file to version 1.01
  158.   JFREQ.DOC       JFReq users' manual. English version
  159.   JFREQ.ESP       JFReq users' manual. Spanish version
  160.   JFREQP.EXE      JFReq main executable. OS/2 version
  161.   JFRQCFGP.EXE    JFReq configuration utility. OS/2
  162.   JFREQ.COM       JFReq main executable. DOS version
  163.   JFREQCFG.COM    JFReq configuration utility. DOS
  164.   JFNCP.EXE       Nodelist compiler. OS/2 version
  165.   JFNC.COM        Nodelist compiler. DOS version
  166.   JFNC.CTL        Nodelist control file for JFNC
  167.   JFFCP.EXE       Secondary file index generator. OS/2
  168.   JFFC.COM        Secondary file index generator. DOS
  169.   JFFC.CTL        Secondary file index control file
  170.   JFSTATP.EXE     Statistical Reports generator. OS/2
  171.   JFSTAT.COM      Statistical Reports generator. DOS
  172.   LDATP.EXE       JFREQ.DAT lister (OS/2)
  173.   LDAT.COM        JFREQ.DAT lister (DOS)
  174.   DEFAULT.FRQ     Default response template
  175.   *.FRQ           Sample response templates
  176.   FNAMES.DAT      Special requests control file
  177.   REGISTER.TXT    Registration info, English version
  178.   REGISTRO.TXT    Registration info, Spanish version
  179.   UADDRESS.DAT    Twit systems (by address) control file
  180.   UMAILERS.DAT    Twit systems (by string) control file
  181.   JFREQ.CFG       Configuration file
  182.   NFRQSTAT.*      Statistics file (nodes)
  183.   FFRQSTAT.*      Statistics file (files)
  184.   JFREQ.DAT       Data file (node information)
  185.   JFNC.NDX        Nodelist index
  186.   JFFILES.IDX     Custom File Index
  187.   JFAREA.DAT      Custom Area Index
  188.   JFREQ.VIP       VIP Systems specifications file
  189.   RAFILES.IDX     RA speed-up index for JFREQ
  190.   JFRAFC.COM      RA File Area Compiler for JFREQ (DOS)
  191.   JFRAFCP.EXE     RA File Area Compiler for JFREQ (OS/2)
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.                                    Chapter 2
  199.  
  200.                                      Setup
  201.  
  202.  
  203.  
  204.  
  205.  
  206.   2.1 UPGRADING from version 1.00
  207.  
  208.   a)  Unpack  your  1.01 archive in the JFREQ directory, being careful not to
  209.   overwrite your 1.00 configuration files.
  210.  
  211.   b) Run the utility called 100to101.com to update the file JFREQ.CFG to  the
  212.   1.01 version.
  213.  
  214.   c) Run the configuration utility to check everything is fine.
  215.  
  216.   d)  If  you are using the DOS version, delete the file JFREQ.COM.  The 1.01
  217.   version main executable comes in EXE format.
  218.  
  219.  
  220.   2.2 General Installation Notes
  221.  
  222.   JFReq runs on a 286 or better processor.  SHARE  or  equivalent  should  be
  223.   installed  if  under  DOS.  Set an entry in your PATH pointing to the JFReq
  224.   main directory.
  225.  
  226.   Use the directory listings just for those files and / or directories  which
  227.   are  NOT  in  your  BBS  index.   This search is quite slow compared to the
  228.   indexes, so use it only when necessary.
  229.  
  230.   The custom index is intended for aditional file Doors or systems running  a
  231.   BBS  software  other  than  RA  or  Max.   For those later systems to work.
  232.   leave blank the 'BBS Path' field and select Remote  Acces  as  'BBS  Type'.
  233.   In case you use RA or Max, this custom index is also checked if active.
  234.  
  235.   In  a  single  request session, JFReq can search an ALIAS file, a directory
  236.   listing, a BBS index and a custom index.  Please try to make the search  as
  237.   fast as possible, avoiding searching the same files more than once.
  238.  
  239.  
  240.   2.3 Multiline systems
  241.  
  242.   Nothing   has  to  be  done  in  a  multiline  system,  except  having  the
  243.   environment variables set correctly.  JFReq  keeps  a  LOG  file  for  each
  244.   session  (called  JFREQ@.LOG,  being  @  the  value  of the TASK variable),
  245.   opening it with exclusive access  to  prevent  configuration  errors.   All
  246.   other files are opened in shared mode.
  247.  
  248.  
  249.  
  250.                                        3
  251.  
  252.   Chapter 2. Setup                                                          4
  253.  
  254.  
  255.   2.4 Environment Variables
  256.  
  257.   TASK     Current task number. Needed for the support & temporary
  258.            files when you run a multiline system
  259.  
  260.   JFREQ    Points to the main JFReq directory. Needed when you
  261.            execute the program from a different directory.
  262.  
  263.   examples:
  264.   SET TASK=1
  265.   SET JFREQ=C:\JFREQ
  266.  
  267.   If you use MainDoor, make sure your MD environment variable is set.
  268.  
  269.  
  270.   2.5 Mailer Setup
  271.  
  272.   IMPORTANT:  Do  not  use very large paths in your Mailer configuration, for
  273.   Inbound & PKT directories, since the limitation of 128  characters  in  the
  274.   command  line  (due  to  the operating system limitations) might cause some
  275.   trouble in the execution.
  276.  
  277.   IMPORTANT: Please write the parameters  in  the  command  line  exactly  as
  278.   shown  here,  except for the executable name (JFREQ for DOS, JFREQP.EXE for
  279.   OS/2), and its execution path (if needed).
  280.  
  281.   2.5.1 MainDoor & MainDoor/2:
  282.  
  283.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│ File Request         │░░░░░░░░░░░░░░░
  284.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│ Swap┌─── File Request ────┐░░░░░░░░░░
  285.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│ Envi│ Ficheros            │░░░░░░░░░░
  286.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░└─────│ Limits              │░░░░░░░░░░
  287.   ░░░░░░░░░░░░░░░░░░ Copyright (c) 19│ Processor           │ppa. ░░░░░
  288.   ┌──────────────────────────────── File Req - FRQP ──────────────────
  289.   │ Program  jfreq /MD =F =R =T =X =B =H =D =W
  290.   │ Active   Yes
  291.   │ Swapping Yes
  292.   └───────────────────────────────────────────────────────────────────
  293.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  294.   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  295.  
  296.   Note: in some versions of MainDoor (0.9x), the =D and =W switches  are  not
  297.   yet  supported.   In  that  case use INBOUND instead of =D The =W parameter
  298.   won't affect the request, since this is an optional parameter.
  299.  
  300.   Chapter 2. Setup                                                          5
  301.  
  302.  
  303.   2.5.2 FrontDoor 2.1x & 2.2x
  304.  
  305.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ ╔═══════════════════╗▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  306.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ ║                   ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  307.   ▒╔═══════════════════════════════════════════════ Request processor
  308.   ▒║
  309.   ▒║ Program  jfreq /FD =F =R =T =X =B =H =D =W░░░░░░░░░░░░░░░░░░░░░░░
  310.   ▒║ Enabled  Yes
  311.   ▒║ Swapping Yes
  312.   ▒║
  313.   ▒╚══════════════════════════════════════════════════════════════════
  314.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ Swapping         ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  315.   ▒▒▒▒▒▒▒▒ Copyright ║ Protection       ║mrighausen; All rights reserv
  316.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ Fax              ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  317.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒╚══════════════════╝▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  318.   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  319.  
  320.   2.5.3 Intermail 2.27:
  321.  
  322.   ╔════════════════════════════════════════════════════ File requests
  323.   ║
  324.   ║ Mode      Anyone can request
  325.   ║ List      C:\IM\SYSTEM\OKREQDIR.LST
  326.   ║ Alias
  327.   ║ Message
  328.   ║ Max match 0
  329.   ║ Max time  0
  330.   ║ Max size  0
  331.   ║ Min speed 300
  332.   ║ Limited   No
  333.   ║ Start     00:00
  334.   ║ End       00:00
  335.   ║ Days      -------A
  336.   ║ External  JFREQ /IM %A %F %X %B %M %D %O░░░░░░░░░░░░░░░░░░░░░░░░░░
  337.   ║
  338.   ╚═══════════════════════════════════════════════════════════════════
  339.  
  340.  
  341.   2.6 The Setup Program (JFREQCFG.COM / JFRQCFGP.EXE)
  342.  
  343.   The Setup Program is very easy to use and each option is explained  at  the
  344.   bottom  of  the  screen  when you are on it.  The options marked with a <+>
  345.   sign are available only to registered users.  If you  are  an  unregistered
  346.   user,  please  read  the  file  REGISTER.TXT  to  know  how  to obtain your
  347.   registration key.
  348.  
  349.   2.6.1 Global Options
  350.  
  351.   Allows you to change the values for the common options to all sessions:
  352.  
  353.               BBS Type - currently Maximus and Remote access supported
  354.               BBS Path - main BBS directory
  355.       Use Custom Index - whether to use a secondary index created by
  356.                          compiling FILES.BBS files. Use this option to
  357.                          add support for CD-ROM doors not included in the
  358.  
  359.   Chapter 2. Setup                                                          6
  360.  
  361.  
  362.                          BBS index, or to use JFReq with another BBS
  363.                          package (in this case, use the Remote Access
  364.                          BBS type and leave blank the BBS Path field).
  365.      Download Counters - Type of download counter support. If you use
  366.                          Remote Access, set to any of the types. If you
  367.                          are using the custom index, choose the one you
  368.                          use in your FILES.BBS files. The download counter
  369.                          MUST exist for JFReq to update it.
  370.         Min. Baud Rate - minimum baud speed allowed
  371.          PKT Directory - directory for temporary and outbound packets
  372.                          (normally the outbound directory or a RAM disc)
  373.          LOG Directory - directory for LOG files
  374.       Special Requests - edit the file that holds the filenames to attach
  375.                          additional messages. The format is just <NAME>
  376.                          <full path msg file>. Messages can contain any of
  377.                          the available tokens. If you wish to send an
  378.                          additional message allways, use a point (.) as
  379.                          filename.
  380.        Nodelist Lookup - enables / disables nodelist lookup in the custom
  381.                          nodelist index
  382.        Nodelist Files  - edits the list of nodelists to process when
  383.                          executing JFNC/JFNCP, the nodelist compiler
  384.    Allow Outbound Req. - if you allow file requests from systems you are
  385.                          calling
  386.        Buffered Drives - files from those discs will be copied to a TEMP
  387.                          directory and deleted automatically after the
  388.                          session
  389.         Buffering Path - temporary directory used to hold buffered files
  390.        Keep Statistics - keep track of the data for later statistical
  391.                          reports
  392.       Expand Wildcards - whether to send more than one file per request,
  393.                          when it contains a wildcard character
  394.  
  395.   2.6.2 Time Settings:
  396.  
  397.  
  398.             Start Time - global startup time for file requests
  399.               End Time - global ending time for file requests
  400.         Happy H. Start - startup time of the Happy Hour period
  401.           Happy H. End - ending time of the Happy Hour period
  402.  
  403.   2.6.3 Limits
  404.  
  405.   Used to fix the limitations for each set of sessions:
  406.  
  407.  
  408.      Listed / Unsecure - sessions with listed systems without password
  409.               Unlisted - sessions with unlisted systems and without a
  410.                          session password
  411.             Passworded - password protected sessions. it does not mind
  412.                          whether the system is listed or not
  413.             Happy Hour - unsecure sessions (systems without a session
  414.                          password) within the Happy Hour period
  415.            VIP Systems - edit the specifications list for VIP Systems.
  416.                          Consult the section VIP Systems to know about the
  417.  
  418.   Chapter 2. Setup                                                          7
  419.  
  420.  
  421.                          file format.
  422.       Unwanted Systems - two files containing strings to match with the
  423.                          remote system's information. all systems with
  424.                          matching strings will be considered twit systems
  425.                          and they will be sent the BadTemplate portion of
  426.                          the corresponding template
  427.  
  428.   The options for each of these are the following:
  429.  
  430.        Alias List File - edits a file containing alias file names and
  431.                          their equivalences. its format is discussed later
  432.                          in this document
  433.         Directory List - edits a file containing a list of files and
  434.                          directories (with or without a password), to
  435.                          protect special directories or files that are not
  436.                          in the BBS filebase. its format is discussed
  437.                          later in this document
  438.   Level for BBS Access - BBS user level equivalent to the session type,
  439.                          used to check the access to BBS file areas
  440.           Maximum Time - maximum time allowed in a single session,
  441.                          calculed from the connection speed and the file
  442.                          sizes
  443.           Maximum Size - maximum accumulated file size allowed in a session
  444.          Maximum Files - maximum number of files to be transmitted in a
  445.                          single session
  446.       Max Time per Day - maximum time allowed per day
  447.       Max Size per Day - maximum size allowed per day
  448.      Max Files per Day - maximum number of files allowed per day
  449.  
  450.           NOTES:
  451.           a) to disable a limit, enter a '0' value
  452.           b) if you leave blank the alias or directory list file, you will
  453.              disable that file checking in those sessions
  454.  
  455.   2.6.4 Mail Addresses
  456.  
  457.   Definition of the local system main address  and  up  to  eleven  secondary
  458.   mail addresses(AKAs)
  459.  
  460.   2.6.5 Template Editor
  461.  
  462.   Allows  you to edit each of the templates from the setup program, selecting
  463.   first the file and then optionally editing:
  464.  
  465.         Error Messages - edits each of the possible error responses
  466.               Template - edits the message to send in all allowed sessions
  467.           Bad Template - edits the message to send in case the system is
  468.                          found to be a 'twit' one
  469.  
  470.   Please read the section 'editor commands' to know how to use  the  internal
  471.   editor
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.                                    Chapter 3
  479.  
  480.                                   Other data
  481.  
  482.  
  483.  
  484.  
  485.  
  486.   3.1 JFReq Command Line Parameters
  487.  
  488.   Here  is a description of the parameters passed in the command line.  These
  489.   parameters are  the  mailer's,  not  JFREQ's.   JFReq  reads  all  of  them
  490.   directly,  to  improve  speed.  Please enter the corresponding command line
  491.   exactly as stated for each operation mode
  492.  
  493.   Operation Mode Selection:
  494.     /MD     MainDoor Mode
  495.     /FD     FrontDoor Mode
  496.     /IM     InterMail Mode
  497.   FD/MD Mode
  498.     =F      Remote System information file
  499.     =R      File containing requested files
  500.     =T      File to create containing files to be sent
  501.     =X      SECURE/UNSECURE
  502.     =B      Session speed in BPS
  503.     =H      Minutes until next event not allowing FREQs
  504.     =D      INBOUND/OUTBOUND (call direction)
  505.     =W      LISTED/UNLISTED
  506.   Intermail mode:
  507.     %A      Remote system's mail address
  508.     %F      File containing requested files
  509.     %X      SECURE/UNSECURE/UNLISTED
  510.     %B      Session Speed in BPS
  511.     %M      Minutes until next event not allowing file requests
  512.     %D      INBOUND/OUTBOUND (call direction)
  513.     %O      Remote System's Sysop Name
  514.  
  515.  
  516.   3.2 Tokens used in templates
  517.  
  518.   By using response templates, you can  completely  customize  the  resulting
  519.   message.   Those  files  have  the  .FRQ extension, and they contain in its
  520.   main file name the clue to know what systems they will be sent to:
  521.  
  522.          2#343.FRQ    ->  will be sent to all systems in zone 2, net 343
  523.          2#34@.FRQ    ->  will be sent to all systems in zone 2, and a net
  524.                           number starting with 34 (341, 3421,...) that do
  525.                           not have another specific template.
  526.          2.FRQ        ->  will be sent to all systems in zone 2 that do
  527.                           not have another specific template
  528.  
  529.  
  530.                                        8
  531.  
  532.   Chapter 3. Other data                                                     9
  533.  
  534.  
  535.          DEFAULT.FRQ  ->  will be sent to all systems without a defined
  536.                           template
  537.                           This file MUST exist.
  538.  
  539.   To create a new template, just copy an existing template to the  file  name
  540.   corresponding to the set of addresses to be sent to.
  541.  
  542.   All  those  files  can  be edited with any ASCII editor, but it is safer to
  543.   use the internal editor, since you  can  edit  all  the  data  separatedly.
  544.   Please follow the comments inside the files.
  545.  
  546.           NOTES:
  547.           a) The automatic paragraph justification eliminates any extra
  548.              blanks, and sets a right margin of 75. All lines are left
  549.              justified.
  550.           b) Please do not forget to use the same Capitalization listed
  551.              here for any of the tokens
  552.  
  553.   Token                   Value/Action
  554.   ---------------------------------------------------------------------
  555.   @@BegJust       Indicates the beginning of a justified paragraph
  556.   @@EndJust       Indicates the end of a justified paragraph
  557.   @@FileDesc      Here the listing of files and descriptions will be inserted
  558.   @@FrqSyst       Remote system's name
  559.   @@FrqName       Full name of the remote system's sysop
  560.   @@FrqAddr       Mail Address of the remote system
  561.   @@FrqFrom       Remote system's 'From' field
  562.   @@FrqPhon       Remote system's telephone number
  563.   @@FrqSPWD       Session Password used (blank if none)
  564.   @@FrqSerN       Remote system's Mailer Serial Number
  565.   @@SesType       Current Session Type (secure/unsecure/unlisted/happy hour)
  566.   @@PrgName       Current program version
  567.   @@RegName       Local user's name inside the key file
  568.   @@AKMatch       Local mail address matching remote's
  569.   @@RegAKA<#>     Local mail addresses. substitute <#> for the AKA number
  570.   @@MinBaud       Minimum baud rate allowed
  571.   @@BegTime       Global startup time for allowing file requests
  572.   @@EndTime       Global ending time for allowing file requests
  573.   @@BegHapp       Happy Hour startup time
  574.   @@EndHapp       Happy Hour ending time
  575.   @@OkFiles       Number of located files in this session
  576.   @@TKbytes       Total Ks in located files in this session
  577.   @@CumCall       Accumulated request calls of the remote system
  578.   @@CumFile       Accumulated number of files requested by the remote system
  579.   @@CumSize       Accumulated number of KBytes requested by remote
  580.   @@CumTime       Accumulated minutes by remote
  581.   @@DayFile       Total files requested today by the remote system
  582.   @@DaySize       Ks. requested today by the remote system
  583.   @@DayTime       Minutes spent today by the remote system
  584.   @@MaxFile       Maximum files allowed in this session
  585.   @@MaxSize       Maximum size in Ks allowed in this session
  586.   @@MaxTime       Maximum time in minutes allowed in this session
  587.   @@Ma<#>File     Maximum number of files allowed in this type of session
  588.   @@Ma<#>Size     Maximum number of Ks allowed in this session type
  589.   @@Ma<#>Time     Maximum number of minutes allowed in this session type
  590.  
  591.   Chapter 3. Other data                                                    10
  592.  
  593.  
  594.   @@Da<#>File     Maximum files per day in this session type
  595.   @@Da<#>Size     Maximum Ks per day in this session type
  596.   @@Da<#>Time     Maximun minutes per day in this session type
  597.  
  598.   Please substitute <#> for:
  599.           L - listed unsecure sessions
  600.           U - unlisted unsecure sessions
  601.           H - happy hour sessions
  602.           P - password protected sessions
  603.           A - active session type
  604.  
  605.  
  606.   3.3 File Format for File & Firectory listings and Alias file
  607.  
  608.   These  files  may  be diferent for each type of session and must contain an
  609.   entry per line, with no blank lines and following this format:
  610.  
  611.   3.3.1 file & directory listing:
  612.  
  613.     to represent files:
  614.   <drive>:\<path>\<name>.<ext> [!<password>]
  615.     to represent directories:
  616.   <drive>:\<path> [!<password>]
  617.     example:
  618.   C:\FILES\SECRET.* !secure
  619.  
  620.   3.3.2 ALIAS listing:
  621.  
  622.   <alias> [!<passwd>] <drive>:\<path>\<name>.<ext> [<drive>:\<path>\...]
  623.     example:
  624.     THE_BETA !secure C:\FILES\SECRET.* C:\FILES\NOTES.ZIP
  625.  
  626.   (passwords in both files are optional)
  627.  
  628.  
  629.   3.4 The nodelist compiler
  630.  
  631.   The executable file JFNC.COM (JFNCP.EXE for OS/2) builds up an index  based
  632.   on  the  definitions  in  the  file  JFNC.CTL.   With  the  resulting  file
  633.   (JFNC.NDX), JFReq will know inmediately wether a system is  listed  in  any
  634.   of the nodelists.
  635.  
  636.   It  is recomended that you use this function (Nodelist Lookup) only if your
  637.   mailer does not provide this  information,  since  this  nodelist  checking
  638.   adds some time to the global process.
  639.  
  640.   Remember  to  use  the  nodelist  compiler each time you modify any of your
  641.   nodelists.
  642.  
  643.   The JFNC.CTL file is fully commented inside, so you  should  not  have  any
  644.   difficulty with that.
  645.  
  646.   Chapter 3. Other data                                                    11
  647.  
  648.  
  649.   3.5 The custom file index compiler
  650.  
  651.   In  order  to  use  the  secondary  index,  you  must  build  an ASCII file
  652.   (JFFC.CTL) using your favorite editor following this line format:
  653.  
  654.   [!<password>] [#<user level>] <down. path> <files.bbs path> <desc. column>
  655.  
  656.   [!<password>] (optional) password for all files in this area
  657.  
  658.   [#<user level>] (optional) equivalent user level  for  this  file  area  in
  659.   numerical format.  if you are using the Maximus mode, use this table:
  660.  
  661.            0 - Disgrace         If you use the Remote Access mode, just
  662.            1 - Limited          use the verbatim you would use in RACONFIG
  663.            2 - Normal           or JFREQCFG.
  664.            3 - Worthy
  665.            4 - Privil
  666.            5 - Favoured
  667.            6 - Extra
  668.            7 - Clerk
  669.            8 - AsstSysop
  670.            9 - SysOp
  671.  
  672.   To update this index, execute JFFC(P) when necessary.
  673.  
  674.  
  675.   3.6 Remote Access file index Speed-up
  676.  
  677.   You  can  use  an  special  index  with  RA to decrease response times when
  678.   performing file searches.  This index must be updated al least once  a  day
  679.   if  you  change  any information in your BBS file index files.  To use this
  680.   special index, just run the utility called JFRAFC.EXE to obtain  the  index
  681.   file RAFILES.IDX in your JFREQ directory.
  682.  
  683.   The  use  of  this  index is automatic, so you have not to touch a thing in
  684.   your JFREQ configuration.
  685.  
  686.  
  687.   3.7 VIP Systems
  688.  
  689.   JFREQ allows you to define specific  limitations  with  your  VIP  systems,
  690.   based  on  the  main  address  of the calling system.  The specificatios to
  691.   allow this are in the file JFREQ.VIP:
  692.  
  693.   Syst. Address BBS Lev. MaxTime MaxSize MaxFile DayTime DaySize DayFile
  694.   ------------- -------- ------- ------- ------- ------- ------- -------
  695.   @2:343/116.*      300      60     5000      25      0       0       0
  696.   2:343/129.0       300      60     5000      25      0       0       0
  697.   2:343/117.0       300      60     5000      25      0       0       0
  698.  
  699.   '@' before an address means that the session must be 'secure' for this  Vip
  700.   level  to  apply Valid BBS user levels: ---------------------- RA mode: use
  701.   the same figures you use in  JFREQCFG  Maximus  mode:  0  -  Disgrace  1  -
  702.   Limited  2  - Normal 3 - Worthy 4 - Privil 5 - Favoured 6 - Extra 7 - Clerk
  703.   8 - AsstSysop 9 - SysOp
  704.  
  705.   Chapter 3. Other data                                                    12
  706.  
  707.  
  708.   Please use FULL 4D addresses as shown above.  Wildcards are allowed at  any
  709.   place of the address.
  710.  
  711.   0 in any field (except BBS level) means 'no limit'
  712.  
  713.  
  714.   3.8 Statistical Reports
  715.  
  716.   JFSTAT(P)   is  the  program  you  must  execute  in  order  to  obtain  an
  717.   statistical report of your system.   These  statistics  are  based  on  all
  718.   tasks of the system.
  719.  
  720.   The syntax of this program can be:
  721.  
  722.   a) report as a PKT file, to netmail or a message area:
  723.  
  724.    JFSTAT(P) /PKT <to> <area> <inbound path> [days to report] [days to purge]
  725.  
  726.   <to>  stands  for  the  name  to address the message, using underscores for
  727.   spaces (e.g.  Joe_Sysop).
  728.  
  729.   <area> is NETMAIL for netmail message or the tag of the area  you  want  to
  730.   have the report delivered.
  731.  
  732.   <inbound  path> is the path you use for receiving the inbound mail packets.
  733.   To be compatible with any message base, the output is done  to  a  standard
  734.   PKT file, to be processed later on by your mail processor.
  735.  
  736.   b) report to screen:
  737.  
  738.    JFSTAT [days to report] [days to purge]
  739.  
  740.   [days  to  report]  are  the  number of days you want to be reported about.
  741.   '0' or nothing means reporting everything available.
  742.  
  743.   [days to purge] after reporting, any data before [days]  will  be  deleted.
  744.   Eg.   if  you  specify  4, any data older than four days from today will be
  745.   deleted.  If you enter 0, all data will  be  deleted.   This  process  only
  746.   affects  the  statistical  data.   Node  information  and  Logs will remain
  747.   intact.  If you do not provide a number, nothing will be deleted.
  748.  
  749.   you can execute JFSTAT with no arguments, which  will  give  you  a  global
  750.   statistical report (to screen) of all days kept.
  751.  
  752.  
  753.   3.9 Special Requests with Attached Messages
  754.  
  755.   JFReq  allows you to add specific messages to the mail packet if the remote
  756.   system requests  a  specific  file.   Thos  messages  can  use  all  tokens
  757.   available.   To  activate this option, simply edit the file FNAMES.DAT from
  758.   the configuration program,  by  using  the  'Special  Requests'  option  in
  759.   Global options.
  760.  
  761.   Chapter 3. Other data                                                    13
  762.  
  763.  
  764.   In  this  file,  you must specify the partial name (no wildcards) to match,
  765.   along with a file name corresponding to the message you  want  to  send  to
  766.   all system requesting those files.
  767.  
  768.   By instance, if you define the following line in FNAMES.DAT:
  769.  
  770.       .JPG    c:\jfreq\gifjpg.msg
  771.  
  772.   The  file  named  gifjpg.msg  will  be  added to the response packet (after
  773.   converting any tokens included), to all systems  requesting  files  with  a
  774.   JPG extension.
  775.  
  776.  
  777.   3.10 Editor Commands
  778.  
  779.   The  JFReq  Setup  program  includes a simple editor to help you in editing
  780.   the configuration files.  Apart form  the  cursors  and  other  well  known
  781.   editing keys, those are other keys you can use inside the editor:
  782.  
  783.   Ctrl+rig. arrow - places the cursor in the beginning of the next word
  784.   Ctrl+left arrow - places the cursor in the beginning of the previous word
  785.          Ctrl+end - deletes from the cursor to the end of line
  786.         Ctrl+home - deletes from the cursor to the beginning of the line
  787.    Ctrl+backspace - deletes a entire line (you can undelete it with Alt+R)
  788.         Ctrl+PgDn - places the cursor at the end of the document
  789.         Ctrl+PgUp - places the cursor at the beginning of the document
  790.             Alt+S - copies the current line in memory
  791.             Alt+R - restores the latest copied or deleted line
  792.             Alt+X - ends the editing, saving the file
  793.  
  794.  
  795.   3.11 Credits
  796.  
  797.   Many thanks to all my betatesters, and to their suggestions:
  798.  
  799.   Ignacio Plasencia       2:341/11@fidonet.org
  800.   Rafael Suárez           2:341/14@fidonet.org
  801.   Francisco Sedano        2:341/20@fidonet.org
  802.   Rafael Gutierrez        2:341/45@fidonet.org
  803.   Tirs Abril              2:343/106@fidonet.org
  804.   José Gonzalvo           2:343/129@fidonet.org
  805.   Carlos Hermida          2:348/603@fidonet.org
  806.  
  807.  
  808.   3.12 How to contact the author
  809.  
  810.   Please  send  all  your  constructive comments on JFReq via electronic mail
  811.   to:
  812.  
  813.   Jordi Sese,
  814.   BlackAdders' BBS: INT+34-3-2103303 (24Hr, V32b, V42b, FAX)
  815.   Fidonet:     2:343/116
  816.   RedBBS:      757:101/25
  817.   Internet:    shel@black.lonestar.es
  818.  
  819.  
  820.   Chapter 3. Other data                                                    14
  821.  
  822.  
  823.   or by slow surface mail:
  824.  
  825.   Jordi Sese
  826.   C/ Sostres 31, pta 7
  827.   08024 Barcelona
  828.   (Spain)
  829.  
  830.   If you are a registered user, you can use these same  media  to  ask  those
  831.   questions  to  make  your  system  work better with JFReq.  If you have not
  832.   registered your program yet, please take a look at  the  file  REGISTER.TXT
  833.   to know the conditions of use and how to become a registered user.
  834.  
  835.   NOTE:  If  you  want  to  register,  please  address  your  requests to the
  836.   Register Site in REGISTER.TXT.
  837.  
  838.                              - End of JFReq.Doc -
  839.