home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / comms_networking / uplhome / !UplHome / !Help < prev    next >
Text File  |  1997-02-07  |  16KB  |  423 lines
  1. !UplHome Version 1.12 07 Feburary  1997 (c) R D Fellows
  2. -------------------------------------------------------
  3.  
  4. Introduction
  5. ============
  6.  
  7. A program to create a script for !TCPIP (ka9q) or freenet ftp to
  8. automatically upload your homepages to a FTP server, for example
  9. demon.homepages.
  10.  
  11. It assumes that you have a local copy of all your pages residing on
  12. your computer. Mine are stored in a directory called:-
  13.   ADFS::IDEDisc4.$.Net.Free.!Deltanet.WWWpages.tilmun
  14. So that I can use DeltaNet to serve my pages to me without being
  15. connected to Demon.
  16.  
  17. My tilmun directory is actually a 5Meg DOSdisc. But could be any of
  18. the following:-
  19.   i) A DOSDisc (All file names upper-case. 8 character file names and 3
  20. character extensions.) Fixed size once created.
  21.  ii) A Spark archive (20 character filenames, mixed case)
  22. iii) A X-files Directory (256 character filenames mixed case). Size is
  23.      variable.
  24.  iv) A normal RISC OS directory (10 character file names including
  25.      "extensions".
  26.  
  27. For all the above options, for conversion to unix file
  28. naming standards the last characters of all files should be "/htm" or
  29. "/html".
  30.  
  31. My preference is for options (i) or (iii) as using (ii) a Spark
  32. archive prevents me from putting any Zip or Spark Archives to down
  33. load in my webspace as !UplHome will happily parse down these as well,
  34. so that you will not upload the archive as a whole but create a
  35. directory and put the contents of the archive in it.
  36.  
  37. I include a sample index/htm file as a starting point to base your Web
  38. site upon as I saw a message in Demon.homepages.authoring asking about
  39. the format of the index.htm file.
  40.  
  41. Features
  42. ========
  43.  
  44. * New for version 1.10 is freenet compatibility. If the Internet module is
  45.   present in memory at run time, a script for the ftp client (0.61) by
  46.   Neil Tarrant (neil@sitex.demon.co.uk) is created and launched in a task
  47.   window.
  48.  
  49. * Also for version 1.10, it now multitasks, so now can be used on line.
  50.   Using the progam under freenet it is recomended that the program is
  51.   run online, as it starts the ftp session in a task window.
  52.  
  53. * Compatible with RiscOS 3.10, 3.60 & 3.70. No other o/s versions available
  54.   for testing. Works on Arm3, Arm610 and StrongArm processors.
  55.  
  56. * Performs translations between RiscOS and unix file extensions and
  57.   'types'.
  58.  
  59.   NOTE: this program will not add .htm/.html/.gif/.jpg onto the
  60.   ends of uploaded files. It expects them to be saved as:-
  61.     dir1.dir2.file/ext
  62.   which will get converted to dir1/dir2/file.ext .
  63.  
  64. * HTML type files will be transferred as ascii, all others as
  65.   binary.
  66.  
  67. * Automatic lower-case all filenames. If this is not what you
  68.   want let me know.
  69.  
  70. * Downloads count.txt to <UplHome$Dir>.WWWpages so that you can see
  71.   what the hit count on your site is doing without incrementing the
  72.   counter yourself.
  73.   
  74. * Using two sets of comment tags, dates within documents can be set
  75.   to 'today' and document version numbers can be incremented.
  76.   !!!!MAKE A BACKUP OF YOUR WEB DIRECTORIES BEFORE USING!!!!.
  77.   Version 1.12 now uses correct comment tags.
  78.  
  79.  
  80.  
  81. Installation for !TCPIP (Ka9q) & Freenet
  82. ========================================
  83.  
  84.  
  85. Copy from Archive and place in same directory as !TCPIP. (Needs to
  86. see TCPIP to work)
  87.  
  88. For freenet the application can be copied anywhere.
  89.  
  90. Double click !UplHome. If it has never been run before it will prompt
  91. for a file name to point to the top of your webspace and several other
  92. questions. NOTE this part of the program does not multitask, so do not
  93. run while online.
  94.  
  95.  
  96.  
  97.  
  98. For Ka9q, edit !TCPIPuser.FTP.Accounts  and add the following
  99. - - - - - - - - - - - - - - - - - - -
  100. demhomep:
  101.   host      homepages.demon.co.uk
  102.   login     {node}
  103.   password  {dempw}
  104.   menu      FTPutil
  105.   source    UplHome
  106. - - - - - - - - - - - - - - - - - - -
  107.  
  108. Edit !TCPIPuser.Menus.FTP and add a new option
  109.  
  110. aftp demhomep
  111.  
  112. Mine looks like this but yours will different
  113. - - - - - - - - - - - - - - - - - - -
  114. Demon,DemonHome,Acorn,Demon
  115. Batch,Src.Doc,Stutgart,Stut/HensaMir,Hensa,Mortimer.cc,Frontios,cslib,NewCslib,gmd.de|Open Downloads|Get an RFC
  116. aftp demon
  117. aftp demhomep
  118. aftp acorn
  119. aftp dembatch dembatch
  120. aftp srcdoc
  121. aftp Stutgart
  122. aftp Stutmir
  123. aftp hensa
  124. aftp Mortimer
  125. aftp Fontios
  126. aftp cslib
  127. aftp dsse
  128. aftp gmd
  129. filer open Downloads
  130. ftp ftp.demon.co.uk \ \ "name: " "anonymous\r\n" "assword: " "{ftpuser}@{host}\r\n" "> " "bin\r\n" "> " "hash 1\r\n" "> " "path auto\r\n" "> " "get /pub/doc/rfc/rfc%0.txt\r\n" "> " "quit\r\n"
  131. - - - - - - - - - - - - - - - - - - -
  132.  
  133.  
  134.  
  135.  
  136. Instructions for Use
  137. ====================
  138.  
  139. The way I have made Uplhome work with both freenet and !Tcpip
  140. is for it to detect the presense of the Internet module in memory. If
  141. the Internet module is found, a freenet script will be created. If the
  142. Internet module is not found, a script for !Tcpip will be created.
  143.  
  144.  
  145.  
  146. !Tcpip (ka9q)
  147. -------------
  148.  
  149. Make all the changes to your web site. See next section on new tags
  150. for version and date stamp management.
  151.  
  152. If the versions flag is set to Yes in the config file,
  153. **************************************************
  154. * MAKE A BACKUP OF YOUR WHOLE WEB DIRECTORY TREE *
  155. **************************************************
  156. If UplHome errors while processing your site it may mangle one or more
  157. of your html documents.
  158.  
  159. Double click on !UplHome. It will parse down your directory tree and
  160. build a script file called !TCPIPUser.Scripts.UplHome for ka9q.
  161.  
  162. If !Tcpip has not been seen by the filer, the script created by Uplhome
  163. will be placed in !UplHome.Scripts. Note that the script in this
  164. directory will not run from the options created above. It assumes
  165. that the script is in !TCPIPUser.Scripts.
  166.  
  167. Only run !UplHome once per upload otherwise the script will contain
  168. no files to upload if no changes have been made to your pages.
  169.  
  170. NOTE: If there are any archive (SparkFS/ArcFS) files in your web space
  171. Uplhome will parse down these as well so quit SparkFS/ArcFS before
  172. running.
  173.  
  174. Connect to the web using TCPIP. ftp to demon homepages as usual and type
  175.     source uplhome
  176.     
  177. The script will then be run.
  178.  
  179. Alternatively use the new ftp option configured above in the
  180. installation instructions.
  181.  
  182. freenet
  183. -------
  184. Follow instalation instructions as per tcpip answering all the
  185. configuration questions. The program needs to know your homepages
  186. user id and password to start the ftp session.
  187.  
  188. New Tags
  189. ========
  190.  
  191. UplHome looks for the following comment tags in any HTML document
  192. modified since the last run:-
  193. <!-- DATE -->   &    <!-- /DATE -->
  194. <!-- VER -->    &    <!-- /VER -->
  195.  
  196. Any text between the two DATE tags will be replaced with the date.
  197. Any text between the two VER tags will be read and 0.01 will be 
  198. added. So given the following example page section:-
  199.  
  200. - - - - - - - - - - - - - - - - - - -
  201. <ADDRESS>
  202.         Last modified: <!-- DATE -->24 October 1996<!-- /DATE --><BR>
  203.         Document Version: <!-- VER -->1.07<!-- /VER --><BR>
  204.         Author: <A HREF="mailto:webmaster@tilmun.demon.co.uk">webmaster@tilmun.demon.co.uk</A><BR>
  205.         Mail: <A HREF="mailto:webmaster@tilmun.demon.co.uk">webmaster@tilmun.demon.co.uk</A>
  206. </ADDRESS>
  207. - - - - - - - - - - - - - - - - - - -
  208.  
  209. Would be converted to (Assuming todays date is 26 October):-
  210.  
  211. - - - - - - - - - - - - - - - - - - -
  212. <ADDRESS>
  213.         Last modified: <!-- DATE -->26 October 1996<!-- /DATE --><BR>
  214.         Document Version: <!-- VER -->1.08<!-- /VER --><BR>
  215.         Author: <A HREF="mailto:webmaster@tilmun.demon.co.uk">webmaster@tilmun.demon.co.uk</A><BR>
  216.         Mail: <A HREF="mailto:webmaster@tilmun.demon.co.uk">webmaster@tilmun.demon.co.uk</A>
  217. </ADDRESS>
  218. - - - - - - - - - - - - - - - - - - -
  219.  
  220. Currently both tag pairs must be on the same line. If the comment tags are
  221. not shown exactly as shown above no action on the file will be taken.
  222.  
  223. How does it know what has changed
  224. =================================
  225. In the !UplHome directory there will be a file called Config. This is
  226. updated each time UplHome is run. The program checks for file 
  227. timestamps older than the last_time date.
  228.  
  229. So only run !UplHome once, just before connecting to demon.
  230.  
  231.  
  232. The Config file
  233. ===============
  234.  
  235. The file !UplHome.Config holds the configuration for Uplhome.
  236. It is a plain text file and can be edited with Edit, StrongED, or
  237. Zap. All the lines starting with a # are comments. Do not change
  238. the case of any of the words before the equals signs otherwise
  239. UplHome will not read in the correct configuration. If any of the
  240. options are left blank, you will be prompted for them at run time.
  241.  
  242. NOTE: the configuration questions section does not multitask, so will
  243. hang your network connection if you attempt to run this program
  244. online.
  245.  
  246. - - - - - - - - - - - - - - - - - - -
  247. # !UplHome.Config
  248. # ===============
  249. #
  250. # Edit following line to point to root of your webspace
  251. # e.g.
  252. # root=ADFS::IDEDisc4.$.Net.Free.!Deltanet.WWWpages.tilmun
  253. #
  254. root=ADFS::HardDisc4.$.Net.Free.!Deltanet.WWWpages.tilmun
  255. #
  256. #
  257. # last_time shows the time the UplHome was last run.
  258. # It takes the form YYYYMMDDHHMMSS
  259. last_time=19961026224001
  260. #
  261. #
  262. # Download Page count? Yes or No
  263. count=Yes
  264. #
  265. # Path to where count.txt will be written to if enabled
  266. # with the above command. Needs a trailing .
  267. # e.g. count_to="ADFS::HardDisc4.$.Net.!UplHome.WWWPages."
  268. count_to=<UplHome$Dir>.WWWpages.
  269. #
  270. #
  271. #
  272. # Download structure of site to a file
  273. structure=Yes
  274. #
  275. # versions set to Yes will automatically update date stamps
  276. # and document version numbers. Set to No it will not make
  277. # any chages to your documents.
  278. versions=Yes
  279. #
  280. # Display script after creation, and before execution
  281. display=Yes
  282. #
  283. #
  284. # When running under freenet the following information
  285. # is required.
  286. # Name of ftp server to uplad files too. e.g. homepages.demon.co.uk
  287. host_server=homepages.demon.co.uk
  288. # Your ftp account name. For demon this is the node name
  289. node={Your node name here}
  290. # Your ftp account password.
  291. pass={Your password here}
  292. # server_root is where pages will be uploaded to on the
  293. # host server. If the directory where you log in to is
  294. # the root then this entry must me set to "."
  295. # It will be cd'd to
  296. # at the start of the ftp session.
  297. server_root={where you want your pages put}
  298. - - - - - - - - - - - - - - - - - - -
  299.  
  300.  
  301. Legal Declaration
  302. =================
  303.  
  304. In the legal declaration below, "This Product" is defined to be all the
  305. files within the original archive (ie. not just !UplHome, it includes any
  306. support applications bundled with it), excluding those provided by other
  307. contributing authors.
  308.  
  309. "the author" is Roy D Fellows (roy@tilmun.demon.co.uk)
  310.  
  311. "contributing authors" refers to the authors of any other software
  312. which is included in the archive.
  313.  
  314. Copyright of the product remains with the author.  Copyright of anything else
  315. in the archive remains with the contributing authors.  The Terms regarding
  316. this product given in this file may be taken to also apply to the software of
  317. the contributing authors, except where an alternative set of Terms for that
  318. software is supplied, in which case the contributing author's Terms augment
  319. those in this file.  In case of conflict, the contributing authors' terms
  320. prevail.  The contributing authors' terms may be found in files called
  321. <initials>_Terms where initials are the contributing author's initials.
  322.  
  323. In particular, DrawFile, Toolbox, Window, ColourDbox, IconBar, ProgInfo,
  324. Menu, SaveAs, !System, !SysMerge and !Scrap are copyright of Acorn Computers
  325. Ltd.
  326.  
  327. This version of this product is 'freeware'.  My definition of 'freeware': 
  328. This means that the author retains copyright over the product, and the
  329. contributing authors retain copyright over their portions, but allow
  330. unlimited distribution except:
  331.  
  332.  
  333.    i) No charge must be made (except for a nominal fee for distribution media)
  334.   ii) This Product must be distributed as a complete package
  335.  iii) This Product may not be distributed as part of a non-free
  336.       [free as in (i)] package (of any kind, magazine/hardware/software)
  337.       without prior written consent from the author and from the contributing
  338.       authors.
  339.   iv) During further redistribution, it must be made clear to the recipient
  340.       that no remote fetching tools are included in the archive, unless such
  341.       tools have been added by the redistributor.  It must also be made clear
  342.       that these fetching tools are not part of the original distribution.
  343.    v) If any further distribution occurs compliant with all of the above,
  344.       credit must be clearly given to the author and the contributing authors.
  345.   vi) Redistribution must not infringe any of the contributing authors terms
  346.       and conditions.
  347.  
  348. This version may be freely uploaded to FTP sites, provided all the above
  349. conditions are met, and all the conditions in the section below regarding
  350. FTP uploads are met.
  351.  
  352. No liability whatsoever is accepted by the author, or the contributing
  353. authors, of this product for losses or damage of any kind at all arising, or
  354. allegedly arising, from the use, or misuse, of This Product.  You are hereby
  355. warned that any costs incurred through the use of this package over a
  356. non-free networking medium are the sole responsibility of the user.
  357.  
  358. The author, and the contributing authors, do not guarantee the functionality
  359. of the package, and does not guarantee to fix any reported bugs, although the
  360. author will investigate bug reports and may release new versions.
  361.  
  362.  
  363. Version History
  364. ===============
  365.  
  366. 1.00    Works!
  367. 1.02    Reads last time from text file. Debug info removed.
  368. 1.03    Config file added to hold time and server root location.
  369. 1.04    Retreives count.txt so you can see how many hits your pages has received.
  370.     Also does an ls -lR to file "structure" so you know what files have been
  371.     uploaded.
  372.     Also Changed mode on hi-res sprite as it was created in a non standard
  373.     mode number.
  374. 1.05    !Boot file added to make sure UplHome$Dir is defined.
  375. 1.06    Config option to disable/enable auto downloading of count.txt
  376. 1.07    Config option to change time stamps in html files to runtime date.
  377. 1.08    Fixed small syntax error and removed some spaces.
  378. 1.09    Fixed ignoring of state of "versions" parameter in config file.
  379. 1.10    Made 'slightly' multitasking and freenet compatible, thanks to a 
  380.         suggestion from Theo Markettos. Also config
  381.     file is copied to config2 in case Uplhome dies while writing the updated
  382.     version. If this happend just copy config2 to config.
  383. 1.11    Credits go to Robin N Moffatt for some more sugestions:-
  384.          + Configurable fetching of dir structure
  385.          + Configurable displaying of finished script
  386.          + Configurable path to fetch count.txt to
  387.         And Julian Wright:-
  388.          + Spotting that 1.10 only connects to demon whatever the config file says.
  389.          + Configurable server root to upload pages to. e.g. "~/public_html/".
  390.          + Acorn internet compatibility by detecting a module called Internet 
  391.            instead of Freenet.
  392. 1.12    Fixed date and time tags to be syntaxtically correct.
  393.         Program will now autodetect old style <!-- --!>
  394.         comment tags and replace them with <!-- -->. 
  395.  
  396.  
  397. Future Changes
  398. ==============
  399. 1) Testing with sFTP 0.21 by Carol Carpenter <techcc@barncoll.demon.co.uk>
  400.    ftp://ftp.barnet.ac.uk/pub/Acorn/sftp/
  401. 2) duno! You tell me...
  402.  
  403.  
  404.  
  405. Credits
  406. =======
  407. I would like to thank Theo Markettos for sending me a version of UplHome that
  408. uses freenet. Robin N Moffatt and Julian Wright have also been helpful for
  409. this version in sending lists of things to fix and code to fix them.
  410.  
  411. David Dempster, for telling me he finds UplHome *VERY* useful and telling me
  412. I've been using the wrong comment tags for the date and version options.
  413.  
  414. I also like to thank the nine other happy users that have clicked the
  415. register button on my www page. By 'happy' I mean that they have not
  416. complained that the program does not work..... yet.
  417.  
  418.  
  419.  
  420. Roy Fellows 07/02/97
  421. Roy@tilmun.demon.co.uk
  422. http://www.tilmun.demon.co.uk/
  423. User 268 on Arcade BBS (0181 655 4412)