xref: /freebsd/usr.sbin/bluetooth/l2ping/l2ping.8 (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
1.\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin@yahoo.com>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: l2ping.8,v 1.3 2003/05/21 01:00:19 max Exp $
26.\" $FreeBSD$
27.\"
28.Dd June 14, 2002
29.Dt L2PING 8
30.Os
31.Sh NAME
32.Nm l2ping
33.Nd send L2CAP ECHO_REQUEST to remote devices
34.Sh SYNOPSIS
35.Nm
36.Op Fl fh
37.Fl a Ar BD_ADDR
38.Op Fl c Ar count
39.Op Fl i Ar delay
40.Op Fl S Ar BD_ADDR
41.Op Fl s Ar size
42.Sh DESCRIPTION
43The
44.Nm
45utility uses L2CAP
46.Dv ECHO_REQUEST
47datagram to elicit an L2CAP
48.Dv ECHO_RESPONSE
49from a remote device.
50.Pp
51The options are as follows:
52.Bl -tag -width indent
53.It Fl a Ar BD_ADDR
54Address of remote device to ping.
55Example:
56.Fl a Li 00:01:02:03:04:05 .
57.It Fl c Ar count
58Number of packets to send.
59If this option is not specified,
60.Nm
61will operate until interrupted.
62.It Fl f
63.Dq Flood
64ping, i.e., no delay between packets.
65.It Fl h
66Display usage message and exit.
67.It Fl i Ar wait
68Wait
69.Ar wait
70seconds between sending each packet.
71The default is to wait for one second between each packet.
72This option is ignored if
73.Fl f
74has been specified.
75.It Fl S Ar BD_ADDR
76Send L2CAP
77.Dv ECHO_REQUEST
78from local device that has
79.Ar BD_ADDR .
80Example:
81.Fl S Li 00:05:04:03:02:01 .
82.It Fl s Ar size
83Specify the number of payload bytes to be sent.
84The default is the minimum L2CAP MTU minus the size of the L2CAP signalling
85command header (44 bytes).
86The maximum size is 65531.
87Use this option with caution.
88Some implementations may not like large sizes and may hang or even crash.
89.El
90.Sh BUGS
91Could collect more statistic.
92Could check for duplicated, corrupted and lost packets.
93.Sh DIAGNOSTICS
94.Ex -std
95.Sh SEE ALSO
96.Xr netgraph 3 ,
97.Xr netgraph 4 ,
98.Xr ng_l2cap 4 ,
99.Xr l2control 8
100.Sh AUTHORS
101.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
102