home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / oct93 / comm / 4d-bbsdemo.lha / 4D-BBSDemo / Docs / 06.FileTrans < prev    next >
Text File  |  1993-07-02  |  14KB  |  373 lines
  1. Chapter 6:
  2.  
  3.  
  4.         File Transfers
  5.  
  6.  
  7. 6.1.0 Overview
  8.  
  9. 6.2.0  The File Catalog Editor
  10.  
  11.  
  12.  
  13.         4D-BBS FCL_ED DOCUMENTATION, (C) 1993 CornerStone Software.
  14.                   Written by Jeff Holden   Feb 12, 1993
  15.                          FCL_ED V2.65 and above.
  16.  
  17.  
  18.    4D-BBS, CLP and EIC are registered tradmarks of CornerStone Software.
  19.  
  20.  
  21. As a multi functionable executable editor, you have 4 ways of running
  22. this software, they are broken down into 2 catagories.
  23.  
  24. 1  Command mode
  25. 2  Silent mode
  26.  
  27. The editors may be run through workbench, shell/cli, script, or as a door.
  28.  
  29. In command mode you are allowed to edit everything (options via keys),
  30. however in silent mode (NOT available if running as a door) the editor
  31. is not viewable, nor is keyboard input. In silent mode you pass all
  32. options to the editor via the command line parameters (CLP).
  33.  
  34. In silent mode, options are carried out without the veiwable editor, this
  35. is very handy for maintenance scripts and fast updating without starting
  36. up the full editor.
  37.  
  38. FCL_ED does not detach from the CLI when run, if you want it to (running in
  39. silent mode) use the 'Run >NIL: fcl_ed (options)' and your script/cli
  40. will continue with the editor running in the background.
  41.  
  42. The following CLPS tell the editor certain specific information in which the
  43. editor needs to know in order to run. (In Command OR Silent mode)
  44.  
  45. *** CLPS ARE CASE SENSITIVE **
  46.  
  47. (# = a number)
  48. ($ = String (filename/name/etc.)
  49.  
  50.  
  51. OPTION    Description               Supporting OPTS     DEFAULTS
  52. ---------|-------------------------|-------------------|-------------
  53.  -b$      Path/assign to BBS:          All but -f          BBS:
  54.  -c       Convert from old          All    but -f          Defaults to editor
  55.  -d$      Path/filename of datafile All    but -f          BBS:FileDefs.d
  56.  -r#      Rows displayable          All    but -f          10 rows (Lists)
  57.  -a$         On-Line Arexx update      All but -f          NONE
  58.           (This tells the editor to update 4d-bbs on changes)
  59.  
  60. If none of the above are given the defaults will be used.
  61.  
  62. If running as a door, the door will tell 4d about the changes (If any).
  63. Door running can only be accomplished if using 4D-BBS SERIES IIA V1.00
  64. and above extended door protocols.
  65.  
  66. If running through 4D-BBS function keys or pull down menus, WITH THE
  67. ONLINE UPDATE option ON, 4D will be notified of any changes via the
  68. arexx port name passed to the editor (-a$).
  69.  
  70. Special CLPS
  71.  
  72. ** -s #
  73. To initialize a silent mode you must give the '-s' CLP followed by a #, the
  74. number represents the file library you wish to silently edit/change/delete.
  75.  
  76. ** -f $
  77. A generic string specifier. If changing names or overriding default filepaths 
  78. and etc. Use the -f (Only for silent mode use, and ONLY where the -f is 
  79. supported ; almost all silent mode options support the -f CLP ).
  80.  
  81. ** NOTE ** only do one operation (changing name or ??) per run.
  82. Do NOT try to pass CLPS to the editor which specify two diff tasks. EX:
  83. dont try to explore the catalog, and change file section twos' filename
  84. in the same run.  CLP conflicts may arise.
  85.  
  86. The following is a list of silent mode options, ** Remember, the silent
  87. mode must be initiated with the -s# CLP. Options tend to follow the same
  88. keypresses you would have done if running in command mode.
  89.  
  90. In order to jump right to the editing point, the silent mode CLPS are
  91. setup as a string, each character in the string has a useful function
  92. and directs the editor as to where to do the editing.
  93.  
  94. _________________________________________________________________________
  95.  
  96. -E             This initializes the GENERAL LIBRARY SECTION EDITING.
  97.                2 characters MAX for this CLP. EX: -Ed tells the editor
  98.                to DELETE the library number in -s CLP.
  99.  
  100.                The second character can be one of the following:
  101.  
  102.                f    This will cause the editor to re-count all the files
  103.                     in the sections, and place the TRUE cataloged entries
  104.                     in the libraries count number. It will also total all
  105.                     the files cataloged and place it in the system stats
  106.                     data file. This is very handy if you Explore/Find
  107.                     files, saved the catalog but forgot to save the
  108.                     updated library counts.
  109.  
  110.                d    This will delete the library # found in the -s CLP
  111.                     all together, The actual files in its directory will
  112.                     NOT be deleted.
  113.      
  114.                END OF GENERAL LIBRARY SECTION EDITING CLPS
  115. _________________________________________________________________________
  116.  
  117. -e ...         This initializes the specific LIBRARY SECTION EDITING.
  118.                2 characters MAX for this CLP. EX: -ea tells the editor
  119.                to change this libraries name to whatever is in the -s
  120.                CLP.
  121.  
  122.                The second character can be one of the following:
  123.      
  124.                a    This is the new name you wish this library to be  
  125.                     known as. The name will be in the -f CLP.
  126.  
  127.                b    This tells the editor to place the path in -f CLP
  128.                     as this libraries file path (Where to find files
  129.                     for this section, section is found in -s CLP).
  130.                
  131.                c    Tells the editor that this library has an extended
  132.                     description base.. The Message base number to place
  133.                     in this libraries base # is in the -f CLP.
  134.  
  135.                d    New amount of files for this library, file count
  136.                     is found in the -f CLP.
  137.                
  138.                e    Status of this library in comparison to files.
  139.                     1 of the 2 following must be found in the -f CLP
  140.                     and ** ARE CASE SENSITIVE **
  141.                     
  142.                          A    Ask if file is private.
  143.                          P    Private library.
  144.  
  145.                     If neither of the above are found, the editors assumes
  146.                     the library is supposed to be a public one.
  147.  
  148.                f    Library opens at this hour. Ex: 6:00pm = 14, 
  149.                     the hour can be found in the -f CLP.
  150.  
  151.                g    Library Closes at this hour. Ex: 4:00am = 4, 
  152.                     the hour can be found in the -f CLP.
  153.  
  154.                h    Current (Right NOW) status of the library (overrides
  155.                     users access) and is a digit (0 through 4) found in 
  156.                     the -f CLP.
  157.                     
  158.                          0  Closed
  159.                          1  Open
  160.                          2  D-Load 
  161.                          3  U-Load
  162.                          4  Hide
  163.         
  164.                i    Sets the New user access level for this library to 
  165.                     whatever is in the -f CLP, IF the char is in 
  166.                     uppercase, its considered to be scanable, If in lower 
  167.                     case, its masked out.
  168.  
  169.                     The char in -f CLP can be one of the following
  170.  
  171.                     D    (Library is Download only)
  172.                     U    (Library is Upload only)
  173.                     B    (Upload and downloading available)
  174.                     N    (No access, closed library)
  175.             
  176.                j    Same as above (i) but effects MEMBERS.
  177.                        
  178.                k    Full path and filename of binary file catalog (where
  179.                     entry names and information is stored). Found
  180.                     in -f CLP.
  181.  
  182.                END OF SPECIFIC LIBRARY SECTION EDITING CLPS.
  183. _________________________________________________________________________
  184.  
  185. -l ...         This initializes the specific section CATALOG EDITING.
  186.                2 characters MAX for this CLP. EX: -lc -f3 tells the editor
  187.                to sort the catalog list by file name [alphabetically],
  188.                for whatever library section was found in the -s# CLP.
  189.  
  190.                The second character can be one of the following:
  191.  
  192.                f    Search for descriptionless entries and append the
  193.                     uploaders description file to prompt for descriptions.
  194.  
  195.                c    Compare/Sort the entries (Follows 1-6 options in command
  196.                     mode). The -f CLP contains a number from (1 through 6)
  197.                     which represent:
  198.                     
  199.                     1 Newest to oldest [default]
  200.                     2 Oldest to newest
  201.                     3 By file name [alphabetically]
  202.                     4 By uploader [alphabetically]
  203.                     5 By size [smallest to largest]
  204.                     6 By size [largest to smallest]
  205.             
  206.                w    Write a text file of the entries in this catalog. Saves
  207.                     the file to whatever is in the -f CLP, if nothing it
  208.                     will default to (path of the Lib #)/FileList.txt
  209.                     ** Uploaders name will not be given.
  210.  
  211.                a    Add a file to the catalog. The -f CLP will specify
  212.                     a file which is ** ALREADY ** in that libraries
  213.                     directory, and add it to the catalog with a AmigaDos
  214.                     Comment as the description (If one), Uploader as SYSOP
  215.                     and current date,size.
  216.  
  217.                d    Delete an entry from this list (Will not delete file, 
  218.                     only catalog entry). Entry name is also found with the
  219.                     -f CLP.
  220.  
  221.                e    Explore/Search library directory for any file not in the
  222.                     catalog. Defaults to adding ALL files not found in the
  223.                     file list, uploader name as SYSOP or whatever name
  224.                 can be found in the -f CLP, description is
  225.                     AmigaDos comment (if one), current date/size.
  226.                
  227.                END OF CATALOG EDITING CLPS.
  228.  
  229.  
  230. Examples of script type/cli silent running....
  231.  
  232.      A non-standard datafile (NOT filedefs.d), need to change the
  233.      file path for section 4
  234.  
  235.      run >nil: FCL_ED -dBBS:SecretFiles.d -s4 -eb -fSecret:src/
  236.  
  237.      Want to explore the directory for any files not cataloged for
  238.      section 82 and quickly add them to the catalog.  
  239.  
  240.      run >nil: FCL_ED -s82 -le
  241.  
  242.      Create a viewable text file on all the files in section 12 and save
  243.      the file in section 11 called S12list.text
  244.  
  245.      run >nil: FCL_ED -s12 -lw -fFile:sect_12/s12list.text
  246. _________________________________________________________________________
  247.  
  248. ** REMEMBER ** NOTE ** WARNING ** Do NOT try to do two sperate options
  249. at the same time..
  250.  
  251. EX: run >nil: FCL_ED -dBBS:SecretFiles.d -s4 -eb -lw -fSecret:src/
  252.                                                |   \
  253.                                               /     \
  254.      This will NOT work! The 'lw' will assume the -f CLP is the name
  255.      to save the file to.. If the -f was a file name, then the 'eb' would
  256.      use a filename as a path... So dont use two editing options at once.
  257.  
  258.  
  259.  
  260. WorkBench execution and Icon.
  261.  
  262. The Icon tool types are the same as the CLPS for 'user freindlyness'
  263. however a few notes are warranted..
  264.  
  265. When using tool types you give the tool name then an '=' then your
  266. string/number.
  267.  
  268. A CLP of -dbbs:Secret.d would be  d=BBS:Secret.d in workbench.
  269.  
  270. The Silent mode can also be run via workbench..
  271.  
  272. EX:  Want to explore the directory for any files not cataloged for
  273.      section 82 and quickly add them to the catalog.  
  274.  
  275.      Tool Types would be
  276.  
  277.      s=82
  278.      l=e
  279.  
  280.  
  281.      which is the same as the CLPS  -s82 -le
  282.  
  283.  
  284.  
  285. 4dbbsse1.library    
  286.      
  287.      As of 2-13-93 (V2.65) this library is not used, this library will 
  288.      handle most of all the editors redundant functions,  which should 
  289.      shrink each editor size by at least 25%.
  290.  
  291.  
  292. Enviroment variables.
  293.  
  294.     Editors can be told to grab information from the Amigas environment.
  295.     IF you pass an 'E' as the filename in '-d' or '-b' CLPS, the editor
  296.     will open the env: variables to grab the filenames/paths.
  297.  
  298.     The ENV: variables can be broken down into groups of the following
  299.  
  300.     4D        <- First 2 chars.. Tells us its a 4D-BBS variable
  301.  
  302.     The third char can be one of the following
  303.  
  304.         P    <- A Path/Assign
  305.  
  306.         D    <- A data file (full path and name)
  307.  
  308.     The rest of the variable name is the specific option we are looking
  309.     for.
  310.  
  311.         Rest of 4DP could be
  312.  
  313.             BBS       (ENV:4DPBBS   Contains path/assign to BBS:   Dir)
  314.             TEXT      (ENV:4DPTEXT  Contains path/assign to TEXT:  Dir)
  315.             USERS     (ENV:4DPUSERS Contains path/assign to USERS: Dir)
  316.             MENU      (ENV:4DPMENU  Contains path/assign to MENU:  Dir)
  317.  
  318.         The D options are data files for Files and Message bases.
  319.  
  320.             F         (ENV:4DDF   Contains path AND name of File 
  321.                           definitions data file (filedefs.d)
  322.  
  323.             B         (ENV:4DDB   Contains path AND name of Boards 
  324.                           definitions data file (boarddefs.d)        
  325.  
  326. Ex:  
  327.  
  328.     A non-standard datafile (NOT filedefs.d), need to change the
  329.      file path for section 4, Use Enviroment variable to find which
  330.     data file to use.
  331.  
  332.      run >nil: FCL_ED -dE -s4 -eb -fSecret:src/
  333.  
  334.  
  335. Here are some example scripts..
  336.  
  337. For a quick 'AddFile' type operation, you can add to your
  338. shell-startup this small line.
  339.  
  340. alias addfile2 FCL_ED -s2 -la -f[]
  341.  
  342. which will add a file to your section 2's catalog.
  343.  
  344. And use in through your shell like  'addfile [filename]'
  345.  
  346.  
  347. Or if a maintenance script, And you wish to have a current file listing at all
  348. times.. A little script like this would do great, and QUICK!
  349.  
  350. run >NIL: fcl_ed -s0 -lw
  351. run >NIL: fcl_ed -s1 -lw
  352. run >NIL: fcl_ed -s2 -lw
  353. run >NIL: fcl_ed -s3 -lw
  354. run >NIL: fcl_ed -s4 -lw
  355.  
  356. This will start up 5 editors, each counting files and writing text files.
  357.  
  358. As of now, each editor will need to allocate memory for the same data.
  359. This will be eliminated when the library is available. If you are
  360. very limited in ram, its best to NOT run them to the NILL, so the next
  361. editor will not start up until the first one is complete.. Takes longer,
  362. but saves some memory.
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.