xref: /netbsd/usr.sbin/altq/altqstat/altqstat.1 (revision 6550d01e)
1.\"	$NetBSD: altqstat.1,v 1.6 2002/01/19 03:05:35 wiz Exp $
2.\"	$KAME: altqstat.1,v 1.6 2001/08/22 08:50:49 itojun Exp $
3.\"
4.\" Copyright (C) 2000
5.\" Sony Computer Science Laboratories Inc.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd December 24, 1999
29.Dt ALTQSTAT 1
30.Os
31.Sh NAME
32.Nm altqstat
33.Nd show altq status
34.Sh SYNOPSIS
35.Nm altqstat
36.Op Fl enrs
37.Op Fl c Ar count
38.Op Fl w Ar wait
39.Op Fl i Ar interface
40.Op Fl I Ar input_interface
41.Sh DESCRIPTION
42The
43.Nm altqstat
44command displays the status of a queueing discipline.  The contents
45displayed by
46.Nm
47is specific to each queueing discipline.
48.Pp
49The options are as follows:
50.Bl -tag -width Fl
51.It Fl e
52Echo communication with
53.Xr altqd 8
54to standard output.  This option is for debugging.
55.It Fl n
56Disable communication with
57.Xr altqd 8 .
58The interface should be explicitly specified.
59.It Fl r
60Enter the raw console mode to talk to
61.Xr altqd 8 .
62This option is for debugging queue information exchange between
63.Nm
64and
65.Xr altqd 8 .
66.It Fl s
67List all interfaces, classes and filters currently installed.
68.It Fl c Ar count
69.Nm
70exits after displaying
71.Ar count
72times.  If no repeat
73.Ar count
74is specified, the default is infinity.
75.It Fl w Ar wait
76Pause
77.Ar wait
78seconds between each display.  If no repeat
79.Ar wait
80interval is specified, the default is 5 seconds.
81.It Fl i Ar interface
82Show information about the specified interface.  If no
83.Ar interface
84is specified, the default interface is the first interface returned
85from
86.Xr altqd 8 .
87.It Fl I Ar input_interface
88Show information about the specified input interface.  This option is
89used to specify
90.Em traffic conditioner
91at an input interface.
92.El
93.Sh FILES
94.Bl -tag -width /var/run/altqd.pid -compact
95.It Pa /var/run/altq_quip
96Unix domain socket for communicating with
97.Xr altqd 8
98.El
99.Sh SEE ALSO
100.Xr altq.conf 5 ,
101.Xr altqd 8 ,
102.Xr altq 9
103