xref: /netbsd/usr.sbin/cnwctl/cnwctl.8 (revision bf9ec67e)
1.\"	$NetBSD: cnwctl.8,v 1.2 1999/11/29 12:55:07 itojun Exp $
2.\"
3.\" Copyright (c) 1997 Berkeley Software Design, Inc. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that this notice is retained,
7.\" the conditions in the following notices are met, and terms applying
8.\" to contributors in the following notices also apply to Berkeley
9.\" Software Design, Inc.
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"      This product includes software developed by
19.\"	Berkeley Software Design, Inc.
20.\" 4. Neither the name of the Berkeley Software Design, Inc. nor the names
21.\"    of its contributors may be used to endorse or promote products derived
22.\"    from this software without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN, INC. ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN, INC. BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"	PAO2 Id: cnwctl.8,v 1.1.1.1 1997/12/11 14:46:06 itojun Exp
37.\"
38.Dd January 5, 1997
39.Dt CNWCTL 8
40.Os
41.Sh NAME
42.Nm cnwctl
43.Nd display statistics and control Netwave AirSurfer PC Cards
44.Sh SYNOPSIS
45.Nm cnwctl
46.Op Fl d Ar domain
47.Op Fl i Ar interface
48.Op Fl k Ar scramble-key
49.Op Fl sS Op Ar rate
50.Sh DESCRIPTION
51The
52.Nm cnwctl
53utility is used to control Netwave AirSurfer PC Cards as well as
54display statistics.
55The following options are available:
56.
57.Bl -tag -width indent
58.It Fl d
59Set the domain of the card to
60.Ar domain .
61The domain must be between 0x000 and 0x1ff.
62The domains 0x000 through 0x0ff are for access to an add-hoc network.
63The domains 0x100 through 0x1ff are for access to a Netwave Access Point.
64The default domain is 0x000.
65A card may only talk to the access point in its domain, or other cards
66in its add-hoc domain.
67.It Fl i
68Use
69.Ar interface
70as the interface rather than
71.Li cnw0 .
72.It Fl k
73Set the scramble key to
74.Ar scramble-key .
75The scramble key must be between 0x0000 and 0xffff.
76Both the source and the destination must use the same scramble key
77in order to communicate.
78.It Fl s
79Display statistics.
80When the optional argument
81.Ar rate
82(which must be the last argument to the end of the command line)
83is specified as a non-zero value, statistics will be displayed
84every
85.Ar rate
86seconds.
87At the top of each
88.Dq page
89of statistics, column labels will be displayed.  The first row of
90statistics will be totals since boot, subsequent lines are deltas
91from the previous row.
92If
93.Ar rate
94is not specified, or is 0 (zero), a single page of statistics will be
95displayed.  These statistics are more detailed and include:
96.Bl -tag -width indent
97.It domain
98The domain this card is part of.
99.It rx
100Number of packets received.
101.It rxoverflow
102Number of overflows detected.
103.It rxoverrun
104Number of overruns detected.
105.It rxcrcerror
106Number of CRC errors detected.
107Random noise can cause these errors.
108.It rxframe
109Number of framing errors detected.
110.It rxerrors
111Number of generic errors detected.
112.It rxavail
113Number of times a packet was available.
114.It tx
115Number of packets requested to be sent.
116.It txokay
117Number of packets sent.
118.It txabort
119Number of packets aborted (not sent within 9 tries).
120.It txlostcd
121Number of times carrier detect was lost.
122.It txerrors
123Number of generic transmit errors detected.
124.It txretries
125Total number of retries.
126.It Ar N Ns No x retries
127Number of packets which were retried
128.Ar N
129times.
130.El
131.It Fl S
132Display status read from the hardware.  This option is only available
133to the super user.
134The
135.Ar rate
136argument is used as with the
137.Fl s
138option.
139The following fields are displayed
140.Bl -tag -width indent
141.It link integrity field (lif)
142A 0 value implies no links.
143.It connection quality (cq)
144Probably indicates the quality of the connection to the access point.
145.It spu
146Unknown meaning.
147.It link quality (lq)
148Probably indicated the quality of the link to the access point.
149.It hhc
150Unknown meaning.
151.It mhs
152Unknown meaning.
153.It revision
154The revision numbers of the card.
155.It id
156The ID of the card.
157.El
158.El
159.Sh SEE ALSO
160.Xr cnw 4
161