home *** CD-ROM | disk | FTP | other *** search
/ Windows News 2006 October / wn148cd2.iso / Windows / Communiquer / AutoFTP / readme.txt < prev   
Text File  |  2006-03-03  |  10KB  |  208 lines
  1. Auto Ftp v2
  2. by Glenn Delahoy
  3. (C) Copyright 2003-2005
  4. All rights reserved
  5.  
  6. Description
  7. -----------
  8. Auto Ftp v2 is the new big brother of the original Auto Ftp. It can perform
  9. multiple ftp sessions simultaneously (fully multi-threaded). You can choose
  10. between straight file copy or synchronisation in either direction (local to
  11. remote or remote to local). Sessions can be started manually, timed, change
  12. triggered or daisy chained. Multiple sessions can be started from the command
  13. line making it a great batch file tool. Now you can have as many upload or
  14. download ftp sessions as you like configured and ready to go with one click.
  15.  
  16. Rather than go into painful detail for the whole application, I'll assume you
  17. can figure out most of it and I'll concentrate on the interesting bits.
  18.  
  19. Session Details
  20. ---------------
  21. Paths                    These can be a directory or a wildcard file spec. If
  22.                          it's a directory, end it with a backslash or forward
  23.                          slash. Note this is slightly different to version 1.
  24.                          Use the Test button on the connection page to test
  25.                          the connection and paths are valid.
  26.                          Copy Files From Local To Remote
  27.                               Local Path can be a directory or file spec
  28.                               Remote Path must be a directory
  29.                          Copy Files From Remote To Local
  30.                               Local Path must be a directory
  31.                               Remote Path can be a directory or file spec
  32.                          Make The Remote The Same As The Local Directory
  33.                               Local Path must be a directory
  34.                               Remote Path must be a directory
  35.                          Make The Local The Same As The Remote Directory
  36.                               Local Path must be a directory
  37.                               Remote Path must be a directory
  38.  
  39. Countdown                Select the number of seconds to countdown prior to
  40.                          starting the session. When the countdown completes,
  41.                          the session begins. When the session is complete, the
  42.                          countdown starts again.
  43.  
  44. Detect Changes           The Wait For countdown starts when a change is detected
  45.                          in a file or directory in the local path. If a new
  46.                          change is detected during the countdown, the countdown
  47.                          is restarted. When the countdown completes, the
  48.                          session begins. When the session is complete, the
  49.                          detect begins again.
  50.  
  51. Chain From               This will force the session to start immediately
  52.                          another session completes. Select one of the other
  53.                          sessions from the drop down list.                         
  54.  
  55. What Happens During The Session
  56.                          You can choose between a straight file copy in either
  57.                          direction or a file synchronisation in either
  58.                          direction.
  59. What Files Are Copied
  60.                          You can choose between only the specified directory or
  61.                          a full recursive operation, including all
  62.                          sub-directories and files.
  63.  
  64. Note that it's possible to trigger a download session using the change trigger.
  65. Why you would want to do this, I'm not sure but maybe you'll find a use for it.                         
  66.  
  67. Synchronisation
  68. ---------------
  69. Synchronisation is performed if you choose either the "Make the remote the same
  70. as the local" or "Make the local the same as the remote" options on the Details
  71. page. Synchronisation can save a lot of time by comparing the files first and
  72. transferring only the ones that have changed.
  73.  
  74. When you "Make the remote the same as the local", the files are compared by
  75. checksum. Checksum detects changes even when the file size or time hasn't
  76. changed. If the stored checksum is different to the checksum of the actual file,
  77. the file is deemed to have changed and will be uploaded. If your remote site is
  78. currently up to date, you can preload the local checksum store so the first sync
  79. operation doesn't try to upload everything.
  80.  
  81. When you "Make the local the same as the remote", the files are compared by the
  82. file's last modified time. As with all downloads, the local copy of the file is
  83. updated with the modified time of the file on the remote. If the time for a
  84. given file on the remote is different to the time for the same file on the
  85. local, the file is deemed to have changed and will be downloaded. The file time
  86. is accurate to within a minute.
  87.  
  88. New directories are created but old directories won't be deleted. This may
  89. change in the future.
  90.  
  91. WARNING : Be very careful! If you have a web site on a remote host like myself,
  92. you're going to have a bunch of folders and files that don't exist on your
  93. local disk. For example, message forums, guestbook, download counters and
  94. various maintenance files. Be very careful of synchronising the root directory
  95. of your web site.
  96.  
  97. *** Backup before you start ***
  98.  
  99. Daisy Chaining Sessions
  100. -----------------------
  101. You can create a complex chain or tree of sessions using the chain option. When
  102. a given session completes, you can trigger one or more sessions to start, you
  103. can string a series of sessions together, one after the other or any
  104. combination.
  105.  
  106. Command Line Options
  107. --------------------
  108. Start a Session
  109. You can automatically start a session from the command line by quoting the
  110. desired session name. For eg., autoftp "mywebsite" will start a session. Either
  111. it will start straight away or the countdown or detection will commence.
  112.  
  113. Start a Session Immediately
  114. You can force a countdown or detect session to start immediately by following it
  115. with the /force option. For eg., autoftp "mywebsite" /force.
  116.  
  117. Start All Sessions
  118. To start all countdown and detect sessions, specify the /start option anywhere
  119. on the command line.
  120.  
  121. Exit When All Sessions Complete
  122. Normally when a countdown or detect session completes, it returns to countdown
  123. or detect mode. In batch files you want to run them once then exit. Do this
  124. using the /exit option. When all specified sessions have completed, AutoFtp
  125. will exit.
  126.  
  127. Start Minimised
  128. If you don't need the application popping up on the screen during command line
  129. operation, add the /hide option to the command line. AutoFtp will appear in
  130. the system tray.
  131.  
  132. Logging
  133. To create a log of the command line session, add the /log command line option.
  134. Logging is done in memory during the session. When AutoFtp exits, it dumps the
  135. log to autoftp.log in the application directory. The log is pretty much what
  136. you see on the screen.
  137.  
  138. For eg:
  139. autoftp "mywebsite" /force "backupftpsite" /force "mynewplace" /exit /hide
  140.  
  141. This example runs the first upload session immediately, the second download
  142. session will also run immediately, the third session will run when it's
  143. countdown completes or the detect kicks in. Only when the third session has
  144. completed will AutoFtp exit. The application will run minimised.
  145.  
  146. Remember that daisy chaining is still active when running from the command line.
  147.  
  148. Skipping Files
  149. --------------
  150. In some cases you want to make exceptions to files that may be transferred or
  151. overwritten. Make use of the Hidden and Read-Only attributes to control this.
  152.  
  153. * Hidden local files and directories are ignored when copying files to
  154.   the remote site
  155.  
  156. * Hidden or Read-Only local files and directories will not be overwritten by
  157.   files downloaded from the remote site
  158.  
  159. * Hidden or Read-Only local files will not be deleted during a synchronisation
  160.  
  161. * Files with the same name as a local directory will not be downloaded
  162.  
  163. NOTE: This is slightly different to version 1.
  164.  
  165. Test / Debug Mode
  166. -----------------
  167. Sometimes it's useful to find out what AutoFtp is going to do before it does it.
  168. You particularly would like to know what files you're going to trash before they
  169. get trashed. Selecting the Test option will cause AutoFtp to go through the
  170. motions of whatever you have configured but it won't actually transfer anything.
  171. Instead it will log intended transfers and show you the results.
  172.  
  173. You should do this for one session at a time, the logging isn't thread safe.
  174.  
  175. CAVEATS
  176. -------
  177. Here's some "gotchyas" I've found in my travels.
  178.  
  179. 1. If AutoFtp seems to be uploading the same files over and over and you know
  180. they haven't changed, it's possible the ftp listing may be getting truncated
  181. by the server. For example, the server on my host caps the ftp listing at
  182. 2000 entries. I have a few directories that contain more than that so AutoFtp
  183. never sees the additional files in the list and thinks they are new. You can
  184. try a wildcard search to reduce the number of entries in the ftp list. Log
  185. on to your ftp site with a regular ftp client and see if there are any
  186. additional messages from the server when you list the directory.
  187.  
  188. 2. AutoFtp has a hard time with mixed case file names. This is not a fault in
  189. the program but one of the potential hazards when moving files between DOS
  190. based systems (Windows) and Unix based systems. For example, if you did a
  191. directory listing of *.jpg on a DOS system you'd get all files with jpg, Jpg,
  192. JPG, jPg etc extensions. If you did the same on a Unix based system, you'd get
  193. files with the jpg extension only. To avoid potential case confusion, it's
  194. best to keep all your file names to lower case.
  195.  
  196. --------------------------------------------------------------------
  197.  
  198. Release Notes
  199. -------------
  200.  
  201. Version 2.00
  202. ------------
  203. 18 October 2005 Official public release
  204.  
  205. Version 2.01
  206. ------------
  207. Change 1: Fixed a couple of small bugs including, hopefully, the abort bug.
  208.