summaryrefslogtreecommitdiff
path: root/man/pump.1
diff options
context:
space:
mode:
authorcsilvers <csilvers@01de4be4-8c4a-0410-9132-4925637da917>2008-05-30 22:57:03 +0000
committercsilvers <csilvers@01de4be4-8c4a-0410-9132-4925637da917>2008-05-30 22:57:03 +0000
commitfe96c8cf1833b0a432cd8705bc27c7dbf42508e6 (patch)
treead9cb266b1d3f033d9936eccafc7ba75a2ccde6d /man/pump.1
parent4fa46575ef3da2afde1d447b1fd1adef3aab2380 (diff)
downloaddistcc-fe96c8cf1833b0a432cd8705bc27c7dbf42508e6.tar.gz
Documentation fixes:
1) Replace http://distcc.samba.org with the new google code location 2) Add favicon.ico from the distcc.samba.org site 3) Use distcc@lists.samba.org as the only distcc mailing list (there were at least three mailing lists scattered around the docs, some of which don't even exist anymore!) 4) Update man pages and other docs to not use "distcc-pump" anywhere; it's now "pump mode" or "distcc's pump mode", or "distcc-pump mode". I also add, to the README, some discussion of scaling to hundreds of machines. Reviewed by fergus and klarlund git-svn-id: http://distcc.googlecode.com/svn/trunk@431 01de4be4-8c4a-0410-9132-4925637da917
Diffstat (limited to 'man/pump.1')
-rw-r--r--man/pump.112
1 files changed, 7 insertions, 5 deletions
diff --git a/man/pump.1 b/man/pump.1
index 354d6a9..4bb3482 100644
--- a/man/pump.1
+++ b/man/pump.1
@@ -29,18 +29,19 @@ The simplest usage is the form
.I COMMAND [ARG]
\& ...
.RE
-This will start an include server for distcc-pump;
+This will start an include server for distcc's "pump" mode;
optionally run
.B lsdistcc
to compute the distcc host list;
set some auxiliary environment variables;
-change PATH to use the distcc-pump "distcc" client;
+change PATH to use the distcc client in the same directory as the "pump"
+script;
execute
.I COMMAND
with the specified
.I ARG(s)
\& ;
-and then shutdown the include server.
+and then shut down the include server.
The
.I COMMAND
is typically a parallel build command, such as
@@ -52,7 +53,7 @@ is to explicitly invoke "pump --startup"
to start the include server and "pump --shutdown" to stop the include server.
The "pump --startup" command will start up the include server, and will print
out some environment variable settings. These environment variables are used
-to communicate between the distcc-pump "distcc" client and the include
+to communicate between the pump-mode "distcc" client and the include
server, and to communicate between "pump --startup" and "pump --shutdown".
The caller of "pump --startup" is responsible for setting those environment
variables before invoking "distcc" or "pump --shutdown".
@@ -66,7 +67,8 @@ make -j80
pump --shutdown
.RE
.PP
-Note that distcc-pump assumes that sources files will not be modified during
+Note that distcc's pump-mode assumes that sources files will not be
+ modified during
the lifetime of the include server, so modifying source files during a build
may cause inconsistent results.
.SH "INVOKING LSDISTCC"