MAN page from Mandrake 10.X wwwoffle-2.8c-1mdk.i586.rpm

wwwoffle

Section: User Commands (1)
Updated: December 3, 2003
Index

NAME

wwwoffle - A program to control the World Wide Web Offline Explorer.

SYNOPSIS

wwwoffle-h | --help--versionwwwoffle-online[-p <host>[:<port>] | -c <config-file>]wwwoffle-autodial[-p <host>[:<port>] | -c <config-file>]wwwoffle-offline[-p <host>[:<port>] | -c <config-file>]wwwoffle-fetch[-p <host>[:<port>] | -c <config-file>]wwwoffle-config[-p <host>[:<port>] | -c <config-file>]wwwoffle-dump[-p <host>[:<port>] | -c <config-file>]wwwoffle-purge[-p <host>[:<port>] | -c <config-file>]wwwoffle-status[-p <host>[:<port>] | -c <config-file>]wwwoffle-kill[-p <host>[:<port>] | -c <config-file>]wwwoffle[-o|-O][-p <host>[:<port>] | -c <config-file>]URLwwwoffle[-d[<depth>] | -r[<depth>] | -R[<depth>]][-g[Sisfo]][-F][-p <host>[:<port>] | -c <config-file>]URL1 [URL2 [... URL]]wwwoffle[-d[<depth>] | -r[<depth>] | -R[<depth>]][-g[Sisfo]][-F][-p <host>[:<port>] | -c <config-file>]file1 [file2 [... file]]wwwoffle-post[-p <host>[:<port>] | -c <config-file>]URLwwwoffle-put[-p <host>[:<port>] | -c <config-file>]URL

DESCRIPTION

wwwofflecontrols theWorld Wide Web Offline Explorer proxy HTTP server.

The wwwoffle program is used to control the wwwoffled program, to tell it whenthe computer is online or offline, and which URLs to get and when to fetch them.

The control options are also available from the server on an interactive controlweb page at http://localhost:8080/control/.

OPTIONS

The command line options available for the program are described below.

-h | --help

A help message is printed giving a brief description of the usage of theprogram.

--version

The version number of the program is printed.

-online

Tell the wwwoffled proxy server that the computer is online to the internet andthat requests are to be fetched immediately.

-autodial

Tell the wwwoffled proxy server that the computer can become online to theinternet if required for requests that are not already cached, but that pagesthat are in the cache do not require any netwrok access. This is intended foruse with dial-on-demand systems (using diald for example).

-offline

Tell the wwwoffled proxy server that the computer is not online to the internetand that requests are to be cached until they are fetched later.

-fetch

Tell the wwwoffled proxy server to fetch all of the requests that have beencached. (The proxy server must be online for this to work.) The program willwait until all of the requests have been met before exiting.

-config

Tell the wwwoffled proxy server to re-read the configuration file.

-dump

Tell the wwwoffled proxy server to dump out the current program configuration.This is equivalent to the most recently read configuration file and the built-indefault options.

-purge

Tell the wwwoffled proxy server that the cache is to be purged. Theconfiguration file wwwoffle.conf(5) specifies the maximum age of the pages tokeep. If a maximum cache size is specified then the oldest pages are deleteduntil the size is not exceeded.

-status

Request from the wwwoffled proxy server the current status of the program. Theonline or offline mode, the fetch and purge statuses, the number of currentprocesses and their PIDs are displayed.

-kill

Tell the wwwoffled proxy server to exit cleanly at the next convenient point.

URL

The URL of a web page that is to be fetched. This is the same as using abrowser and entering the URL if not already in the cache or pressing the refreshbutton in the index if it is in the cache.

file

The name of an HTML file that is to be parsed and the links in it are to befetched as if the URLs had been specified on the command line.

-o

Fetch the specified URL (from the cache or request it if not already cached whenoffline, or get it when online) and output it on standard output. This is aneasy way of getting an image out of the cache to be used in other programs. Thecontents of the ModifyHTML section of the configuration file are ignored and theunmodified data is output.

-O

Fetch the specified URL (from the cache or request it if not already cached whenoffline, or get it when online) and output it on standard output including theHTTP header. The contents of the ModifyHTML section of the configuration fileare ignored and the unmodified data is output.

-F

Force the specified URLs to be refreshed. Without this option, the page willnot be fetched unless newer than the version on the server.

-r[<depth>]

Causes the pages linked to by the specified URLs also to be fetched if they areon the same host. This recursion works for a number of links specified by thedepth parameter, a depth of 0 means only the specified page, a depth of 2 meansall linked pages and all links from them.

-R[<depth>]

The same as-rabove, but it also works for links that are not on the same host.

-d[<depth>]

The same as-rabove, but is limited to links in the same directory or a sub-directory.

-gS

Also fetches the stylesheets that are included in the specified URLs.

-gi

Also fetches the images that are included in the specified URLs.

-gf

Also fetches the frames that are included in the specified URLs.

-gs

Also fetches the scripts that are included in the specified URLs.

-go

Also fetches the objects that are included in the specified URLs.

-post

Create a request using the POST method, the data is read from stdin, andappended to the request. The user must ensure that the format of the data isvalid for a POST request. Any of the characters '&', '=' or ';' that are notbeing used for their reserved purpose must be URL-encoded in the input, othercharacters will be URL-encoded.

-put

Create a request using the PUT method, the data is read from stdin and appendedto the request.

-c <config-file>

Specifies the name of the configuration file that contains the server host name,port number and authorisation password. This is required for the -online,-offline, -fetch, -config and -purge options if a password is set. The usermust have read access to the configuration file to be able to use the command ifa password is set.(See the StartUp and LocalHost section of wwwoffle.conf(5) for more informationon setting the server host name, ports and password.)

-p <host>[:<port>]

Sets the hostname and port number that is to be ued for the connection to theproxy server. For the -online, -offline, -fetch, -config and -purge option thismust be the WWWOFFLE daemon port, for the url options it must be the http proxyserver port. If no -p option is specified then the compiled in defaults areused.

When the-F,-R[<depth>],-r[<depth>],-d[<depth>]or-g[Sisfo]options are given then they will override the options that are set in theFetchOptions section of the configuration and not fetch any other contents ofthe specified URL. For example if the fetch options normally include images andframes then using the-gioption will only fetch images and not frames. All page contents to be fetchedmust be specified as command line options. Specifying-gwithout any options will fetch only the specified URL without any of theoptions.

ENVIRONMENT VARIABLE

TheWWWOFFLE_PROXYenvironment variable can be used instead of the -c or -p options. There arethree ways that the variable can be used.

1.: When the variable is set to absolute pathname of a file, then that file is usedas the configuration file like the -c option (for example/etc/wwwoffle/wwwoffle.conf).
2.: The WWWOFFLE_PROXY variable can also be set to the hostname and the port numberas would be used with the -p option (for example localhost:8080).
3.: The third possibility is to set the variable to the hostname and the two portnumbers for the HTTP proxy port and the WWWOFFLE control port (for examplelocalhost:8080:8081). This way it will work with both types of command (proxyaccess and control).

AUTHOR

Andrew M. Bishop 1996,97,98,99,2000,01,02,03 (ambAATTgedanken.demon.co.uk)

This document was created byman2html,using the manual pages.