xref: /netbsd/usr.sbin/altq/altqd/altqd.8 (revision 6550d01e)
1.\"	$NetBSD: altqd.8,v 1.11 2006/12/23 08:25:44 wiz 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 November 26, 2006
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 dv
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 signals
47.Dv SIGINT
48or
49.Dv SIGTERM
50will shutdown
51.Nm ,
52and the signal
53.Dv SIGHUP
54will restart
55.Nm .
56.Pp
57The following options are available:
58.Bl -tag -width Fl
59.It Fl d
60Debug mode.
61.Nm
62does not detach and goes into the command mode.
63.It Fl f Ar conf_file
64Specify a configuration file to read instead of the default.
65The default file is
66.Pa /etc/altq.conf .
67.It Fl v
68Print debugging information.
69This option implies
70.Fl d .
71.El
72.Sh COMMANDS
73When
74.Fl d
75option is provided,
76.Nm
77goes into the command mode after reading the configuration file and
78setting up the ALTQ state.
79Each command is a single line, starting with the command verb.
80.Pp
81The basic commands are as follows:
82.Bl -tag -width help
83.It Cm help | \&?
84Display a complete list of commands and their syntax.
85.It Cm quit
86Exit.
87.It Cm altq Ar reload
88Reload the configuration file and reinitialize ALTQ.
89.It Cm altq Ar interface Op enable|disable
90Enables or disables ALTQ on the interface named
91.Em interface .
92When
93.Nm
94enters the command mode, ALTQ is enabled on all the
95interfaces listed in the configuration file.
96.El
97.Sh FILES
98.Bl -tag -width /var/run/altqd.pid -compact
99.It Pa /etc/altq.conf
100configuration file
101.It Pa /var/run/altqd.pid
102pid of the running
103.Nm
104.It Pa /var/run/altq_quip
105Unix domain socket for communicating with
106.Xr altqstat 1
107.El
108.Sh SEE ALSO
109.Xr altqstat 1 ,
110.Xr altq.conf 5 ,
111.Xr altq 9
112