home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / bbs / fn132bin / fdman / chapter.12 < prev    next >
Text File  |  1991-09-03  |  12KB  |  248 lines
  1.  
  2.  
  3. Chapter 12:  File Transfers                                              147
  4.  
  5.  
  6.  
  7.  
  8. 12  File Transfers
  9.  
  10.  
  11.    As you've  probably guessed  by now,  Fnordadel is  oriented towards  the
  12. discussion  type  of  BBSing (i.e.:    message  oriented  rather  than  file
  13. transfer oriented).   Still, Fnordadel prides itself on being  flexible, and
  14. a decent level of file transfer features is supported.
  15.  
  16.  
  17.  
  18. 12.1  File Directories
  19.  
  20.    Fnordadel permits  a  room to  have attached  to it  a  directory on  the
  21. storage  device;  users may  be  able to  upload  files to  this  directory,
  22. or  download  files  from this  directory,  or  both.     (These  attributes
  23. are  changed by  editing the  room;  see Section  4.2.1 [Sysop  room-editing
  24. commands], page  70.)   Users may  also read the  contents of the  directory
  25. in either  a short format  (.R(ead) D(irectory)) or  a long format  (.R(ead)
  26. E(xtended-directory)).  The  short form prints out the filenames  and sizes,
  27. whereas the  long form  adds the  date stamp  of the files  and an  optional
  28. description.     See Section  3.2.2.2  [Multi-key  file  reading  commands],
  29. page 43.
  30.  
  31.    The  file descriptions  are  kept in  each  directory  in a  file  called
  32. `.fdr'.    This file  is added  to whenever  a user  uploads a  file to  the
  33. directory,  and it is  also editable  with a text  editor.   It consists  of
  34. lines of the form
  35.  
  36.       <filename> <description>
  37.  
  38. where the two fields are separated by whitespace (spaces and/or  tabs).  The
  39. lines must  be alphabetically  sorted; that  is, the  line for  `foobar.zoo'
  40. must come after the line for `blort.lzh' and so on.
  41.  
  42.    If you  add files to  a directory manually  (by copying  them in using  a
  43. shell or the Desktop) then the `.fdr' file will,  obviously, not be updated.
  44. You may want to do  so manually so as to provide some sort of help  for your
  45. downloading-mad users.
  46.  
  47.  
  48. 12.2  Protocols
  49.  
  50.    Fnordadel supports the following protocols for file transfers:
  51.  
  52. Xmodem     The  standard 128-byte  packet prototol.    Invoke this  protocol
  53.            using .R(ead)  X(modem) F(ile)  ... or  .E(nter) X(modem)  F(ile)
  54.            ....
  55.  
  56. Ymodem     Xmodem  with 1K  (1024  byte) packets.    Yes,  we know  this  is
  57.            a misnomer,  but  it's historical.   (Translation:   ``We  didn't
  58.            put it  in, someone else  did...'')   Invoke this protocol  using
  59.            .R(ead) Y(modem) F(ile) ... or .E(nter) Y(modem) F(ile) ....
  60.  
  61.  
  62.  
  63. Chapter 12:  File Transfers                                              148
  64.  
  65.  
  66.  
  67.  
  68. Ymodem batch
  69.            This is true Ymodem---1K packets with batch  transfers (i.e., you
  70.            can  send more  than one  file at  once, and  the software  keeps
  71.            track  of filenames  and stuff).    Fnordadel  supports this  for
  72.            general use  in downloads only; it  will do Ymodem batch  uploads
  73.            only when  a user  with Sysop  or Co-Sysop status  is logged  in.
  74.            Invoke this protocol  using .R(ead) Y(modem) B(atch file)  ... or
  75.            .E(nter) Y(modem) B(atch file) ....
  76.  
  77. WXmodem    This is a windowed packet protocol which is  not widely used, and
  78.            the implementation  residing in  Fnordadel is known  to be  weak;
  79.            we've never  even touched  it.   We  don't even  have a  terminal
  80.            program  which supports  it,  so we  can't  test it  except  with
  81.            itself,  which is  hardly rigorous.   Maybe  try it  if you  can.
  82.            Invoke this protocol  by using .R(ead) W(Xmodem) ...  or .E(nter)
  83.            W(Xmodem) ....
  84.  
  85. Vanilla ASCII
  86.            This  is  a straight  ASCII  transfer terminated  with  two  `^X'
  87.            (`Ctrl-X') characters.   It is useful  for modems with their  own
  88.            error  correction, or  for  other times  when  you want  a  plain
  89.            transfer (say, for  uploading a message directly from  the editor
  90.            of  a terminal  package,  or some  such.)    It is  invoked  with
  91.            .R(ead) V(anilla) ... or .E(nter) V(anilla) ....
  92.  
  93. ASCII      This  is  a  straight  ASCII  transfer  with  no  error  checking
  94.            or  distinguishing  features.    It  just blorts  out  the  file.
  95.            This  ``protocol'' is  unlike the  others in  that  it cannot  be
  96.            specifically invoked in a command, and it  is available only with
  97.            .R(ead); invoke it by using .R(ead) F(ile).
  98.  
  99.    You may  also enable  any number  of additional  file transfer  protocols
  100. using doors; see Section 9.3.3 [Protocol doors], page 131.
  101.  
  102.    The actual  mechanism for  file transfers  is documented  in this  manual
  103. in  Section  3.2.1.2   [Multi-key  file  entry  commands],   page  36,   and
  104. Section 3.2.2.2  [Multi-key file  reading commands],  page  43, among  other
  105. places, and in the online help files.  Note  that the transfer protocols can
  106. be used to  transfer more than just files;  in particular, they can  be used
  107. to upload messages into and download messages from the message base.
  108.  
  109.  
  110.  
  111. 12.3  The File Browser
  112.  
  113.    The Fnordadel file browser is an addition not found on  any other Citadel
  114. variants that we  know of.  If offers  users a way to step through  the list
  115. of files in a directory room  one at a time, and do things with them.   Many
  116. other types  of BBSes have  such functionality, and we  decided it was  time
  117. for a Citadel to be  able to claim the same thing, for those who  want to do
  118. file transfer stuff as well as discussion.
  119.  
  120.    Because we try  to make commands consistent,  the file browser is  called
  121. up in  the same  fashion that  the one-at-a-time message  reading option  is
  122. invoked, namely using the M(ore) modifier:
  123.  
  124.  
  125.  
  126. Chapter 12:  File Transfers                                              149
  127.  
  128.  
  129.  
  130.  
  131.       .R(ead) M(ore) D(irectory) [optional file mask]
  132.       .R(ead) M(ore) E(xtended directory) [optional file mask]
  133.  
  134. Both of  the above  commands produce exactly  the same result,  which is  to
  135. display the  first file in  the directory that matches  the given file  mask
  136. (if  there is  one).   Following  the file  name display  (which looks  just
  137. like the  entry for  that file  in the normal  .R(ead) E(xtended  directory)
  138. listing), the browser prompt is displayed.  Here's what you might see:
  139.  
  140.       callbaud.sys    2588 | 91Apr28 | Highly esoteric BBS usage stats.
  141.  
  142.       Browse cmd:
  143.  
  144.    Note that other command  options might be useful in conjunction  with the
  145. browser mode option M(ore).   Two good examples are -(before)  and +(after).
  146. These  commands cause  the system  to ask  for a  date  in standard  Citadel
  147. format (e.g.  `91May20',  or just `May20' to assume the current year).   You
  148. can also just  hit `<CR>' to tell  the system to use  the date of your  last
  149. call.  Fnordadel then merrily crunches through the  directory and only lists
  150. those files before or after the date.
  151.  
  152.    Hitting  `?'  at  the browser  prompt  produces  the  following  list  of
  153. commands:
  154.  
  155.       [A]- view this entry again
  156.       [B]ackup to previous file
  157.       [C]lear batch list
  158.       [H]eader listing of ARC, LZH, ZOO file
  159.       [M]ark this file for batch transfer
  160.       [N]ext file (also <SPACE>, <CR>)
  161.       [U]nmark a file
  162.       [V]iew batch list
  163.       e[X]it the browser (also [Q]uit, [S]top)
  164.  
  165. [A]- view this entry again
  166.            This  command will  redisplay the  current file  description,  in
  167.            case it  was somehow removed from view  and the user forgot  what
  168.            it was.
  169.  
  170. [B]ackup to previous file
  171.            This command will back up one entry  and redisplay the preceeding
  172.            file description, if there is one.
  173.  
  174. [C]lear batch list
  175.            This  command  wipes  out  the entire  batch  list.     There  is
  176.            currently no way  to take out just  one file name from the  list;
  177.            if you really don't  want to transfer it, you'll have  to [C]lear
  178.            the list and start over.
  179.  
  180. [H]eader listing of ARC, LZH, ZOO file
  181.            This command is  quite useful for helping decide whether  a given
  182.            archive file  is worth  downloading.   If  the description  isn't
  183.            enough,  this will  show the  archive's table  of contents,  like
  184.            the `.RH'  command would.   The `.arc'  file format is  supported
  185.            internally with  Fnordadel, but for  `.lzh' and `.zoo' files  (or
  186.  
  187.  
  188.  
  189. Chapter 12:  File Transfers                                              150
  190.  
  191.  
  192.  
  193.  
  194.            any others) to work, the Sysop must have set up  some doors.  See
  195.            Section 9.3.2 [Archiver doors], page 130.
  196.  
  197. [M]ark this file for batch transfer
  198.            This command  adds the  currently-displayed file  to an  internal
  199.            list of  files to  be batch  downloaded by  the user,  presumably
  200.            using the  .R(ead) Y(modem) B(atch file) command.   After a  file
  201.            is marked,  the total  size of all  marked files is  shown.   The
  202.            browser will not permit a user to mark more  files than the daily
  203.            download limit allows.
  204.  
  205.            Normally, the `.RYB' command needs the user to  enter a file mask
  206.            indicating which files are to be transferred.   However, if there
  207.            is a batch list in existence, the user can  just hit `<CR>' after
  208.            entering `.RYB', and  the system will prompt for the  transfer of
  209.            all  files in  the batch  list.   The  batch list  will not  stop
  210.            the user  from explicitly  transferring other  files if  desired,
  211.            by doing  `.RYB filename'.   See Section 3.2.2.2 [Multi-key  file
  212.            reading commands], page 43.
  213.  
  214.            The  batch  list may  contain  a  collection of  files  from  any
  215.            series of directory  rooms.  The user  can go from room  to room,
  216.            adding interesting  files to  the list,  until he has  everything
  217.            wanted.  Then one massive `.RYB <`<CR>'>'  command will take them
  218.            all.   (Assuming the user  has enough download credit  available,
  219.            of course.   See  the download  parameter in `ctdlcnfg.doc',  and
  220.            Section 10.2.7 [Daily download limit], page 136.)
  221.  
  222. [N]ext file (also <SPACE>, <CR>)
  223.            This command  advances to the  next file  that matches the  given
  224.            file mask, if any.  If there are no  files remaining, the browser
  225.            exits and the  user is returned to the  room prompt.   Any marked
  226.            files may now  be transferred.   To view the current batch  list,
  227.            it is necessary to re-enter the browser.
  228.  
  229. [U]nmark a file
  230.            This command  allows a user  to unmark an individual  file.   The
  231.            user will be prompted  for the file name to unmark, and if  it is
  232.            present in the batch list, it will be removed.
  233.  
  234. [V]iew batch list
  235.            The [V]iew command  does just that,  allows the user to view  the
  236.            current  batch list.    There are  three  columns of  information
  237.            (source room,  file name  and file size),  followed by the  total
  238.            size of all marked files.  Here's an example:
  239.  
  240.                  RT stats                callbaud.sys    2588
  241.                  Foo room                bigfile.foo     100000
  242.                  Total marked file size = 102588 bytes.
  243.  
  244. e[X]it the browser (also [Q]uit, [S]top)
  245.            this command immediately  exits the browser and returns  the user
  246.            to the room prompt.
  247.  
  248.