summaryrefslogtreecommitdiffabout
Side-by-side diff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--README23
1 files changed, 15 insertions, 8 deletions
diff --git a/README b/README
index f6c7ca6..05510c6 100644
--- a/README
+++ b/README
@@ -173,38 +173,45 @@ unsetting a variable: defined(), type_of() and unset()
4. The regset() and queryset() functions;
5. Additional functions for global variables: global_clear(),
global_defined() and global_unset().
* Installation
-In order to compile the package you need to have a configured and
-compiled Varnish source tree. Both Varnish 3 and 4 are OK.
+In order to compile the package you need to have the varnishd and
+varnishapi packages installed.
-Supposing that the varnish source tree is available under
-/usr/src/varnish-4.0.2, run:
+Supposing that condition is met, run:
- ./configure --with-varnish-source=/usr/src/varnish-4.0.2
+ ./configure
-The `--with-varnish-source' option is mandatory: it tells configure
-where Varnish sources reside.
+It should be able to automatically find the necessary components. In case
+it doesn't, tweak the configuration variables as necessary. The most
+important one is PKG_CONFIG_PATH, which contains a path (in the UNIX sense)
+where the .pc files are located. It should contain a directory where the
+'varnishapi.pc' file lives. Example usage:
+
+ ./configure PKG_CONFIG_PATH=/usr/local/varnish/lib/pkgconfig:$PKG_CONFIG_PATH
+
+Please read the file INSTALL for a detailed discussion of available variables
+and command line options.
Once configured, do
make
This will build the module. After this step you can optionally run
'make test' to test the package.
Finally, run the following command as root:
make install
-
+
* Documentation
The manual page vmod-variable(3) will be available after a successful
install. To read it without actually installing the module, run
`man src/vmod-variable.3'.
An online copy of the documentation is available from
http://www.gnu.org.ua/software/vmod-variable.

Return to:

Send suggestions and report system problems to the System administrator.