summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert James Kaes <rjkaes@users.sourceforge.net>2000-09-12 00:16:57 +0000
committerRobert James Kaes <rjkaes@users.sourceforge.net>2000-09-12 00:16:57 +0000
commit0e7a2192cff758b423e623cca5a3b7a8750469c5 (patch)
tree481ce83cf67693bcca333d74e27f8734fd7b60a0
parentdc18c065b77bffbe195fed4b0f60c6a19cdb0a47 (diff)
downloadtinyproxy-0e7a2192cff758b423e623cca5a3b7a8750469c5.tar.gz
tinyproxy-0e7a2192cff758b423e623cca5a3b7a8750469c5.zip
Just updating the documentation.
Diffstat (limited to '')
-rw-r--r--AUTHORS3
-rw-r--r--BUGS8
-rw-r--r--INSTALL202
-rw-r--r--README25
-rw-r--r--THANKS4
5 files changed, 197 insertions, 45 deletions
diff --git a/AUTHORS b/AUTHORS
index e8a67c7..94f080e 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -4,3 +4,6 @@
From versions 0-1.1, Steven Young was the primary maintainer.
From 1.2 to 1.3.0, Robert James Kaes was the primary maintainer.
As of 1.3.1, Steven Young will once again be the primary maintainer.
+
+ Please see the ChangeLog for futher details as to who did what. :)
+
diff --git a/BUGS b/BUGS
index 10c7473..d8a2020 100644
--- a/BUGS
+++ b/BUGS
@@ -1,9 +1,9 @@
KNOWN BUGS
==========
- There is exactly one known bug at the time of 1.3.2's release - when compiling
-under some Linux distributions (notably, Debian), the compile process will
-generate a number of warnings regarding __underflow. However, tinyproxy still
-compiles and runs perfectly.
+ There is exactly one known bug at the time of 1.3.2's release - when
+compiling under some Linux distributions (notably, Debian), the compile
+process will generate a number of warnings regarding __underflow. However,
+tinyproxy still compiles and runs perfectly.
Patches welcome!
diff --git a/INSTALL b/INSTALL
index 3355ae4..b42a17a 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,24 +1,182 @@
-Installing tinyproxy 1.3.2
+Basic Installation
+==================
+
+ These are generic installation instructions.
+
+ The `configure' shell script attempts to guess correct values for
+various system-dependent variables used during compilation. It uses
+those values to create a `Makefile' in each directory of the package.
+It may also create one or more `.h' files containing system-dependent
+definitions. Finally, it creates a shell script `config.status' that
+you can run in the future to recreate the current configuration, a file
+`config.cache' that saves the results of its tests to speed up
+reconfiguring, and a file `config.log' containing compiler output
+(useful mainly for debugging `configure').
+
+ If you need to do unusual things to compile the package, please try
+to figure out how `configure' could check whether to do them, and mail
+diffs or instructions to the address given in the `README' so they can
+be considered for the next release. If at some point `config.cache'
+contains results you don't want to keep, you may remove or edit it.
+
+ The file `configure.in' is used to create `configure' by a program
+called `autoconf'. You only need `configure.in' if you want to change
+it or regenerate `configure' using a newer version of `autoconf'.
+
+The simplest way to compile this package is:
+
+ 1. `cd' to the directory containing the package's source code and type
+ `./configure' to configure the package for your system. If you're
+ using `csh' on an old version of System V, you might need to type
+ `sh ./configure' instead to prevent `csh' from trying to execute
+ `configure' itself.
+
+ Running `configure' takes awhile. While running, it prints some
+ messages telling which features it is checking for.
+
+ 2. Type `make' to compile the package.
+
+ 3. Optionally, type `make check' to run any self-tests that come with
+ the package.
+
+ 4. Type `make install' to install the programs and any data files and
+ documentation.
+
+ 5. You can remove the program binaries and object files from the
+ source code directory by typing `make clean'. To also remove the
+ files that `configure' created (so you can compile the package for
+ a different kind of computer), type `make distclean'. There is
+ also a `make maintainer-clean' target, but that is intended mainly
+ for the package's developers. If you use it, you may have to get
+ all sorts of other programs in order to regenerate files that came
+ with the distribution.
+
+Compilers and Options
+=====================
+
+ Some systems require unusual options for compilation or linking that
+the `configure' script does not know about. You can give `configure'
+initial values for variables by setting them in the environment. Using
+a Bourne-compatible shell, you can do that on the command line like
+this:
+ CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
+
+Or on systems that have the `env' program, you can do it like this:
+ env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
+
+Compiling For Multiple Architectures
+====================================
+
+ You can compile the package for more than one kind of computer at the
+same time, by placing the object files for each architecture in their
+own directory. To do this, you must use a version of `make' that
+supports the `VPATH' variable, such as GNU `make'. `cd' to the
+directory where you want the object files and executables to go and run
+the `configure' script. `configure' automatically checks for the
+source code in the directory that `configure' is in and in `..'.
+
+ If you have to use a `make' that does not supports the `VPATH'
+variable, you have to compile the package for one architecture at a time
+in the source code directory. After you have installed the package for
+one architecture, use `make distclean' before reconfiguring for another
+architecture.
+
+Installation Names
+==================
+
+ By default, `make install' will install the package's files in
+`/usr/local/bin', `/usr/local/man', etc. You can specify an
+installation prefix other than `/usr/local' by giving `configure' the
+option `--prefix=PATH'.
+
+ You can specify separate installation prefixes for
+architecture-specific files and architecture-independent files. If you
+give `configure' the option `--exec-prefix=PATH', the package will use
+PATH as the prefix for installing programs and libraries.
+Documentation and other data files will still use the regular prefix.
+
+ In addition, if you use an unusual directory layout you can give
+options like `--bindir=PATH' to specify different values for particular
+kinds of files. Run `configure --help' for a list of the directories
+you can set and what kinds of files go in them.
+
+ If the package supports it, you can cause programs to be installed
+with an extra prefix or suffix on their names by giving `configure' the
+option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
+
+Optional Features
+=================
+
+ Some packages pay attention to `--enable-FEATURE' options to
+`configure', where FEATURE indicates an optional part of the package.
+They may also pay attention to `--with-PACKAGE' options, where PACKAGE
+is something like `gnu-as' or `x' (for the X Window System). The
+`README' should mention any `--enable-' and `--with-' options that the
+package recognizes.
+
+ For packages that use the X Window System, `configure' can usually
+find the X include and library files automatically, but if it doesn't,
+you can use the `configure' options `--x-includes=DIR' and
+`--x-libraries=DIR' to specify their locations.
+
+Specifying the System Type
==========================
- As of 1.3.2, tinyproxy uses Ian Jackson's adns library to perform non-blocking
-DNS lookups. As such, before you can do anything to install tinyproxy, you must
-go into the adns-0.6/ subdirectory off the root tinyproxy distribution directory
-and follow the INSTALL directions therein. Once you have libadns installed,
-follow these steps:
-
- (1) Run the tinyproxy 'configure' script, found in the root distribution
- directory. If you're unsure of exactly what arguments to use, please
- consult the output of 'configure --help'. Additional documentation can
- be found for configure in the text file INSTALL.configure.
- (2) Run 'make install'. This will build all of tinyproxy and install it
- in the default directory. You may also wish to peruse src/config.h
- to be sure everything is configured to your liking.
- (3) Read the tinyproxy manpage - it will explain what commandline arguments
- and parameters are available. More experienced users will probably
- be able to get all the information they need from the output of
- 'tinyproxy -h'.
-
- Enjoy! Please read the documentation carefully, especially the COPYING
-file which should have been included in this archive explaining the licensing
-terms of tinyproxy.
+ There may be some features `configure' can not figure out
+automatically, but needs to determine by the type of host the package
+will run on. Usually `configure' can figure that out, but if it prints
+a message saying it can not guess the host type, give it the
+`--host=TYPE' option. TYPE can either be a short name for the system
+type, such as `sun4', or a canonical name with three fields:
+ CPU-COMPANY-SYSTEM
+
+See the file `config.sub' for the possible values of each field. If
+`config.sub' isn't included in this package, then this package doesn't
+need to know the host type.
+
+ If you are building compiler tools for cross-compiling, you can also
+use the `--target=TYPE' option to select the type of system they will
+produce code for and the `--build=TYPE' option to select the type of
+system on which you are compiling the package.
+
+Sharing Defaults
+================
+
+ If you want to set default values for `configure' scripts to share,
+you can create a site shell script called `config.site' that gives
+default values for variables like `CC', `cache_file', and `prefix'.
+`configure' looks for `PREFIX/share/config.site' if it exists, then
+`PREFIX/etc/config.site' if it exists. Or, you can set the
+`CONFIG_SITE' environment variable to the location of the site script.
+A warning: not all `configure' scripts look for a site script.
+
+Operation Controls
+==================
+
+ `configure' recognizes the following options to control how it
+operates.
+
+`--cache-file=FILE'
+ Use and save the results of the tests in FILE instead of
+ `./config.cache'. Set FILE to `/dev/null' to disable caching, for
+ debugging `configure'.
+
+`--help'
+ Print a summary of the options to `configure', and exit.
+
+`--quiet'
+`--silent'
+`-q'
+ Do not print messages saying which checks are being made. To
+ suppress all normal output, redirect it to `/dev/null' (any error
+ messages will still be shown).
+
+`--srcdir=DIR'
+ Look for the package's source code in directory DIR. Usually
+ `configure' can determine that directory automatically.
+
+`--version'
+ Print the version of Autoconf used to generate the `configure'
+ script, and exit.
+
+`configure' also accepts some other, not widely useful, options.
diff --git a/README b/README
index 64d2bd4..d57732a 100644
--- a/README
+++ b/README
@@ -1,5 +1,3 @@
- This is tinyproxy-adns, tinyproxy with support for GNU adns asynchronous
- resolver library.
DESCRIPTION
-----------
@@ -16,8 +14,6 @@
allowed, then tinyproxy is a great tool for the network
administrator.
- This version of tinyproxy must be compiled with GNU adns, available from
- http://www.chiark.greenend.org.uk/~ian/adns/.
INSTALLATION
------------
@@ -34,14 +30,11 @@
--enable-xtinyproxy Compile in support for the XTinyproxy
header, which is sent to any web
server in your domain.
-
- Options for GNU adns
- --with-adns-include=DIR Set the directory in which adns.h has
- been installed. Required if this is in
- a non-standard location.
- --with-adns-lib=DIR Set the directory in which libadns.* have
- been installed. Required if this is in
- a non-standard location.
+ --enable-filter Allows tinyproxy to filter out certain
+ domains and URLs.
+ --enable-tunnel Provides the option of having
+ tinyproxy act as TCP tunnel, rather
+ than a HTTP proxy.
Options for file locations etc.
--with-port=PORT Set the port on which tinyproxy listens,
@@ -57,6 +50,7 @@
tinyproxy. Alternatively, you could just send an email stating the
version. Which ever you prefer.
+
SUPPORT
-------
@@ -66,11 +60,6 @@
Steven Young <sdyoung@well.com>
Robert James Kaes <rjkaes@flarenet.com>
- If the problem seems to be to do with GNU adns support (or if I've done
- something obviously wrong), please email
-
- Chris Lightfoot <chris@ex-parrot.com>
-
Please recompile tinyproxy with full debug support (--enable-debug)
and include a copy of the log file, and any assert errors reported by
tinyproxy. Also, if you feel up to it, try running tinyproxy under
@@ -79,7 +68,7 @@
gdb tinyproxy
- (gdb) set args -p port_num -l log_file -d
+ (gdb) set args -c location_of_tinyproxy_conf -d
(gdb) run
Now access the port tinyproxy is on until you receive a break in the
diff --git a/THANKS b/THANKS
index 80d112a..4cc453f 100644
--- a/THANKS
+++ b/THANKS
@@ -6,7 +6,9 @@ only the first person to report it is listed.
Steven Young - Wrote version 1.0 - 1.1
Robert James Kaes - Wrote versions from 1.2 to 1.3 and
- autoconf enabled the source tree.
+ autoconf enabled the source tree and
+ well just look at the ChangeLog for all
+ the rest. :)
Albert Ragnarsson - Made an RPM out of the 1.0d .tar.gz archive.
Alan W Black - Misc. bug reports and fixes.
Ed Boraas - Various suggestions, helped beta test 1.0d.