开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Internet/网络编程 > 浏览器 > 查看源码
README.CONF
资源名称：wwwoffle-2.5e.tgz　[点击查看]
上传用户：seven77cht
上传日期：2007-01-04
资源大小：486k
文件大小：25k
源码类别：

浏览器

开发平台：

Unix_Linux

README.CONF：源码内容
  1.           WWWOFFLE - World Wide Web Offline Explorer - Version 2.5
  2.           ========================================================
  5. If you are upgrading from version 1.x to version 2.x then you should read the
  6. file CHANGES.CONF which explains how to convert the sections in your existing
  7. wwwoffle.conf file to the new format.
  9. If you are upgrading from version 2.x to this version then the file CHANGES.CONF
  10. shows the new options.
  13. The configuration file (wwwoffle.conf) specifies all of the parameters that
  14. control the operation of the proxy server.  The file is split into sections each
  15. containing a series of parameters as described below.
  17. The file is split into sections, each of which can be empty or contain one or
  18. more lines of configuration information.  The sections are named and the order
  19. that they appear in the file is not important.
  21. The general format of each of the sections is the same.  The name of the section
  22. is on a line by itself to mark the start.  The contents of the section are
  23. enclosed between a pair of lines containing the '{' and '}' characters or '['
  24. and ']' characters.  When the '{' and '}' characters are used the lines between
  25. contain configuration information.  When the '[' and ']' characters are used the
  26. there must only be a single non-empty line between them that contains the name
  27. of a file (in the same directory) containing the configuration information.
  29. Comments are marked by a '#' character at the start of the line and blank lines
  30. are also allowed, both are ignored.
  33. StartUp
  34. -------
  36. This contains the parameters that are used when the program starts, changes to
  37. these are ignored if the configuration file is re-read while the program is
  38. running.
  40. http-port         = <port>          ; An integer specifying the port for the
  41.                                       HTTP proxy (default=8080).
  42. wwwoffle-port     = <port>          ; An integer specifying the port for
  43.                                       WWWOFFLE control connections
  44.                                       (default=8081).
  45. spool-dir         = <dir>           ; The name of the spool directory
  46.                                       (default=/var/spool/wwwoffle).
  47. run-uid           = <user> | <uid>  ; The username or numeric uid to run the
  48.                                       wwwoffled server as (default=none).
  49. run-gid           = <group> | <gid> ; The groupname or numeric gid to run the
  50.                                       wwwoffled server as (default=none).
  51. use-syslog        = yes | no        ; Whether to use the syslog facility for
  52.                                       messages (default=yes).
  53. password          = <word>          ; The password used for authentication of
  54.                                       the control message (default=none).
  55. max-servers       = <integer>       ; The maximum number of server processes
  56.                                       that are started (default=8).
  57. max-fetch-servers = <integer>       ; The maximum number of server processes
  58.                                       that are started to fetch pages that
  59.                                       were marked in offline mode (default=4).
  60. dir-perm          = <octal int>     ; The permissions to use when creating
  61.                                       spool directories (default=0755).
  62. file-perm         = <octal int>     ; The permissions to use when creating
  63.                                       spool files (default=0644).
  64. run-online        = <filename>      ; The name of a program to run when switched
  65.                                       to online mode (default=none).
  66. run-offline       = <filename>      ; The name of a program to run when switched
  67.                                       to offline mode (default=none).
  68. run-autodial      = <filename>      ; The name of a program to run when switched
  69.                                       to autodial mode (default=none).
  71. Notes: For the password to work the configuration file must be set so that only
  72.        authorised users can read it.
  73.      : The run-uid/run-gid options are not applicable to win32 (Win95/98).
  74.      : To use the run-uid/run-gid options the server must be started as root.
  75.      : The max-fetch-servers value must be less than max-servers or you will
  76.        not be able to use WWWOFFLE interactively online while fetching.
  77.      : The dir-perm and file-perm options override the umask settings and must
  78.        be in octal starting with a '0' character.
  79.      : The programs run using the run-online, run-offline and run-autodial
  80.        options are started with a single parameter set to the current mode.
  82. Options
  83. -------
  85. Options that control how the program works.
  87. log-level           = debug | info | important | warning | fatal
  88.                                ; Log messages with this or higher priority
  89.                                  (default=important).
  90. index-latest-days   = <age>    ; The number of days to display in the index of
  91.                                  the latest pages (default=7 days).
  92. request-changed     = <time>   ; While online pages will only be fetched if the
  93.                                  cached version is older than this specified
  94.                                  time in seconds (default=600).
  95. request-changed-once= yes | no ; While online pages will only be fetched if the
  96.                                  cached version has not already been fetched
  97.                                  once this session (default=yes).
  98. request-expired     = yes | no ; While online pages that have expired will
  99.                                  always be requested again (default=no). 
  100. request-no-cache    = yes | no ; While online pages that ask not to be cached
  101.                                  will always be requested again (default=no).
  102. pragma-no-cache     = yes | no ; Whether to request a new copy of a page if the
  103.                                  request from the browser has 'Pragma: no-cache'
  104.                                  (default=yes).
  105. confirm-requests    = yes | no ; Whether to return a page requiring user
  106.                                  confirmation instead of automatically recording
  107.                                  requests made while offline (default=no).
  108. connect-timeout     = <time>   ; The time in seconds that WWWOFFLE will wait for
  109.                                  the socket connection to be made (default=30).
  110. socket-timeout      = <time>   ; The time in seconds that WWWOFFLE will wait for
  111.                                  data before giving up on a socket connection
  112.                                  (default=120).
  113. connect-retry       = yes | no ; If a connection cannot be made to a remote
  114.                                  server then try again after a short delay
  115.                                  (default=no).
  116. ssl-allow-port      = <integer>; A port number that can be used for Secure
  117.                                  Socket Layer (SSL) connections, e.g. https.
  118. no-lasttime-index   = yes | no;  Disables creation of the lasttime/prevtime
  119.                                  indexes (default=no).
  120. intr-download-keep   = yes | no; If the browser closes the connection while
  121.                                  online the currently downloaded partial page
  122.                                  should be kept (default=no).
  123. intr-download-size   =<integer>; If the browser closes the connection while
  124.                                  online the page should continue to download if
  125.                                  smaller than this size in kB (default=1).
  126. intr-download-percent=<integer>; If the browser closes the connection while
  127.                                  online the page should continue to download if
  128.                                  more than this amount complete (default=80).
  129. timeout-download-keep= yes | no; If the server connection timeouts while reading
  130.                                  then the currently downloaded partial page
  131.                                  should be kept (default=no).
  133. Notes: The request-changed option can be set negative to indicate that cached
  134.        pages are always used while online.
  135.      : The request-changed-once option takes precedence over the
  136.        request-changed option.
  137.      : The request-expired and request-no-cache options takes precedence over
  138.        the request-changed-once and request-changed options.
  139.      : The pragma-no-cache option should be set to 'no' if when browsing
  140.        offline all pages are re-requested by a 'broken' browser.
  141.      : The ssl-allow-port should be set to 443 to allow https, there can be more
  142.        than one ssl-port entry for other ports as required.
  145. FetchOptions
  146. ------------
  148. Options that control what is downloaded when fetching pages that were requested
  149. while offline.
  151. stylesheets = yes | no ; If style sheets are to be fetched.
  152. images      = yes | no ; If images are to be fetched.
  153. frames      = yes | no ; If frames are to be fetched.
  154. scripts     = yes | no ; If scripts (e.g. Javascript) are to be fetched.
  155. objects     = yes | no ; If objects (e.g. Java class files) are to be fetched.
  157. Notes: These options all default to 'no' if nothing is specified.
  160. ModifyHTML
  161. ----------
  163. Options that control how the HTML that is provided from the cache is modified.
  165. enable-modify-html      = yes | no  ; Enable the HTML modifications in this
  166.                                       section (has a speed penalty)
  167.                                       (default=no).
  168. add-cache-info          = yes | no  ; At the bottom of all of the spooled pages
  169.                                       the date that the page was cached and some
  170.                                       buttons are to be added (default=no).
  171. anchor-cached-begin     =<HTML code>; Anchors (links) that are cached are to
  172.                                       have the specified HTML inserted at the
  173.                                       beginning (default="").
  174. anchor-cached-end       =<HTML code>; Anchors (links) that are cached are to
  175.                                       have the specified HTML inserted at the
  176.                                       end (default="").
  177. anchor-requested-begin  =<HTML code>; Anchors (links) that have been requested
  178.                                       are to have the specified HTML inserted at
  179.                                       the beginning (default="").
  180. anchor-requested-end    =<HTML code>; Anchors (links) that have been requested
  181.                                       are to have the specified HTML inserted at
  182.                                       the end (default="").
  183. anchor-not-cached-begin =<HTML code>; Anchors (links) that are not cached or
  184.                                       requested are to have the specified HTML
  185.                                       inserted at the beginning (default="").
  186. anchor-not-cached-end   =<HTML code>; Anchors (links) that are not cached or
  187.                                       requested are to have the specified HTML
  188.                                       inserted at the end (default="").
  189. disable-script          = yes | no;   Removes all scripts and scripted events
  190.                                       (default=no).
  191. disable-blink           = yes | no;   Removes the <blink> tag (default=no).
  192. disable-animated-gif    = yes | no;   Disables the animation of GIF files
  193.                                       (default=no).
  195. Notes: These options all rely on the HTML being syntactically correct, if it is
  196.        not then the result is undefined.
  199. LocalHost
  200. ---------
  202. A list of hosts that the host running the wwwoffled server may be known by.
  203. This is so that the proxy does not need to contact itself to get the server
  204. local pages.
  206. <host> ; A hostname or IP address that in connection with the port number (in
  207.          the StartUp section) specifies the WWWOFFLE proxy HTTP server.
  209. Notes: The host names must match exactly, no wildcard matches.
  210.      : All of these hosts are also used the same way as those in the
  211.        LocalNet and AllowedConnectHosts sections.
  212.      : The first named host is used as the server name for several features
  213.        so must be a name that will work from any client host on the network.
  214.      : None of the entries here or in LocalNet are fetched via a proxy.
  217. LocalNet
  218. --------
  220. A list of hosts that are not to be cached by wwwoffled because they are on a
  221. local network.
  223. <host> ; A hostname or IP address that is not to be cached by the server.
  225. Notes: The host name matching uses wildcards (see the WILDCARD section).
  226.      : A host can be excluded by appending a '!' to the start of the name, all
  227.        possible aliases and IP addresses for the host are also required.
  228.      : All entries here are assumed to be reachable even when offline.
  229.      : All of the hosts in LocalHost are also not cached.
  230.      : None of the entries here or in LocalHost are fetched via a proxy.
  233. AllowedConnectHosts
  234. -------------------
  236. A list of client hosts that are allowed to connect to the server.
  238. <host> ; A hostname or IP address that is allowed to connect to the server.
  240. Notes: The host name matching uses wildcards (see the WILDCARD section).
  241.      : A host can be excluded by appending a '!' to the start of the name, all
  242.        possible aliases and IP addresses for the host are also required.
  243.      : All of the hosts in LocalHost are also allowed to connect.
  246. AllowedConnectUsers
  247. -------------------
  249. A list of the users that are allowed to connect to the server.
  251. <username>:<password> ; The username and password of the users that are allowed
  252.                         to connect to the server.
  254. Notes: If this section is left empty then no user authentication is done.
  255.      : The username and password are both stored in plaintext format.
  256.      : This requires the use of browsers that handle the HTTP/1.1 standard.
  259. DontCache
  260. ---------
  262. A list of URLs that are not to be cached by wwwoffled.
  264. URL-SPECIFICATION   ; Do not cache any URLs that match this.
  266. Notes: See the bottom of this file for the description of URL-SPECIFICATION.
  267.      : The URL-SPECIFICATION can be negated, see URL-SPECIFICATION description.
  268.      : The files will still be cached if fetched non-interactively.
  271. DontGet
  272. -------
  274. A list of URLs that are not to be got by wwwoffled (because they contain only
  275. junk adverts for example).
  277. URL-SPECIFICATION [ = <URL> ] ; Do not get any URLs that match this [ with
  278.                                 the option to specify a replacement URL ].
  279. replacement = <URL>           ; The default URL to replace any URLs that match
  280.                                 the URL-SPECIFICATIONs instead of using the
  281.                                 standard error message (default=none).
  283. Notes: See the bottom of this file for the description of URL-SPECIFICATION.
  284.      : The URL-SPECIFICATION can be negated, see URL-SPECIFICATION description.
  285.      : The URL /local/images/trans-1x1.gif is a suggested replacement
  286.        (a 1x1 pixel transparent gif).
  289. DontGetRecursive
  290. ----------------
  292. A list of URLs that are not to be got by wwwoffled when fetching recursively.
  294. URL-SPECIFICATION   ; Do not recursively get any URLs that match this.
  296. Notes: See the bottom of this file for the description of URL-SPECIFICATION.
  297.      : The URL-SPECIFICATION can be negated, see URL-SPECIFICATION description.
  300. DontRequestOffline
  301. ------------------
  303. A list of URLs that cannot be requested by users when offline.
  305. URL-SPECIFICATION   ; Do not request any URLs that match this.
  307. Notes: See the bottom of this file for the description of URL-SPECIFICATION.
  308.      : The URL-SPECIFICATION can be negated, see URL-SPECIFICATION description.
  311. CensorHeader
  312. ------------
  314. A list of HTTP header lines that are to be removed from the requests sent to web
  315. servers and the replies that come back from them.
  317. <header>         = <string> ; A header field name (e.g. From, Cookie, Set-Cookie
  318.                               User-Agent) and the string to replace the header
  319.                               value with.
  320. referer-self     = yes | no ; Sets the Referer header to the same as the URL
  321.                               (default = no).
  322. referer-self-dir = yes | no ; Sets the Referer header to the URL directory name
  323.                               (default = no).
  325. Notes: The header is case sensitive, and does not have a ':' at the end.
  326.      : The value of none or no string can be used to remove the header.
  327.      : This only replaces headers it finds, it does not add any new ones.
  328.      : The referer-self-dir option takes precedence over referer-self.
  331. FTPOptions
  332. ----------
  334. Options to use when fetching files using ftp.
  336. anon-username = <string>      ; The username to use for anonymous ftp
  337.                                 (default=anonymous).
  338. anon-password = <string>      ; The password to use for anonymous ftp
  339.                                 (default=<user>@<host>, determined at run time).
  340. auth-hostname = <host[:port]> ; A host to use a different username and password.
  341. auth-username = <string>      ; The username to use on the above host.
  342. auth-password = <string>      ; The password to use on the above host.
  344. Notes: The anon-password should be set to a sensible value especially if you
  345.        are behind a firewall.
  346.      : The auth-hostname, auth-username and auth-password options must come
  347.        together as a triplet.
  348.      : The auth-hostname must be exact, it is not used as a WILDCARD match.
  351. MIMETypes
  352. ---------
  354. MIME Types to use when fetching files not using HTTP.
  356. default     = <mime-type>/<subtype> ; The default MIME type
  357.                                       (default=text/plain).
  358. .<file-ext> = <mime-type>/<subtype> ; The MIME type to associate with a file
  359.                                       extension.
  361. Notes: You must include the '.' in the file extension.
  362.      : If more than one of the extensions match then the longest is used.
  365. Proxy
  366. -----
  368. This contains the names of the HTTP (or other) proxies to use external to the
  369. local machine.
  371. default             = <host[:port]> ; The hostname and port on it to use as the
  372.                                       default proxy.
  373. URL-SPECIFICATION   = <host[:port]> ; The hostname and port on it to use as the
  374.                                       proxy when getting URLs that match the
  375.                                       URL-SPECIFICATION.
  376. auth-hostname = <host[:port]>  ; A proxy server that uses proxy authentication,
  377.                                  this is where the user must enter a username
  378.                                  and password in the browser to use the proxy.
  379. auth-username = <string>       ; The username to use on the above host.
  380. auth-password = <string>       ; The password to use on the above host.
  381. ssl           = <host[:port]>  ; A proxy server that should be used for Secure
  382.                                  Socket Layer (SSL) connections e.g. https.
  384. Notes: See the bottom of this file for the description of URL-SPECIFICATION.
  385.      : A hostname that matches more than one entry here uses the proxy of the
  386.        longest matching one (protocol is included in assessing length).
  387.      : You can use none or no hostname to indicate that a default or particular
  388.        protocol or host is not to use a proxy.
  389.      : None of the hosts in LocalNet/LocalHost will be fetched via a proxy.
  390.      : The auth-hostname, auth-username and auth-password options must come
  391.        together as a triplet.
  392.      : The auth-hostname must be exact, it is not used as a wildcard match.
  395. DontIndex
  396. ---------
  398. A list of URLs that are not to be cached by wwwoffled.
  400. outgoing = URL-SPECIFICATION  ; Do not index and URLs that match this in the
  401.                                 outgoing index.
  402. latest   = URL-SPECIFICATION  ; Do not index and URLs that match this in the
  403.                                 lasttime/prevtime/latest indexes.
  404. monitor  = URL-SPECIFICATION  ; Do not index and URLs that match this in the
  405.                                 monitor index.
  406. host     = URL-SPECIFICATION  ; Do not index and URLs that match this in the
  407.                                 host indexes.
  408. URL-SPECIFICATION             ; Do not index any URLs that match this in any
  409.                                 of the indexes.
  411. Notes: See the bottom of this file for the description of URL-SPECIFICATION
  412.      : The URL-SPECIFICATION can be negated, see URL-SPECIFICATION description.
  415. Alias
  416. -----
  418. A list of aliases that are used to replace the server name and path with another
  419. server name and path.  Also for servers known by two names.
  421. URL-SPECIFICATION = URL-SPECIFICATION ; Any requests for the first URL-SPEC
  422.                                         are replaced by the second URL-SPEC.
  424. Notes: See the bottom of this file for the description of URL-SPECIFICATION
  425.      : The URL-SPECIFICATIONs must match exactly, no WILDCARDs are used and the
  426.        URL arguments are ignored.
  429. Purge
  430. -----
  432. The method to determine which pages to purge, the default age the host specific
  433. maximum age of the pages in days, and the maximum cache size.
  435. use-mtime           = yes | no ; The method to use to decide which files to
  436.                                  purge, last access time (atime) or last
  437.                                  modification time (mtime) (default=no).
  438. max-size            = <size>   ; The maximum size for the cache in MB after
  439.                                  purging (default=0).
  440. min-free            = <size>   ; The minimum amount of free disk space in MB
  441.                                  after purging (default=0).
  442. use-url             = yes | no ; If true then use the URL to decide on the purge
  443.                                  age, otherwise use the protocol and host only
  444.                                  (default=no).
  445. del-dontget         = yes | no ; If true then delete the files from hosts that
  446.                                  are in the DontGet section (default=no).
  447. del-dontcache       = yes | no ; If true then delete the files from hosts that
  448.                                  are in the DontCache section (default=no).
  449. default             = <age>    ; The default maximum age of pages in days
  450.                                  (default=14).
  451. URL-SPECIFICATION   = <age>    ; The maximum age of pages that match the
  452.                                  URL-SPECIFICATION
  454. Notes: See the bottom of this file for the description of URL-SPECIFICATION
  455.      : A hostname that matches more than one entry here uses the age of the
  456.        longest matching one (protocol is included in assessing length).
  457.      : An age of zero means not to keep, negative not to delete.
  458.      : A maximum cache size of 0 means there is no limit to the size.
  459.      : A minimum disk free of 0 means there is no limit to the free space.
  460.      : If the max-size and min-free options are both used the smaller cache size
  461.        is chosen.
  462.      : The max-size and min-free options take into account the hosts that
  463.        are never purged when measuring the cache size but do not purge them.
  464.      : The URL-SPECIFICATION matches only the protocol and host unless use-url
  465.        is set to true.
  468. --------------------------------------------------------------------------------
  470. WILDCARD
  471. --------
  473. A wildcard match is one that uses the '*' character to represent any group of
  474. characters.
  476. This is basically the same as the command line file matching expressions in DOS
  477. or the UNIX shell, except that the '*' can match the '/' character.  A maximum
  478. of 2 '*' characters can be used in any wildcard.
  480. For example
  482. *.gif      matches  foo.gif and bar.gif
  483. *.foo.com  matches  www.foo.com and ftp.foo.com
  484. /foo/*     matches  /foo/bar.html and /foo/bar/foobar.html
  487. --------------------------------------------------------------------------------
  489. URL-SPECIFICATION
  490. -----------------
  492. When specifying a host and protocol and pathname in many of the sections a
  493. URL-SPECIFICATION can be used, this is a way of recognising a URL.
  495. For the purposes of this explanation a URL is considered to be made up of five
  496. parts.
  498. proto          The protocol that is used (e.g. 'http', 'ftp')
  499. host           The server hostname (e.g. 'www.gedanken.demon.co.uk').
  500. port           The port number on the host (e.g. default of 80 for HTTP).
  501. path           The pathname on the host (e.g. '/bar.html') or a directory name
  502.                (e.g. '/foo/').
  503. args           Optional arguments with the URL used for CGI scripts etc.
  504.                (e.g. 'search=foo').
  506. For example the WWWOFFLE homepage: http://www.gedanken.demon.co.uk/wwwoffle/
  507. The protocol is 'http', the host is 'www.gedanken.demon.co.uk', the port is
  508. the default (in this case 80), and the pathname is '/wwwoffle/'.
  510. In general this is written as <proto>://<host>[:<port>]/<path>[?<args>]
  512. Where [] indicates an optional feature, and <> indicate a user supplied name
  513. or number.
  515. Some example URL-SPECIFICATION options are the following:
  517. *://*              Any protocol, Any host, Any port, Any path, Any args
  518.                    (This is that same as saying 'default').
  520. *://*/<path>       Any protocol, Any host, Any port, Named path, Any args
  522. *://*/*.<ext>      Any protocol, Any host, Any port, Named path, Any args
  524. *://*/*?           Any protocol, Any host, Any port, Any path, No args
  526. *://<path>?*       Any protocol, Any host, Any port, Named path, Any args
  528. *://<host>         Any protocol, Named host, Any port, Any path, Any args
  530. <proto>://         Named protocol, Any host, Any port, Any path, Any args
  532. <proto>://<host>   Named protocol, Named host, Any port, Any path, Any args
  534. <proto>://<host>:  Named protocol, Named host, Default port, Any path Any args
  536. *://<host>:<port>  Any protocol, Named host, Named port, Any path, Any args
  538. The matching of the host, the path and the args use the wildcard matching that
  539. is described above.
  542. In some sections that accept URL-SPECIFICATIONs they can be negated by appending
  543. the '!' character to the start.  This will mean that the comparison of a URL
  544. with the URL-SPECIFICATION will return the logically opposite value to what
  545. would be returned without the '!'.  If all of the URL-SPECIFICATIONs in a
  546. section are negated and '*://*/*' is added to the end then the sense of the
  547. whole section is negated.