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