home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / aftp1.zip / AutoFTP.DOC < prev    next >
Text File  |  1997-12-22  |  12KB  |  280 lines
  1.                            AutoFTP v1 - Documentation
  2.  
  3.                                 By Nicky Morrow
  4.                                    1:366/47
  5.                              nrmorrow@cybertron.com
  6.  
  7.                               Copyright (c) 1997
  8.                               All rights reserved
  9.  
  10. ───────────────────────────────────────────────────────────────────────────────
  11. /***** Contents Of Documentation *********************************************/
  12. ───────────────────────────────────────────────────────────────────────────────
  13.  
  14.        1) Disclaimer          5) Problems
  15.        2) Introduction        6) Future Features
  16.        3) Features List       7) Credits
  17.        4) Installation        8) Registration Policy
  18.  
  19. ───────────────────────────────────────────────────────────────────────────────
  20. /***** Disclaimer ************************************************************/
  21. ───────────────────────────────────────────────────────────────────────────────
  22.  
  23. There is no guarantee with this program other than it will take a
  24. small portion of space from your HD.  Use it at your own risk.
  25.  
  26. ───────────────────────────────────────────────────────────────────────────────
  27. /***** Introduction **********************************************************/
  28. ───────────────────────────────────────────────────────────────────────────────
  29.  
  30. "AutoFTP" was created for SysOps and others who need to automate ftp 
  31. operations.  It operates in normal ftp file sending mode as well as
  32. binkleyterm mode (expect frontdoor support in the future).  It can run
  33. all the time and execute events that you define or in automatic mode.
  34.  
  35. As time goes on expect new features with more options and increasing
  36. configuration flexibility.
  37.  
  38. System requirements:
  39.  
  40. OS/2 Warp - AutoFTP is developed on a OS/2 Warp v4 system but I have reports
  41.             that it runs well on v3.  I generally always install the latest
  42.             fixpaks on my system, therefore, I will be keeping abreast of any
  43.             problems related to fixpaks.
  44. REXX support must be installed.
  45. rxftp.dll must be installed.
  46. VGA display - I assume users have at least basic VGA (640x480x16).
  47.  
  48. ───────────────────────────────────────────────────────────────────────────────
  49. /***** Features List *********************************************************/
  50. ───────────────────────────────────────────────────────────────────────────────
  51.  
  52. ■ Easy installation. Simply create a folder called "AutoFTP" on the hard drive
  53.   of your choice and unrar the contents inside.
  54. ■ Easy configuration. The ftp site configuration files are simple text files 
  55.   which can be created with AutoFTP or with your favorite text processor.
  56. ■ Full onscreen and text file logging of operations.
  57. ■ Uses very little CPU time.
  58. ■ Ability to run events at preset times.
  59.  
  60. ───────────────────────────────────────────────────────────────────────────────
  61. /***** Future Features *******************************************************/
  62. ───────────────────────────────────────────────────────────────────────────────
  63.  
  64. ■ Increased configurability and faster operation.
  65. ■ Send me your idea...
  66.  
  67. ───────────────────────────────────────────────────────────────────────────────
  68. /***** Files *****************************************************************/
  69. ───────────────────────────────────────────────────────────────────────────────
  70.  
  71. Files included in archive:
  72. ──────────────────────────
  73. AutoFTP.EXE........................... - AutoFTP Executable
  74. AutoFTP.DOC........................... - This File (Text)
  75. AutoFTP.INI........................... - Main Configuration File (Text)
  76. AutoFTP.ICO........................... - AutoFTP Program Icon
  77. Sample.cfg............................ - Sample FTP Site Config File (Text)
  78. Dial.CMD.............................. - Batch file to start your dialer
  79. HangUp.CMD............................ - Batch file to hang your dialer up
  80.  
  81. Files created by AutoFTP:
  82. ───────────────────────────
  83. AutoFTP.LOG........................... - Log File (Text)
  84.  
  85. ───────────────────────────────────────────────────────────────────────────────
  86. /***** Installation and operation ********************************************/
  87. ───────────────────────────────────────────────────────────────────────────────
  88.  
  89. Unrar all files into the directory of your choice.  Create a program icon to
  90. AutoFTP.EXE if you wish.  I've included a icon.  Start AutoFTP.EXE from a OS/2
  91. command line or by any other normal means.
  92.  
  93. Concept of operation:
  94.  
  95. When you first start AutoFTP without command line parameters it will come up
  96. without any ftp site data in the data entry fields.  You will need to enter
  97. data in the necessary fields.  To see what goes in the data fields simply
  98. place the mouse pointer over the field and a description will be given at the
  99. bottom of the screen.  You may save this data by selecting <File> 
  100. <Save .cfg data> or with <Ctrl+S>.  The data is saved to a text file named
  101. as you like.  I typically name my files after the ftp server:
  102.  
  103. ftp.cdrom.com = cdrom.cfg.  The .cfg extention is required.
  104.  
  105. Example of operation for Planet Connect's ftp server:
  106.  
  107. 1 - Enter your Binkleyterm outbound directory in
  108.     "Local Outbound Directory"
  109.  
  110.     g:\mailer\outbound
  111.  
  112. 2 - Enter the HEX address for the destination system:
  113.  
  114.     0e1f0032.?lo
  115.  
  116.     Planet Connect (3615/50) HexAddress= 0e1f0032.?lo         
  117.  
  118. 3 - Enter the incoming directory on the remote server in
  119.     Remote Incoming Directory (if required):
  120.  
  121.     incoming
  122.  
  123.  
  124. To set events, simply select <Options> <Events> or <Ctrl+E> and type in the
  125. time in hours and minutes (the ":" is required) and the name of the .cfg
  126. file you want executed at that time.  The .cfg extention is required.
  127.  
  128. Binkleyterm mode is automatic and is keyed by your " Local Outbound Filespec"
  129. entry.  If the last 2 letters are "lo" then AutoFTP will enter Binkley mode.
  130. Example: 0e1f0032.?lo
  131.  
  132. AutoFTP supports Binkleyterm ?lo (compressed) modes.  It does not support
  133. ?ut (uncompressed) modes.  See the Binkley docs for details.  This should
  134. not be a problem in most cases.
  135.  
  136. AutoFTP is not a dialer but rather depends on an external dialer to do the
  137. dirty work.  AutoFTP's <Connection> menu items simply trigger batch files.
  138. Dial triggers Dial.CMD and HangUp triggers HangUp.CMD.  I use Injoy as my 
  139. dialer and this is what these batch files are setup for.  You may modify these
  140. files as you see fit.  If you have a lan based or constant tcp/ip connection
  141. AutoFTP will detect this and use it instead of using Dial.CMD and HangUp.CMD.
  142.  
  143. You may use AutoFTP in batch files.  If you use a .cfg file as a command
  144. line parameter it enters automatic mode.  It loads the server data, connects,
  145. tranfers and then terminates.
  146.  
  147. As you are testing/using this program please let me know what you think needs
  148. to be added to these docs.
  149. ───────────────────────────────────────────────────────────────────────────────
  150. /***** Un-Installing *********************************************************/
  151. ───────────────────────────────────────────────────────────────────────────────
  152.  
  153.         Remove the AutoFTP subdirectory and all files in it.  
  154.  
  155. ───────────────────────────────────────────────────────────────────────────────
  156. /***** Registration Policy ***************************************************/
  157. ───────────────────────────────────────────────────────────────────────────────
  158.  
  159.        Version 1 of Auto-FTP is freeware.  AutoFTP is copyrighted and I reserve
  160. the right to charge a small fee for future versions.
  161.  
  162. ───────────────────────────────────────────────────────────────────────────────
  163. /***** Problems **************************************************************/
  164. ───────────────────────────────────────────────────────────────────────────────
  165.  
  166.         If you have any problems, questions or suggestions, the best way to
  167. contact me is to send e-mail or netmail to the address listed at the front
  168. of this document.
  169.  
  170. Please send me your feedback and advise on bugs and future enhancements!
  171.  
  172. ───────────────────────────────────────────────────────────────────────────────
  173. /***** Credits ***************************************************************/
  174. ───────────────────────────────────────────────────────────────────────────────
  175.  
  176. First and foremost to Mark Storm for his testing and recommendations.
  177.  
  178. Thanks also to Bjarne Jensen for his fine InJoy dialer.
  179. InJoy - 32bit OS/2 PPP/SLIP Dialer - http://www.fx.dk/injoy/index.html
  180.  
  181. ───────────────────────────────────────────────────────────────────────────────
  182. /***** End Of Documentation **************************************************/
  183. ───────────────────────────────────────────────────────────────────────────────
  184.  
  185. Frequently Asked Questions:
  186.  
  187.  
  188. Q: How do I automate file transfers?
  189.  
  190. A: Here is the quick and dirty:
  191.  
  192. 1) Create the configuration (.cfg) files you need.  This should be fairly
  193.    obvious and I've included sample.cfg to help.  The best way to create
  194.    .cfg files is to type the data into the entry fields and then save them.
  195.    The ".cfg" filename extention is required.
  196.  
  197. 2) Setup your events.  Just type in the time and .cfg filename in the events
  198.    configuration window.  Anything you type here is effective immediately
  199.    and you can leave this window open while AutoFTP runs.  You must click
  200.    on OK for any changed data to be saved.
  201.  
  202. 3) Setup your Dial.CMD and HangUp.CMD files if required.  AutoFTP
  203.    always checks to see if it can ping the remote server.  If you are LAN
  204.    connected then it will start transferring immediately.  If it can't
  205.    ping the remote server then it assumes you use a dialup connect and
  206.    runs Dial.CMD to connect you to the internet.  While this connection
  207.    is taking place AutoFTP waits for the amount of time you set.  Within
  208.    a few seconds of the connection you should see AutoFTP doing its thing.
  209.  
  210. NOTE: I use In-Joy to connect to the internet and Dial.CMD/HangUp.CMD
  211. reflect this.  You can modify these batch files as required.
  212.  
  213. ---
  214.  
  215. Q: I'm not sure I understand the purpose of the .bsy file.  I assume
  216.    it is to be used as a flag file.  My question, does either binkley,
  217.    squish, or AutoFTP need it/use it specifically?  Or do you have
  218.    a suggested place that it can be used.
  219.  
  220. A: If you need it then you know it, if you don't need it then ignor it
  221.    (leave it blank).  Some ftp servers ask that you send a .bsy file
  222.    to let them know when a system is doing a transfer.  It lets the 
  223.    sysop know not to jerk the system offline on you right in the middle
  224.    of a transfer.  PlanetC, for example, does not require this.
  225.  
  226. ---
  227.  
  228. Q: Planet Connect uses your node number instead of a name such as
  229.    trihub.  Can I use 303/100 in the User ID field?
  230.  
  231. A: I also use PlanetC.  I use 366/47 in the User ID field.  Here
  232.    is my PlanetC.cfg:
  233.  
  234. ftp.planetc.com
  235. 366/47
  236. xxxxxx
  237. g:\mailer\outbound
  238. 0e1f0032.?lo
  239. incoming
  240. fdnfiles
  241.  
  242. g:\satelite\fdnfiles
  243.  
  244. REXX parses numbers and characters all the same.  You can put your
  245. fido address in User ID or whatever it takes with no problem.
  246.  
  247. ---
  248.  
  249. Q: What is AutoFTP written in?
  250.  
  251. A: VisPro REXX v3.1 Gold.  AutoFTP needs REXX support installed on
  252.    your system.  It also requires the rxftp.dll to be installed.
  253.  
  254. ---
  255.  
  256. Q: Does Dial.CMD get called after every mail run, or only if fired up from
  257.    the command line with a .cfg parameter?
  258.  
  259. A: Dial.CMD should run anytime AutoFTP can't ping the server you are trying
  260.    to exchange files with.  
  261.  
  262. ---
  263.  
  264. Q: I'd like to run AutoFTP in the background.  In particular I'd like for
  265.    it to just startup in the background.
  266.  
  267. A: I'll explore different ways of doing this as I get time but here is a
  268.    good way to do it:
  269.  
  270.    Select <Options>
  271.    Select <Configuration>
  272.    Set <Size> to 0,0
  273.  
  274.    Things to note:  To shut the program down you will need to click 
  275.    both mouse buttons on the desktop to get a window list.  To change
  276.    or rather, get the window back, you will need to modify lines 3 
  277.    and 4 in AutoFTP.INI to read numbers higher than 0.
  278.  
  279. ---
  280.