.TOPIC:                                             
File Commands

                                             VBBS 6.12 Documentation -- 10-E-1


         ͻ
          CHAPTER TEN ANNEX E      FILE COMMANDS                         
         ͼ

         ͻ
         ** Note:All commands marked with a (*) before the description **
         **      will only work properly if implemented from within    **
         **      a script that was called from a function block that   **
         **      has DBGroup(s) listed in it.  They take the letters   **
         **      for the DBGroups to use from the second line of the   **
         **      .FB the script was called from.  The DBGROUP and DB   **
         **      commands do not affect any of these commands.         **
         ͼ

         INFORMATION COMMANDS
         

         CHECKFILE ->  CHECKFILE <variable1> <pathfile2>

                This command checks to see if <pathfile2> exists on your
           system and places the file size into <variable1>.  It returns
           a 0 if the file does not exist.

         FINDFIRST ->  FINDFIRST <variable1> <pathfile2>
         FINDNEXT ->  FINDNEXT <variable1>

                These commands search for the file mask <pathfile2>. It may
           include globals and will default to the \VBBS directory if no
           path is specified.  You must execute FINDFIRST once before you
           can use the FINDNEXT command.  Both commands will return the
           full filename to <variable1> or a "" if no match is found.

         FINDFILES <---

         (*)    This asks the user for search text and asks if the user
           would like to search all topic areas.  It then searches all the
           files in the selected DBGroup(s) and searches the descriptions
           for those that contain the search text.

         LISTFILES <---

                This prompts for a filename (wildcards accepted) and then
           lists all matching files in the current database.

         NEWFILES <---

         (*)    This command asks the user would like to scan all topic
           areas and then lists all new files in the selected DBGroup(s).

         RATIO <---

                This displays the user's upload/download ratio.


                                             VBBS 6.12 Documentation -- 10-E-2


         REVIEWFILE <---

                This command allows the user to review any of the files in
           the current database.  They can they be downloaded or tagged
           for a batch download later.

         REVIEWUPLOADS <---

         (*)    This command allows the sysop to review all new files that
           have been uploaded by users.


         SEARCHALL <---

         (*)    This works like LISTFILES, but also allows the user to
           search all topic areas.  It then lists the matching files in
           the selected DBGroup(s).

         SETNEWFILESSCAN ->  SETNEWFILESSCAN <value1>

                This command will set the number of days back a NEWFILES
           scan equal to <value1>.  If <value1> is left blank then the
           user will be prompted for the number of days to use.

         TOPDOWNLOADS <---

                This lists the top downloads in the active file DBGroup.

         XFERTIME ->  XFERTIME <variable1> <pathfile2>

                This command will calculate how long it will take to
           download <pathfile2> and stores it in <variable1>.  It will
           return a 0 if the file is not found.


         TRANSFER COMMANDS
         

         BATCHDL <---

                This command brings up the batch transfer menu.

         DLMASTERLIST <---

         (*)    This command allows the user to download a zipped listing
           of your entire transfer section.

         DOWNLOAD ->  DOWNLOAD <pathfile1>

                This prompts the user to choose an xfer protocol and then
           sends the file <pathfile1>.


                                             VBBS 6.12 Documentation -- 10-E-3


         DOWNLOADFILE <---

         (*)    This command prompts for a filename (it accepts wildcards)
           and then show the user the file's review screen.  The user can
           then download directly or tag for a batch download.

         REMOTEUPLOAD <---

                This allows the user to upload files to the BBS.

         SYSOPUPLOAD <---

                This command allows the sysop to upload files locally.

         UPLOAD ->  UPLOAD <pathfile1>

                This command prompts the user to choose a protocol and
           then receives <pathfile1> from the user.  A full path may be
           used, but is not necessary.


         FILE EDITING
         

                VSCRIPT allows you to directly read and write from pure
           ASCII text files.  The commands to do so are listed here.
           Note: You must always OPEN a file before performing any of the
                 other commands and CLOSE it when done, except as noted.

         EDITFILE <---

                This allows the sysop to edit any text file with no more
           than 200 lines.  This is one exception to the OPEN and CLOSE
           rule, you should not use either with this command.

         CLOSE <---

                This closes a file previously opened with OPEN.

         KILL ->  KILL <pathfile1>

                This deletes <pathfile1> off of your system.  This is the
           other exception to the OPEN and CLOSE rule, you should not use
           either with this command.

         OPEN ->  OPEN <pathfile1> <option>

                This command opens a file for use.  One of the following
           three options must be selected on the command line:

                INPUT -> This allows you to READ data in from a file
                OUTPUT -> This allows you to create a file and begin
                          to WRITE new information into it.
                APPEND -> This allows you to open an existing file and
                          WRITE information onto the end of it.


                                             VBBS 6.12 Documentation -- 10-E-4


         READ ->  READ <variable1>

                This will read in a single line from the file and place it
           into <variable1>.  Multiple READ statements will continue to
           read in the next line in the file and if the end of the file is
           reached it will return an !EOF!.  The only way to start at the
           top of a file again is to CLOSE it and then OPEN it again.

         WRITE ->  WRITE <token2> <token3> <token4> ... <token7>

                This command performs exactly like the TR command in
           section 3.2 with the only difference being that the output
           goes into a file instead of on screen.


