xref: /netbsd/usr.sbin/altq/altqd/altqd.8 (revision bf9ec67e)
1.\"	$NetBSD: altqd.8,v 1.7 2002/03/05 04:11:51 itojun Exp $
2.\"	$KAME: altqd.8,v 1.9 2002/01/23 06:56:27 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 September 28, 1999
29.Dt ALTQD 8
30.Os
31.Sh NAME
32.Nm altqd
33.Nd ALTQ daemon
34.Sh SYNOPSIS
35.Nm altqd
36.Op Fl dvD
37.Op Fl f Ar conf_file
38.Sh DESCRIPTION
39.Nm
40is a daemon program that reads a configuration file and then sets up
41the ALTQ state of network interfaces.
42After configuring the ALTQ state,
43.Nm
44will detach and become a daemon.
45.Pp
46The signal SIGINT or SIGTERM will shutdown
47.Nm Ns ,
48and the signal SIGHUP will restart
49.Nm Ns .
50.Pp
51The following options are available:
52.Bl -tag -width Fl
53.It Fl f
54Specify a configuration file to read instead of the default.
55The default file is
56.Pa /etc/altq.conf .
57.It Fl d
58Debug mode.
59.Nm
60does not detach and goes into the command mode.
61.It Fl v
62Print debugging information.
63This option implies
64.Fl d .
65.It Fl D
66Dummy mode.
67.Nm
68does not issue altq system calls.
69.El
70.Sh COMMANDS
71When
72.Fl d
73option is provided,
74.Nm
75goes into the command mode after reading the configuration file and
76setting up the ALTQ state.
77Each command is a single line, starting with the command verb.
78.Pp
79The basic commands are as follows:
80.Bl -tag -width help
81.It Cm help | ?
82Display a complete list of commands and their syntax.
83.It Cm quit
84Exit.
85.It Cm altq Ar reload
86Reload the configuration file and reinitialize ALTQ.
87.It Cm altq Ar interface Op enable|disable
88Enables or disables ALTQ on the interface named
89.Em interface .
90When
91.Nm
92enters the command mode, ALTQ is enabled on all the
93interfaces listed in the configuration file.
94.El
95.Sh FILES
96.Bl -tag -width /var/run/altqd.pid -compact
97.It Pa /etc/altq.conf
98configuration file
99.It Pa /var/run/altqd.pid
100pid of the running
101.Nm
102.It Pa /var/run/altq_quip
103Unix domain socket for communicating with
104.Xr altqstat 1
105.El
106.Sh SEE ALSO
107.Xr altqstat 1 ,
108.Xr altq.conf 5 ,
109.Xr altq 9
110