xref: /netbsd-src/usr.sbin/altq/altqstat/altqstat.1 (revision d90cc3e3f69906d795fb02109d13e6fe6e44802f)
1.\"	$NetBSD: altqstat.1,v 1.7 2019/04/09 18:21:15 sevan 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 April 9, 2019
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.
45The contents displayed 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.
55This option is for debugging.
56.It Fl n
57Disable communication with
58.Xr altqd 8 .
59The interface should be explicitly specified.
60.It Fl r
61Enter the raw console mode to talk to
62.Xr altqd 8 .
63This option is for debugging queue information exchange between
64.Nm
65and
66.Xr altqd 8 .
67.It Fl s
68List all interfaces, classes and filters currently installed.
69.It Fl c Ar count
70.Nm
71exits after displaying
72.Ar count
73times.
74If no repeat
75.Ar count
76is specified, the default is infinity.
77.It Fl w Ar wait
78Pause
79.Ar wait
80seconds between each display.
81If no repeat
82.Ar wait
83interval is specified, the default is 5 seconds.
84.It Fl i Ar interface
85Show information about the specified interface.
86If no
87.Ar interface
88is specified, the default interface is the first interface returned
89from
90.Xr altqd 8 .
91.It Fl I Ar input_interface
92Show information about the specified input interface.
93This option is used to specify
94.Em traffic conditioner
95at an input interface.
96.El
97.Sh FILES
98.Bl -tag -width /var/run/altqd.pid -compact
99.It Pa /var/run/altq_quip
100Unix domain socket for communicating with
101.Xr altqd 8
102.El
103.Sh SEE ALSO
104.Xr altq.conf 5 ,
105.Xr altqd 8 ,
106.Xr altq 9
107