clusterit-2.5/tools/pdf.1

.\"	$Id: pdf.1,v 1.14 2006/01/25 18:51:51 garbled Exp $
.\"
.\" Copyright (c) 1998, 1999, 2000
.\"	Tim Rightnour.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgment:
.\"	This product includes software developed by Tim Rightnour for
.\"	The NetBSD Foundation, Inc.
.\" 4. The name of Tim Rightnour may not be used to endorse or promote
.\"    products derived from this software without specific prior written
.\"    permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY TIM RIGHTNOUR ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL TIM RIGHTNOUR BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" The following requests are required for all man pages.
.Dd May 5, 1999
.Dt PDF 1
.Sh NAME
.Nm pdf
.Nd display free disk space across a group of machines
.Sh SYNOPSIS
.Nm
.Op Fl ln
.Op Fl g Ar nodegroup1,...,nodegroupN
.Op Fl m Ar size
.Op Fl t Ar type
.Op Fl w Ar node1,...,nodeN
.Op Fl x Ar node1,...,nodeN
.Op Ar file | Ar file_system ...
.Sh DESCRIPTION
.Nm
displays statistics about the amount of free disk space on the specified
.Ar file_system
or on the file system of which
.Ar file
is a part on all machines in a cluster.
If neither a file or a
.Ar file_system
operand is specified,
statistics for all mounted file systems, on all machines are displayed
(subject to the
.Fl w ,
.Fl x ,
.Fl g ,
.Fl m ,
.Fl l
and
.Fl t
options below).
The following options are available:
.Bl -tag -width www
.It Fl l
Display statistics only about mounted file systems with the MNT_LOCAL
flag set.  If a non-local file system is given as an argument, a
warning is issued and no information is given on that file system.
.It Fl n
Print out the previously obtained statistics from the file systems.
This option should be used if it is possible that one or more
file systems are in a state such that they will not be able to provide
statistics without a long delay.
When this option is specified,
.Nm
will not request new statistics from the file systems, but will respond
with the possibly stale statistics that were previously obtained.
.It Fl g
If the
.Fl g
option is specified, followed by a comma separated list of group
names, the command will only be run on that group of nodes.  A node
may be a part of more than one group if desired, however running
without the
.Fl g
option will run the command on the same node as many times as it
appears in the file specified by the
.Ev CLUSTER
environment variable.  This option is silently ignored if used with the
.Fl w
option.
.It Fl m Ar size
Is used to limit the displayed file systems to only those with a
capacity greater than the user-supplied
.Ar size
argument.  This can be used to find filesystems over a given threshold.
.It Fl t Ar type
Is used to indicate the actions should only be taken on
filesystems of the specified type.
More than one type may be specified in a comma separated list.
The list of filesystem types can be prefixed with
.Dq no
to specify the filesystem types for which action should
.Em not
be taken.  If a file system is given on the command line that is not of
the specified type, a warning is issued and no information is given on
that file system.
.It Fl w
If the
.Fl w
option is specified, followed by a comma delimited list of machine names,
the
.Ar command
will be run on each node in the list.  Without this flag,
.Nm
runs on the nodes listed in the file pointed to by the
.Ev CLUSTER
environment variable.
.It Fl x
The
.Fl x
option can be used to exclude specific nodes from the cluster.  The
format is the same as the
.Fl w
option, a comma delimited list of machine names.  This option is
silently ignored if used with the
.Fl w
option.
.El
.Pp
.Sh ENVIRONMENT
.Nm
utilizes the following environment variables.
.Bl -tag -width "RCMD_CMD"
.It Ev CLUSTER
Contains a filename, which is a newline separated list of nodes
in the cluster.
.It Ev RCMD_CMD
Command to use to connect to remote machines.  The command chosen must
be able to connect with no password to the remote host.  Defaults to
.Ic rsh
.\" .Sh FILES
.Sh EXAMPLES
To find all the filesystems which are more than 90% full across your cluster,
you would issue:
.Bd -literal -offset indent
pdf -m 90
.Ed
.Sh DIAGNOSTICS
Exit status is 0 on success, 1 if an error occurs.
.Sh SEE ALSO
.Xr dsh 1 ,
.Xr df 1 ,
.Xr rsh 1 ,
.Xr kerberos 3 ,
.Xr hosts.equiv 5 ,
.Xr rhosts 5
.Sh HISTORY
The
.Nm
command appeared in clusterit 1.0. It is based on the
.Nm
command in IBM PSSP.
.Sh AUTHOR
.Nm Pdf
was written by Tim Rightnour.
.Sh BUGS
Output is formatted for 80 columns.  This means that mount points and
filesystems with long names
.Po
\*(Gt 20 characters
.Pc
will be truncated.  In
addition, numbers longer than 9 digits will be truncated as well.
.Pp
.Nm
will only work on nodes that produce the
.Xr df 1
output that it expects.  It has been made to work on HP-UX, Solaris, and
AIX, along with any BSD, and most versions of Linux.