home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / v612docs.zip / VC10E < prev    next >
Text File  |  1993-12-16  |  7KB  |  195 lines
  1. .TOPIC:                                             
  2. File Commands
  3.  
  4.                                              VBBS 6.12 Documentation -- 10-E-1
  5.  
  6.  
  7.          ╔════════════════════════════════════════════════════════════════╗
  8.          ║ CHAPTER TEN ANNEX E      FILE COMMANDS                         ║
  9.          ╚════════════════════════════════════════════════════════════════╝
  10.  
  11.          ╔════════════════════════════════════════════════════════════════╗
  12.          ║** Note:All commands marked with a (*) before the description **║
  13.          ║**      will only work properly if implemented from within    **║
  14.          ║**      a script that was called from a function block that   **║
  15.          ║**      has DBGroup(s) listed in it.  They take the letters   **║
  16.          ║**      for the DBGroups to use from the second line of the   **║
  17.          ║**      .FB the script was called from.  The DBGROUP and DB   **║
  18.          ║**      commands do not affect any of these commands.         **║
  19.          ╚════════════════════════════════════════════════════════════════╝
  20.  
  21.          INFORMATION COMMANDS
  22.          ═════════════════════
  23.  
  24.          CHECKFILE ->  CHECKFILE <variable1> <pathfile2>
  25.  
  26.                 This command checks to see if <pathfile2> exists on your
  27.            system and places the file size into <variable1>.  It returns
  28.            a 0 if the file does not exist.
  29.  
  30.          FINDFIRST ->  FINDFIRST <variable1> <pathfile2>
  31.          FINDNEXT ->  FINDNEXT <variable1>
  32.  
  33.                 These commands search for the file mask <pathfile2>. It may
  34.            include globals and will default to the \VBBS directory if no
  35.            path is specified.  You must execute FINDFIRST once before you
  36.            can use the FINDNEXT command.  Both commands will return the
  37.            full filename to <variable1> or a "" if no match is found.
  38.  
  39.          FINDFILES <---
  40.  
  41.          (*)    This asks the user for search text and asks if the user
  42.            would like to search all topic areas.  It then searches all the
  43.            files in the selected DBGroup(s) and searches the descriptions
  44.            for those that contain the search text.
  45.  
  46.          LISTFILES <---
  47.  
  48.                 This prompts for a filename (wildcards accepted) and then
  49.            lists all matching files in the current database.
  50.  
  51.          NEWFILES <---
  52.  
  53.          (*)    This command asks the user would like to scan all topic
  54.            areas and then lists all new files in the selected DBGroup(s).
  55.  
  56.          RATIO <---
  57.  
  58.                 This displays the user's upload/download ratio.
  59.  
  60.  
  61.                                              VBBS 6.12 Documentation -- 10-E-2
  62.  
  63.  
  64.          REVIEWFILE <---
  65.  
  66.                 This command allows the user to review any of the files in
  67.            the current database.  They can they be downloaded or tagged
  68.            for a batch download later.
  69.  
  70.          REVIEWUPLOADS <---
  71.  
  72.          (*)    This command allows the sysop to review all new files that
  73.            have been uploaded by users.
  74.  
  75.  
  76.          SEARCHALL <---
  77.  
  78.          (*)    This works like LISTFILES, but also allows the user to
  79.            search all topic areas.  It then lists the matching files in
  80.            the selected DBGroup(s).
  81.  
  82.          SETNEWFILESSCAN ->  SETNEWFILESSCAN <value1>
  83.  
  84.                 This command will set the number of days back a NEWFILES
  85.            scan equal to <value1>.  If <value1> is left blank then the
  86.            user will be prompted for the number of days to use.
  87.  
  88.          TOPDOWNLOADS <---
  89.  
  90.                 This lists the top downloads in the active file DBGroup.
  91.  
  92.          XFERTIME ->  XFERTIME <variable1> <pathfile2>
  93.  
  94.                 This command will calculate how long it will take to
  95.            download <pathfile2> and stores it in <variable1>.  It will
  96.            return a 0 if the file is not found.
  97.  
  98.  
  99.          TRANSFER COMMANDS
  100.          ═════════════════
  101.  
  102.          BATCHDL <---
  103.  
  104.                 This command brings up the batch transfer menu.
  105.  
  106.          DLMASTERLIST <---
  107.  
  108.          (*)    This command allows the user to download a zipped listing
  109.            of your entire transfer section.
  110.  
  111.          DOWNLOAD ->  DOWNLOAD <pathfile1>
  112.  
  113.                 This prompts the user to choose an xfer protocol and then
  114.            sends the file <pathfile1>.
  115.  
  116.  
  117.                                              VBBS 6.12 Documentation -- 10-E-3
  118.  
  119.  
  120.          DOWNLOADFILE <---
  121.  
  122.          (*)    This command prompts for a filename (it accepts wildcards)
  123.            and then show the user the file's review screen.  The user can
  124.            then download directly or tag for a batch download.
  125.  
  126.          REMOTEUPLOAD <---
  127.  
  128.                 This allows the user to upload files to the BBS.
  129.  
  130.          SYSOPUPLOAD <---
  131.  
  132.                 This command allows the sysop to upload files locally.
  133.  
  134.          UPLOAD ->  UPLOAD <pathfile1>
  135.  
  136.                 This command prompts the user to choose a protocol and
  137.            then receives <pathfile1> from the user.  A full path may be
  138.            used, but is not necessary.
  139.  
  140.  
  141.          FILE EDITING
  142.          ════════════
  143.  
  144.                 VSCRIPT allows you to directly read and write from pure
  145.            ASCII text files.  The commands to do so are listed here.
  146.            Note: You must always OPEN a file before performing any of the
  147.                  other commands and CLOSE it when done, except as noted.
  148.  
  149.          EDITFILE <---
  150.  
  151.                 This allows the sysop to edit any text file with no more
  152.            than 200 lines.  This is one exception to the OPEN and CLOSE
  153.            rule, you should not use either with this command.
  154.  
  155.          CLOSE <---
  156.  
  157.                 This closes a file previously opened with OPEN.
  158.  
  159.          KILL ->  KILL <pathfile1>
  160.  
  161.                 This deletes <pathfile1> off of your system.  This is the
  162.            other exception to the OPEN and CLOSE rule, you should not use
  163.            either with this command.
  164.  
  165.          OPEN ->  OPEN <pathfile1> <option>
  166.  
  167.                 This command opens a file for use.  One of the following
  168.            three options must be selected on the command line:
  169.  
  170.                 INPUT -> This allows you to READ data in from a file
  171.                 OUTPUT -> This allows you to create a file and begin
  172.                           to WRITE new information into it.
  173.                 APPEND -> This allows you to open an existing file and
  174.                           WRITE information onto the end of it.
  175.  
  176.  
  177.                                              VBBS 6.12 Documentation -- 10-E-4
  178.  
  179.  
  180.          READ ->  READ <variable1>
  181.  
  182.                 This will read in a single line from the file and place it
  183.            into <variable1>.  Multiple READ statements will continue to
  184.            read in the next line in the file and if the end of the file is
  185.            reached it will return an !EOF!.  The only way to start at the
  186.            top of a file again is to CLOSE it and then OPEN it again.
  187.  
  188.          WRITE ->  WRITE <token2> <token3> <token4> ... <token7>
  189.  
  190.                 This command performs exactly like the TR command in
  191.            section 3.2 with the only difference being that the output
  192.            goes into a file instead of on screen.
  193.  
  194.  
  195.