Package: pump
Version: 0.8.21-1
Severity: normal
Tags: patch
In pump 0.8.19-5 a modified man page was included. Besides general
improvements this man page documented the "no-resolvconf" option which
has been added for Debian.
In 0.8.21-1 the old upstream man page is again provided.
Please provide the new 'n' improved man page.
I think that it would be appropriate for the general improvements to be
sent upstream. Therefore I supply two patches. The first (attached)
improves the man page generally; the second (appended below) adds to the
improved man page documentation of the Debian-specific no-resolvconf
option.
--- pump-0.8.19_IMPROVED/pump.8 2005-04-02 11:23:17.000000000 +0200
+++ pump-0.8.19/pump.8 2005-04-02 11:19:47.000000000 +0200
@@ -30,7 +30,7 @@
.BR "" [ \-l | \-\-lease
.IR HOURS ]
.BR "" [ \-\-lookup\-hostname ]
-.BR "" [ \-\-no\-dns "] [" \-\-no\-gateway "] [" \-\-no\-setup "]
+.BR "" [ \-\-no\-dns "] [" \-\-no\-gateway "] [" \-\-no\-setup "] ["
\-\-no\-resolvconf ]
.BR "" [ \-\-release "] [" \-\-renew "] [" \-\-script =
.IR ISCRIPT ]
.BR "" [ \-\-status ]
@@ -73,6 +73,7 @@
\-R \-\-renew Renew lease immediately
\-r \-\-release Release interface
\-\-no\-gateway Don't configurate a default route for this interface
+ \-\-no\-resolvconf Don't use the \fBresolvconf\fR program to
update resolv.conf
\-\-no\-setup Don't set up anything
\-\-script=\fISCRIPT\fR Call \fISCRIPT\fR (or null string to disable)
\-s \-\-status Display interface status
@@ -192,6 +193,14 @@
if you want to perform setup in customised scripts.
.TP
+\fBnoresolvconf\fR
+Don't use the resolvconf program to update /etc/resolv.conf;
+instead, update /etc/resolv.conf directly.
+(This option is only relevant if
+.B \-\-nodns
+is not used.)
+
+.TP
\fBretries\fR \fICOUNT\fR
Retry each phase of the DHCP process \fICOUNT\fR times.
-- System Information:
Debian Release: 3.1
APT prefers testing
APT policy: (500, 'testing'), (50, 'unstable'), (1, 'experimental')
Architecture: i386 (i686)
Kernel: Linux 2.6.11
Locale: [EMAIL PROTECTED], [EMAIL PROTECTED] (charmap=ISO-8859-15)
Versions of packages pump depends on:
ii libc6 2.3.2.ds1-20 GNU C Library: Shared libraries an
ii libpopt0 1.7-5 lib for parsing cmdline parameters
-- debconf information:
pump/old-conf:
--- pump-0.8.19_ORIG/pump.8 2001-02-01 23:58:16.000000000 +0100
+++ pump-0.8.19_IMPROVED/pump.8 2005-04-02 11:23:17.000000000 +0200
@@ -1,4 +1,5 @@
.\" Copyright 1999 Red Hat Software, Inc.
+.\" August 2004: Updated by Thomas Hood <[EMAIL PROTECTED]>
.\"
.\" This man page is free documentation; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
@@ -14,69 +15,119 @@
.\" along with this man page; if not, write to the Free Software
.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
.\"
-.TH PUMP 8 "December 07, 1999" "Linux" "Linux Administrator's Manual"
+.TH PUMP 8 "26 August 2004" "Linux" "Linux Administrator's Manual"
.SH NAME
pump \- configure network interface via BOOTP or DHCP protocol
.SH SYNOPSIS
-/sbin/pump [-krRsd?] [-c \fIARG\fP] [-h \fIhostname\fP] [-i \fIiface\fP] [-l
\fIhours\fP] [--lookup-hostname] [--usage]
+.B pump
+.BR "" [ \-krRsd ]
+.BR "" [ \-c | \-\-config\-file
+.IR FILE ]
+.BR "" [ \-h | \-\-hostname
+.IR HOSTNAME ]
+.BR "" [ \-i | \-\-interface
+.IR IFACE ]
+.BR "" [ \-l | \-\-lease
+.IR HOURS ]
+.BR "" [ \-\-lookup\-hostname ]
+.BR "" [ \-\-no\-dns "] [" \-\-no\-gateway "] [" \-\-no\-setup "]
+.BR "" [ \-\-release "] [" \-\-renew "] [" \-\-script =
+.IR ISCRIPT ]
+.BR "" [ \-\-status ]
+.BR "" [ \-\-win\-client\-ident ]
+.P
+.B pump
+.BR "" [ \-? | \-\-help "] [" \-\-usage ]
.SH DESCRIPTION
-pump is a daemon that manages network interfaces that are
-controlled by either the DHCP or BOOTP protocol.
-
-While pump may be started manually, it is normally started
-automatically by the /sbin/ifup script for devices configured
-via BOOTP or DHCP.
-
-Once pump is managing an interface, you can run pump to query
+.B pump
+is a daemon that manages network interfaces that are controlled
+by either the DHCP or BOOTP protocol.
+
+While
+.B pump
+may be started manually, it is normally started automatically by
+.BR ifup (8)
+for devices configured via BOOTP or DHCP.
+
+If
+.B pump
+is managing an interface, you can run it again to query
the status of that interface. For example,
.br
-\f(CW/sbin/pump -i eth0 --status \fR
+ \f(CWpump \-i eth0 \-\-status\fR
.br
will print the current status of device eth0.
-.SH "COMMAND-LINE OPTIONS"
+.SH "COMMAND LINE OPTIONS"
.TS
lB lB lB
lfCW lfCW l.
switch long option description
-.TH
--c --config-file=ARG Configuration file to use instead of
- /etc/pump.conf
--h --hostname=hostname Hostname to request
--i --interface=iface Interface to configure (normally eth0)
--k --kill Kill daemon (and disable all interfaces)
--l --lease=hours Lease time to request (in hours)
- --lookup-hostname Always look up hostname and domain in DNS
--r --release Release interface
--R --renew Force immediate lease renewal
--s --status Display interface status
--d --no-dns Don't update resolv.conf
- --no-gateway Don't configurate a default route for this interface
- --win-client-id Specify a Windows-like client identifier
--? --help Show this help message
- --usage Display brief usage message
+\-? \-\-help Show this help message
+\-c \-\-config\-file=\fIFILE\fR Get configuration from \fIFILE\fR
instead of /etc/pump.conf
+\-d \-\-no\-dns Don't update DNS resolver configuration
+\-h \-\-hostname=\fIHOSTNAME\fR Request \fIHOSTNAME\fR
+\-i \-\-interface=\fIIFACE\fR Manage \fIIFACE\fR rather than eth0
+\-k \-\-kill Kill daemon (and disable all interfaces)
+\-l \-\-lease=\fIHOURS\fR Request least time of \fIHOURS\fR
+ \-\-lookup\-hostname Look up hostname in DNS
+\-R \-\-renew Renew lease immediately
+\-r \-\-release Release interface
+ \-\-no\-gateway Don't configurate a default route for this interface
+ \-\-no\-setup Don't set up anything
+ \-\-script=\fISCRIPT\fR Call \fISCRIPT\fR (or null string to disable)
+\-s \-\-status Display interface status
+ \-\-usage Display a brief usage message
+ \-\-win\-client\-ident Specify a Windows(tm)-like client identifier
.TE
-.SH LOGGING
-Pump logs a good deal of information to syslog, much of it at the DEBUG
-level. If you're having trouble, it's a good idea to turn up syslog's logging
-level.
-
-.SH CONFIG FILE
-Pump supports a simple configuration file which lets you tune its behavior.
-By default, it looks at \fI/etc/pump.conf\fR, though the \fB-c\fR option
-lets you override that.
-
-The configuration file is line oriented, and most line contains a
-directive followed by zero or more arguments. Arguments are handled
-similar to how shells handle command arguments, allowing the use of
-quotes and backslash escapes. Comments are allowed, and must begin with
-a # character, and spaces and tabs are ignored.
-
-Directives may be specified at two levels, global and specific. Global
-directives change pump's behavior for all of the devices which it manages,
-while specific directives change pump's behavior for a single device.
+.SH "OPTION NOTES"
+The
+.B \-\-lookup\-hostname
+option causes
+.B pump
+to ignore the host and domain names returned by the server
+and instead
+to look these up in DNS using the IP address of the interface.
+The name that is looked up is used in forming the
+.B search
+line in the resolv.conf file.
+Thus, if either the
+.B \-\-no\-dns
+or
+.B domainsearch
+option is used then
+.B \-\-lookup\-hostname
+has no effect.
+.P
+Note that
+.B pump
+itself never sets the computer's hostname.
+
+.SH "CONFIGURATION FILE"
+You can tune the behavior of
+.B pump
+using a configuration file.
+By default
+.B pump
+reads \fI/etc/pump.conf\fR but you can change this using the
+\fB\-\-config\-file\fR option.
+
+The configuration file is line-oriented.
+Most lines contain a directive followed by zero or more arguments.
+Arguments are handled similarly to how shells handle command arguments,
+allowing the use of quotes and backslash escapes.
+Comments are allowed, and must begin with a # character.
+Spaces and tabs are ignored.
+
+Directives may be specified at two levels: global and specific.
+Global directives change
+.BR pump 's
+behavior for all of the devices that it manages
+whereas specific directives change
+.BR pump 's
+behavior for a single device.
Later directives always override earlier ones.
-Here is an example /etc/pump.conf:
+Here is an example configuration file:
.nf
.ta +3i
@@ -91,71 +142,100 @@
.fi
.pp
-This configuration file tells pump to use a specific DNS search path rather
-deriving one from the DHCP or BOOTP server response, to retry each request
-3 times (for a total of 4 tries), and not to change any DNS configuration
+This configuration file tells
+.B pump
+to use a specific DNS search path rather
+than deriving one from the DHCP or BOOTP server response, to retry each request
+3 times (for a total of 4 tries), and not to change the DNS configuration file
when it's configuring the eth1 device.
Here is a complete list of directives:
.TP
-\fBdevice\fR \fIdevice\fR
-Specify specific directives for the indicated device. This directive must
+\fBdevice\fR \fIDEVICE\fR
+Specify specific directives for \fIDEVICE\fR. This directive must
be followed by a {, and the list of specific directives must end with a }
-on its own line. These directives may not be nested.
+on its own line.
+These directives may not be nested.
.TP
-\fBdomainsearch\fR \fIsearchpath\fR
-Rather then deriving the DNS search path (for /etc/resolv.conf), use the
-one which is given. As a machine only has a single DNS search path, this
-directive may only be used globally.
+\fBdomainsearch\fR \fISEARCHPATH\fR
+Use \fISEARCHPATH\fR as the DNS search path instead of the domain
+name returned by the server or the domain part of the fully
+qualified hostname.
+As a machine only has a single DNS search path, this directive may
+only be used globally.
.TP
\fBnonisdomain\fR
-Don't set a new NIS domain. Normally \fBpump\fR sets the system's NIS domain
-if an NIS domain is specified by the dhcp server and the current NIS domain
-is empty or \fBlocaldomain\fR.
+Don't set the NIS domain.
+Normally \fBpump\fR sets the system's NIS domain
+if an NIS domain is specified by the DHCP server
+and the current NIS domain is empty or \fBlocaldomain\fR.
This directive may only be used within a \fBdevice\fR directive.
.TP
\fBnodns\fR
-Don't create a new /etc/resolv.conf when this interface is configured. This
-directive may only be used within a \fBdevice\fR directive.
+Don't update /etc/resolv.conf when the interface is configured.
+This directive may only be used within a \fBdevice\fR directive.
.TP
\fBnogateway\fR
-Ignore any default gateway suggested by the DHCP server for this device. This
-can be usefull on machines with multiple ethernet cards.
+Ignore any default gateway suggested by the DHCP server for this device.
+This can be useful on machines with multiple Ethernet cards.
+
+.TP
+\fBnosetup\fR
+Don't set up anything on the local machine as a result of DHCP operations.
+This implies \fBnodns\fR, \fBnonisdomain\fR and \fBnogateway\fR.
+This option is useful, for example,
+if you want to perform setup in customised scripts.
.TP
-\fBretries\fR \fIcount\fR
-Retry each phase of the DHCP process \fIcount\fR times.
+\fBretries\fR \fICOUNT\fR
+Retry each phase of the DHCP process \fICOUNT\fR times.
.TP
-\fBtimeout\fR \fIcount\fR
-Don't let any one step of the DHCP process take more then \fIcount\fR seconds.
+\fBtimeout\fR \fICOUNT\fR
+Don't let any one step of the DHCP process take more then \fICOUNT\fR seconds.
.TP
-\fBscript\fR \fIexecutable-filename\fR
+\fBscript\fR \fIFILE\fR
.TS
lB lB lB lB
lB lfCW lfCW lfCW.
-.TH
Condition arg1 arg2 arg3
lease up eth0 1.2.3.4
renewal renewal eth0 2.3.4.5
release down eth0
.TE
-When events occur in negotiation with the server, calls the given
-executable or script. Scripts are called when a lease is granted,
-when a renewal is negotiated, and when the interface is brought
-down and the address released. The scripts are called with two
-or three arguments, depending on the condition, as documented in
-the table above.
+When events occur in negotiation with the server, call the executable
\fIFILE\fR.
+Scripts are called when a lease is granted, when a renewal is negotiated,
+and when the interface is brought down and the address released.
+The script is called with two or three arguments, depending on the condition,
+as documented in the table above.
+
+.SH LOGGING
+The program logs a good deal of information to syslog,
+much of it at the DEBUG level.
+If you're having trouble, it's a good idea to turn up syslog's logging level.
.SH BUGS
+
+At startup
+.B pump
+tries to detect whether another instance of itself is running.
+If the UNIX domain socket (normally \fI/var/run/pump.sock\fR)
+does not exist,
+.B pump
+tries to connect to tcp/127.0.0.1:68.
+If it is also unreacheable (possibly due to packet filtering),
+.B pump
+will issue a warning to stderr and assume that there is no
+instance of itself running.
+
Probably limited to Ethernet, might work on PLIP, probably not
ARCnet and Token Ring. The configuration file should let you do more
things.
@@ -163,5 +243,5 @@
Submit bug reports at the Bug Track link at
http://developer.redhat.com/
.SH QUIBBLE
-A pump, like a boot[p], is something you wear on your foot. Some of us
-like the name (I know, hard to believe)!
+A pump, like a boot[p], is something you wear on your foot.
+Some of us like the name (I know, hard to believe)!
