home *** CD-ROM | disk | FTP | other *** search
/ Magazyn Enter 1999 March / enter_03_1999_1.iso / OS2 / TEMPL / TTON.DOC / TTON.CFG < prev    next >
Text File  |  1998-01-17  |  20KB  |  418 lines
  1. # *************************************************************
  2. #  Templeton, copyright 1995-1998 N.A. Krawetz
  3. #  All rights reserved.
  4. # *************************************************************
  5.  
  6. # configuration for Templeton
  7. #
  8. # Lines beginning with a '#' are comments and are ignored.
  9. # Lines should not be more than 80 characters.
  10. # Operands in this file are in the form:
  11. #    parameter value
  12. # The parameter is case insensitive, except where a text string or URL
  13. # is required.
  14. # Boolean values ("true" or "false") are case insensitive.
  15. # Numeric values should be numbers -- non-numbers are regarded as 0.
  16. # All other types of values ARE case sensitive.
  17.  
  18.  
  19. # ******************** Registration ****************************
  20. # Register: registration code
  21. # Software that is registered contains a unique registration
  22. # code.  This code should be entered exactly as it is provided.
  23. # If your site contains multiple registrations, you may list
  24. # each registration code on a line starting with the
  25. # key word "Register".
  26. # Please read the licensing agreement for registration
  27. # information.
  28. #   Register 12-34567-891011
  29.  
  30.  
  31. # ******************* File System *****************************
  32. # LocalPath: absolute path
  33. # LocalPath informs the program where to store the downloaded files.
  34. # IF this path is:
  35. #   LocalPath none
  36. # THEN no files are generated.  Only a log file containing the remote
  37. # servers WWW map is created in the current directory.
  38. #
  39. # Currently, files should be stored in the root directory of the file system.
  40. # For WWW servers, this is the server's root directory.
  41. # (This limitation will be removed in future releases.)
  42. # For DOS based machines, this path may include a drive letter:
  43. #   LocalPath e:\server.www\
  44. #
  45. # Either slash "/" or backslash "\" are valid for specifying a directory.
  46. # The trailing slash or backslash is optional.
  47. #
  48. # This option is only used when the "Interactive" option is FALSE.
  49. LocalPath /
  50.  
  51. # FATFormat: boolean
  52. # Determines the filename format for the current operating system.
  53. # DOS based machines using drives formatted with a File Allocation Table (FAT)
  54. # can only handle filenames containing 8 characters and a 3 character
  55. # extension.  Setting this option to TRUE will generate 8.3 character file
  56. # names.  The default is FALSE, and will generate unlimited length filenames.
  57. # NOTE: Under DOS, this option is always TRUE (DOS only supports FAT file
  58. # names).  Under OS/2, this value becomes TRUE automatically if the destination
  59. # path (LocalPath) is located on a FAT partition.
  60. FATFormat FALSE
  61.  
  62. # User: e-mail address
  63. # In case of emergency, this is the person who is running the program
  64. # and who should be contacted to stop the program from running.
  65. # This MUST be a valid e-mail address, and SHOULD also be available with
  66. # a "talk" command.
  67. # As a side note, it is never a good idea to let automatic software run
  68. # unsupervised (especially this type of software).  The "User" should be
  69. # available to read their e-mail at all times during the execution of this
  70. # program.
  71. # The default is the account running the program on the current machine.
  72. #  User webmaster@host.machine.org
  73.  
  74.  
  75. # ********************* Network *****************************
  76.  
  77. # DNSLookup: boolean
  78. # A single machine may be refered by many hostnames.  For example, "www",
  79. # "www.crumple.com", and "paper.crumple.com" are all the same webserver.
  80. # When DNSLookup is TRUE, Templeton will correctly identify these different
  81. # hostnames are the same machine.  When DNSLookup is FALSE, each of these
  82. # hostnames are treated as different hosts.  The DNS (domain name service)
  83. # may take time to resolve a hostname (up to 2 minutes) so setting DNSLookup
  84. # to FALSE can dramatically increase Templeton's speed, especially when
  85. # processing HTML documents with many links to other machines.
  86. # The default setting is TRUE.
  87. #  DNSLookup TRUE
  88.  
  89. # ProxyHost: hostname or IP address
  90. # Proxy agents are machines that act as a gateway through a firewall.
  91. # If your local network uses a proxy agent, specify the name of
  92. # the proxy agent here.  If you are uncertain about your network, consult your
  93. # network manager or provider.
  94. # A proxy server is only used when a server is specified.
  95. #  ProxyHost    proxyhost.network.net
  96.  
  97. # ProxyPort: integer
  98. # When using a proxy server (see ProxyHost), the port on the proxy server
  99. # should be specified.  The default port is 80.  This value is not
  100. # used if no proxy host is specified with ProxyHost.
  101. ProxyPort    80
  102.  
  103. # Spoof: text-string
  104. # Some WWW servers make incorrect assumptions about the browser/robots.  (Most
  105. # of these are the Netscape servers.)  These servers assume that, since the
  106. # browser is not "Netscape" the browser cannot handle the HTML documents and
  107. # therefore, the document is not transfered.  By "spoofing" a different name,
  108. # the WWW robot can use a qualified browser name to retrieve the HTML
  109. # document.  
  110. # NOTE: The first word of the spoof-name is used for restrictions when 
  111. # robot exclusion is honored (see Exclusion).  This means, if Templeton tells
  112. # the WWW server that it is "Netscape" and the server does not permit
  113. # Netscape browsers, then the server will also not permit Templeton.
  114. # Common spoof names (and browsers) are:
  115. #   Mozilla    (Netscape Browser)
  116. #   WebCrawler    (WebCrawler robot)
  117. #   InfoSeek    (InfoSeek robot)
  118. #   WebExplorer (IBM WebExplorer for OS/2)
  119. #   Harvest    (a web robot)
  120. #   Mosaic    (NCSA Mosaic)
  121. #   Lynx    (Lynx, text browser)
  122. #   Microsoft Internet Explorer
  123. #   PRODIGY-WB    (Prodigy browser)
  124. # Spoof Mozilla (Templeton)
  125.  
  126.  
  127. # ********************* Restrictions *****************************
  128.  
  129. # RestrictHost: boolean
  130. # This parameter informs the program not to leave the designated host.  Links
  131. # to machines not on the current host are not traversed.
  132. RestrictHost TRUE
  133.  
  134. # RestrictPath: absolute path
  135. # This parameter is only used when a host is restricted.
  136. # When a host is restricted, a subpath on that host may also be restricted.
  137. # Hypertext references to documents outside this subtree are not traversed.
  138. # Either slash "/" or backslash "\" are valid for specifying a directory.
  139. # The trailing slash or backslash is optional.
  140. RestrictPath /
  141.  
  142. # RestrictDepth: numeric value
  143. # Hyperlinks are travered in a breadth-first search.  An unrestricted search
  144. # may download an entire WWW server's data.  By restricting the depth,
  145. # only immediate portions of the server will be received.
  146. # Images and non-href links are considered to be at the same depth as the
  147. # document.
  148. # A restricted depth of 0 means no restriction.
  149. # The default is 1
  150. RestrictDepth 1
  151.  
  152. # RestrictImages: boolean
  153. # Most HTML documents contain both text and graphics.  Frequently, these
  154. # graphics come from links to other computers.  When restricting to a specific
  155. # host, these images would not be retrieved (not on the host).  Setting
  156. # RestrictImages to FALSE allows inline graphics and image maps to be located
  157. # on a remote host, but will not affect restrictions to hyperlinks.
  158. # Setting the value to TRUE will apply all restrictions to all files
  159. # (images, text, etc.).
  160. # This option is available for people who want to mirror entire web documents,
  161. # not just sites.  The default value is FALSE, indicating that entire
  162. # documents *should* be retrieved.
  163. # Note: images and image maps restricted by the Deny configuration option
  164. # or by robot exclusion are not retrieved.
  165.  
  166. # RemoveRestricted: boolean
  167. # This parameter informs the program to remove untraversed links.  Links to
  168. # restricted machines or restricted depths are removed from the HTML file,
  169. # but the visible test is still available (just not a hyperlink).
  170. # The default value is FALSE.
  171. RemoveRestricted FALSE
  172.  
  173. # RestrictDuration: HH:MM
  174. # Templeton can run for hours or days.  You can specify a runtime duration
  175. # by entering the maximum number of hours (HH) and minutes (MM).
  176. # The number of hours does not need to be restricted to a 24-hour period.
  177. # Entering 0:0 disables this option.  The default value is 0:0.
  178. #  RestrictDuration 2:30
  179.  
  180. # RestrictStopTime: HH:MM
  181. # Templeton can run for hours or days.  You can specify a specific stoptime
  182. # by entering the hour (HH) and minute (MM).  Times are provided in military
  183. # notation, where 1PM is 13:00, etc.  This option only works over a 24-hour
  184. # period.  Midnight is 24:00, but 1 minute after midnight is 00:01.  Invalid
  185. # times, such as 28:00, are ignored.  Specifying 0:0 (the default value),
  186. # disables this option.
  187.  
  188. # Add: URL
  189. # Place a specific URL on the list of URLs to process.
  190. # Be aware that restrictions apply.
  191.  
  192. # Exclusion: boolean
  193. # This parameter determines whether Templeton will support server provided
  194. # robot exclusion files (robots.txt).  Many servers maintain exclusion files
  195. # to prevent robots from wandering around virtual directory trees, from
  196. # retrieving very temporary or uncomplete files, or copyright materials.  It
  197. # is considered "polite" for web agents to obey the exclusion files when they
  198. # exist.  The default value, TRUE, means that robot exclusion files are obeyed.
  199. # Setting Exclusion to FALSE will ignore robot exclusion files.
  200. Exclusion TRUE
  201.  
  202. # Deny: URL
  203. # The URL provided, as well as all subtrees or the URL, are not processed.
  204. # Many times specific directory subtrees are not desirable.  You can deny
  205. # retrieval of these URL's using this setting.
  206. # For example, to NOT retrieve the "archive" subtree of the host loco.com,
  207. # you would specify:
  208. #   Deny http://loco.com/archive/
  209. # If you do not include the trailing slash (http://loco.com/archive) then
  210. # all subdirectories beginning with "archive" are not processed.  This
  211. # includes "archive.1", "archive.old", "archive_from_1994", etc.
  212. # Deny statements may also include a '*' as a wild character.  This
  213. # symbol represents 0 or more characters for matching.  If, for example,
  214. # you do not wish to retrieve GIF files, you would use:
  215. #   Deny *.gif
  216. # Multiple Deny statements may be specified.
  217.  
  218. # Allow: URL
  219. # Similar to "Deny", "Allow" explicitly specifies that a subtree is
  220. # retrievable.  When used in conjunction with Deny URL, branches of a
  221. # subtree may be specified for access, while other subtrees are ignored.
  222. # Multiple Allow statements may be specified.
  223.  
  224. # Authorize: "realm" base64-code
  225. # This complex command allows you to specify a username and password
  226. # for basic WWW-authentication.  The realm is a quoted string.
  227. # The base64-code contains the encoded username and password.  Use
  228. # the pwd64.exe program to generate your base64-code.
  229. # The realm is a case-sensitive string provided by the WWW server. If you
  230. # do not know the realm for the pages you wish to retrieve, use Templeton
  231. # to interactively retrieve the page.  Templeton will display the realm
  232. # name and ask for your username and password.
  233. # Be aware that realms are not unique.  If different documents use the
  234. # same realm but require different passwords, Templeton will require
  235. # you to enter the username and password.
  236. # To skip a realm, use the username "-" and password "-", or the
  237. # base64-code: LTot
  238. #  Authorize "Secret Password" ZHIubmVhbDpyZWdpc3RlciBtZQ==
  239.  
  240. # Proxy-Authorize: "realm" base64-code
  241. # Similar to "Authorize", this complex command allows you to specify a
  242. # realm and password for a secure HTTP proxy server.
  243. #  Proxy-Authorize "Secret Password" ZHIubmVhbDpyZWdpc3RlciBtZQ==
  244.  
  245. # Sleep: numeric
  246. # Sleep determines the number of seconds to pause before sending a request to
  247. # a WWW server.  SLEEP IS IMPORTANT.
  248. # Warning: Templeton can generate thousands of requests per minute.  Many 
  249. # WWW servers cannot handle a sudden onslaught of requests.  Setting the
  250. # Sleep parameter to 0 (zero) may generate too many requests for the server
  251. # and kill the server.  This is bad.
  252. # A sleep setting of 0 (zero) is known to kill the following types of servers:
  253. #   All WWW servers that run under Microsoft Windows (TM)
  254. #   Old generation (HTML/1.0) CERN servers on all platforms
  255. # Low sleep values may also generate large amounts of network traffic and
  256. # hog network resources.
  257. # For safety, you should set the sleep interval to at least 5 seconds.
  258. # The longer, the better.  Remember, this program is automated and can
  259. # easily run for hours.  What's the rush?
  260. Sleep 10
  261.  
  262.  
  263. # ********************* Preferences *****************************
  264.  
  265. # FileOverwrite: boolean or "modified"
  266. # Files that already exist on the local system are normally overwritten.
  267. # Setting the FileOverwrite option to FALSE will not overwrite files on the
  268. # local file system.  Setting the FileOverwrite option to "Modified"
  269. # (no quotes) will only retrieve documents (non-HTML) that have been changed
  270. # since the last retrieval.  The modified option is useful when retrieving
  271. # the same URL multiple times; modified will not waste time retrieving GIF
  272. # and JPG files that have already been retrieved.
  273. # FileOverwrite does NOT effect HTML documents -- HTML documents are always
  274. # retrieved.  Templeton can only determine links by retrieving HTML documents.
  275. # Skipping an HTML document would mean skipping possible links.
  276. # Default value is MODIFIED, only retrieving newer non-HTML files.
  277. FileOverwrite modified
  278.  
  279. # Index: filename
  280. # For hypertext references that only specify a directory, this is the
  281. # default html file in the directory.
  282. # NOTE: if FATFormat is TRUE, the 8.3 name translation will be applied to
  283. # this filename.
  284. # The default name is "index.html"
  285. Index index.html
  286.  
  287. # ISMAP: absolute path to executable
  288. # For WWW servers, many imagemaps use a program that takes coordinates from
  289. # a selected image <IMG SRC=... ISMAP> and return a new URL.  Some of the
  290. # more common methods use a data file containing known coordinates and a
  291. # program to identify which URL is activated.  Commonly, this program is
  292. # called "imagemap" or "imagemap.exe".
  293. # The ISMAP parameter specifies the WWW server's path to the imagemap program.
  294. ISMAP /cgi-bin/imagemap
  295.  
  296. # MapType: NCSA or CERN
  297. # For the executable specified in the ISMAP parameter (see above), this
  298. # option determines the format of the file.  If the image map file can be
  299. # retrieved, then it is converted into this specified format.
  300. # Valid options are either "CERN" or "NCSA".  The default is NCSA.
  301. MapType NCSA
  302.  
  303.  
  304. # ********************* Logging *****************************
  305. # Mailto-File: filename
  306. # Similar to "Server-File" logging, the filename listed on the "Mailto-File"
  307. # line contains a list of e-mail addresses found in the HTML documents.  Only
  308. # e-mail addresses that are active (hyperlinks) are used.  E-mail addresses
  309. # displayed as plain text in the document or contained in CGI scripts are not
  310. # listed in the mailto logfile.
  311. # NOTE:  This list MAY contain duplicate entries.  Duplication removal may be
  312. # added in later versions.
  313. # (Some people have found this to be a very useful feature for generating
  314. # mailing lists.)
  315. # Setting the filename to "none" disables logging.
  316. # The default is no mailto logging.
  317. # Mailto-File mailtolist
  318.  
  319. # RemoteMapping: boolean
  320. # Determines whether remote mapping will be done.  The default is TRUE
  321. # while does perform mapping.  The map filename is mapindex.html and is
  322. # either located at the root of the LocalPath or in the current directory
  323. # if the system is not mirroring files.
  324. # Note: if you change the default index name, for example, to "welcome.html"
  325. # then the default map file will be "mapwelcome.html".
  326. RemoteMapping TRUE
  327.  
  328. # Server-File: filename
  329. # A data file is generated containing the host name, IP address, and
  330. # WWW server type for each server visited.  For servers listed as IP
  331. # address only, the host name is also the IP address.
  332. # Setting the filename to "none" disables logging.
  333. # The default is no server logging.
  334. # Server-File serverlist
  335.  
  336. # Update-File: filename
  337. # The update file list is useful for downloading only files which have been
  338. # modified.  Although the option "FileOverwrite modified" will update
  339. # newer images, it does not work with HTML documents.  The Update-File
  340. # option is useful for refreshing HTML documents as well as images.
  341. # To use the saved update-file, include the file name on the command line.
  342. # Setting the filename to "none" disables the update file.
  343. # The default is "none".
  344.  
  345. # ********************* Advanced *****************************
  346. # The advanced configuration commands should be used with caution.
  347. # These commands allow other applications to perform tasks on the
  348. # retrieved documents.  Applications that are spawned (operate
  349. # concurrently) with Templeton may overwhelm the user or operating system.
  350. # Spawned applicatons include those begun with "start" under OS/2,
  351. # or followed by "&" under Unix.
  352. # NOTE: Templeton has the capability to spawn thousands of applications
  353. # in a few seconds.
  354. # On Unix-type systems, Templeton introduces security risks when executed
  355. # as root.
  356. # For applications that are not spawned, Templeton will pause until
  357. # the application has ended.  This allows for a guarenteed order of processing
  358. # for the called applications.
  359.  
  360. # Command_html: string
  361. # Command_image: string
  362. # Command_map: string
  363. # Command_default: string
  364. # Execute a system command on each document stored on the file system.
  365. # The different command types are for HTML documents, images, map files,
  366. # or the default command when any of the other commands are not set.
  367. # This are useful for counting documents, storing statistics, printing,
  368. # converting, etc.
  369. # The string "none" turns off these commands.  This default is "none".
  370. # The command string will replace special characters with desired information:
  371. #  characters:   becomes:
  372. #    %d    depth
  373. #    %h      host (server)
  374. #    %p    remote parent URL (first URL containing a link to this URL)
  375. #    %P    local parent file (first file containing a link to this URL)
  376. #    %l      local file
  377. #    %n    current time in GMT (see %t)
  378. #    %N    current time in local time (see %T)
  379. #    %r      remote file (URL without server)
  380. #    %s      saved file (same as %l)
  381. #    %t    file timestamp (RFC 822 format) in GMT
  382. #    %t{rfc822}    file timestamp in RFC 822 format
  383. #    %t{rfc850}    file timestamp in RFC 850 format
  384. #    %t{ansi-c}    file timestamp in ANSI C format
  385. #    %t{iso8601}    file timestamp in ISO 8601 format
  386. #    %t{iso8601c}    file timestamp in ISO 8601 compressed format
  387. #    %T    similar to %t, but times provided in local time
  388. #    %u      url
  389. #    %%      %
  390. # The special characters ARE case sensitive.
  391. # NOTE: Command_image and Command_default do not distinguish between
  392. #   different file formats.
  393. # Example: to convert all HTML documents to text using the program
  394. # html2txt (not provided with the Templeton distribution), you would use:
  395. #   Command_html html2txt %s
  396.  
  397. # Command_url: string
  398. # Similar to Command_html, this command line string is executed by *every*
  399. # URL found.  This includes other protocols such as "ftp://", "gopher://"
  400. # and "mailto:".  No effort is made toward uniqueness; the same URL may be
  401. # seen hundreds of times.
  402. # Because this command is processed each and every time a URL is found, it may
  403. # significantly slow the runtime performance of Templeton.
  404. # The string "none" turns off this command.  The default is "none".
  405. # This command replaces the same characters as Command_html, except for
  406. # %l and %s; the local filename is unavailable.
  407. # The time formats, %t and %T, show the time the URL was found by Templeton,
  408. # *not* the timestamp of the file.
  409. # The execution of the Command_url string does not effect the execution of
  410. # the Command_html, Command_image, Command_map, or Command_default strings.
  411.  
  412. # Interactive: boolean
  413. # Determines whether the user should be prompted for
  414. # configuration information or if Templeton should
  415. # start running automatically.
  416. # The default setting is TRUE.
  417.  
  418.