NetBSD/usr.sbin/pim6sd/pim6stat.1

.\"	$NetBSD: pim6stat.1,v 1.5 2000/12/04 07:09:36 itojun Exp $
.\"	$KAME: pim6stat.1,v 1.8 2000/12/04 06:28:26 itojun Exp $
.\"
.\" Copyright (C) 1999 WIDE Project.
.\" 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. Neither the name of the project nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``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 THE PROJECT OR CONTRIBUTORS 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.
.\"
.Dd July 28, 1999
.Dt PIM6STAT 1
.Os
.Sh NAME
.Nm pim6stat
.Nd show PIM for IPv6 status
.Sh SYNOPSIS
.Nm
.Op Fl ds
.Op Fl f Ar dumpfile
.Op Fl p Ar pidfile
.Op Fl w Ar waitsec
.Sh DESCRIPTION
.Nm
shows status or statistics of the PIM for IPv6 daemon currently running.
When invoked, it sends a signal to let the daemon dump its internal
status to a file, waits for dumping, and outputs the content of the file
to standard output.
.Pp
Options supported by
.Nm Ns :
.Bl -tag -width Ds
.It Fl d
specifies to show the status of a dense mode daemon (if running).
By default,
.Nm
assumes sparse mode.
.It Fl f
specifies the dumpfile to which the PIM daemon dumps its status.
.It Fl p
specifies the PID file of the currently running daemon.
.It Fl s
specifies to dump statistics instead of status (for sparse mode only).
.It Fl w
specifies the wait period in seconds between sending a signal to the
daemon and dumping the status or statistics to the dumpfile.
.El
.Sh FILES
.Bl -tag -width /var/run/pim6sd.pidX -compact
.It Pa /var/run/pim6sd.pid
The default PID file for a sparse mode daemon.
.It Pa /var/run/pim6dd.pid
The default PID file for a dense mode daemon.
.It Pa /var/run/pim6sd.dump
The default dump file for a sparse mode daemon.
.It Pa /var/run/pim6dd.dump
The default dump file for a dense mode daemon.
.It Pa /var/run/pim6sd.stat
The default statistics dump file for a sparse mode daemon.
.El
.Sh SEE ALSO
.Xr pim6dd 8 ,
.Xr pim6sd 8
.Sh HISTORY
The
.Nm
command first appeared in KAME IPv6 protocol stack kit.
.Sh BUGS
.Nm
needs superuser privilege.
.\"