xref: /freebsd/usr.sbin/bluetooth/l2ping/l2ping.8 (revision 8fc257994d0ce2396196d7a06d50d20c8015f4b7)
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 fhn
37.Fl a Ar remote
38.Op Fl c Ar count
39.Op Fl i Ar delay
40.Op Fl S Ar source
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
49datagram from a remote device.
50.Pp
51The options are as follows:
52.Bl -tag -width indent
53.It Fl a Ar remote
54Specify the remote device to ping.
55The remote device can be specified by either its BD_ADDR or name.
56If name was specified then the
57.Nm
58utility will attempt to resolve the name via
59.Xr bt_gethostbyname 3 .
60.It Fl c Ar count
61Number of packets to send.
62If this option is not specified,
63.Nm
64will operate until interrupted.
65.It Fl f
66.Dq Flood
67ping, i.e., no delay between packets.
68.It Fl h
69Display usage message and exit.
70.It Fl i Ar wait
71Wait
72.Ar wait
73seconds between sending each packet.
74The default is to wait for one second between each packet.
75This option is ignored if
76.Fl f
77has been specified.
78.It Fl n
79Numeric output only.
80No attempt will be made to look up symbolic names for host addresses.
81.It Fl S Ar source
82Specify the local device which should be used to send L2CAP
83.Dv ECHO_REQUEST
84datagrams.
85The local device can be specified by either its BD_ADDR or name.
86If name was specified then the
87.Nm
88utility will attempt to resolve the name via
89.Xr bt_gethostbyname 3 .
90.It Fl s Ar size
91Specify the number of payload bytes to be sent.
92The default size is 44 bytes.
93It is calculated as minimum L2CAP MTU (48 bytes) minus the size of the L2CAP
94signalling command header (4 bytes).
95The maximum size is 65531 bytes.
96Is is calculated as maximum L2CAP MTU
97(65535 bytes) minus four bytes of payload reserved for
98.Nm
99internal use.
100Use this option with caution.
101Some implementations may not like large sizes and may hang or even crash.
102.El
103.Sh EXIT STATUS
104.Ex -std
105.Sh SEE ALSO
106.Xr bluetooth 3 ,
107.Xr netgraph 3 ,
108.Xr netgraph 4 ,
109.Xr ng_l2cap 4 ,
110.Xr l2control 8
111.Sh AUTHORS
112.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
113.Sh BUGS
114Could collect more statistic.
115Could check for duplicated, corrupted and lost packets.
116