xref: /freebsd/usr.sbin/bluetooth/l2ping/l2ping.8 (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
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 March 29, 2011
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 wait
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
66Do not wait between sending each packet.
67.It Fl h
68Display usage message and exit.
69.It Fl i Ar wait
70Wait
71.Ar wait
72seconds between sending each packet.
73The default is to wait for one second between each packet.
74This option is ignored if
75.Fl f
76has been specified.
77.It Fl n
78Numeric output only.
79No attempt will be made to look up symbolic names for host addresses.
80.It Fl S Ar source
81Specify the local device which should be used to send L2CAP
82.Dv ECHO_REQUEST
83datagrams.
84The local device can be specified by either its BD_ADDR or name.
85If name was specified then the
86.Nm
87utility will attempt to resolve the name via
88.Xr bt_gethostbyname 3 .
89.It Fl s Ar size
90Specify the number of payload bytes to be sent.
91The default size is 44 bytes.
92It is calculated as minimum L2CAP MTU (48 bytes) minus the size of the L2CAP
93signalling command header (4 bytes).
94The maximum size is 65531 bytes.
95Is is calculated as maximum L2CAP MTU
96(65535 bytes) minus four bytes of payload reserved for
97.Nm
98internal use.
99Use this option with caution.
100Some implementations may not like large sizes and may hang or even crash.
101.El
102.Sh EXIT STATUS
103.Ex -std
104.Sh SEE ALSO
105.Xr bluetooth 3 ,
106.Xr netgraph 3 ,
107.Xr netgraph 4 ,
108.Xr ng_l2cap 4 ,
109.Xr l2control 8
110.Sh AUTHORS
111.An Maksim Yevmenkin Aq Mt emax@FreeBSD.org
112.Sh BUGS
113Could collect more statistic.
114Could check for duplicated, corrupted and lost packets.
115