f327c2ea8a213dfb1f8696bb5d34c969604fb468
[dragonfly.git] / usr.bin / sdpquery / sdpquery.1
1 .\" $NetBSD: sdpquery.1,v 1.8 2007/02/17 09:39:11 wiz Exp $
2 .\"
3 .\" Copyright (c) 2006 Itronix Inc.
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. The name of Itronix Inc. may not be used to endorse
15 .\"    or promote products derived from this software without specific
16 .\"    prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY
22 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 .\" ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .\" Copyright (c) 2003 Maksim Yevmenkin <m_evmenkin@yahoo.com>
31 .\" All rights reserved.
32 .\"
33 .\" Redistribution and use in source and binary forms, with or without
34 .\" modification, are permitted provided that the following conditions
35 .\" are met:
36 .\" 1. Redistributions of source code must retain the above copyright
37 .\"    notice, this list of conditions and the following disclaimer.
38 .\" 2. Redistributions in binary form must reproduce the above copyright
39 .\"    notice, this list of conditions and the following disclaimer in the
40 .\"    documentation and/or other materials provided with the distribution.
41 .\"
42 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
43 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
46 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
48 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
50 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
51 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 .\" SUCH DAMAGE.
53 .\"
54 .\" $Id: sdpquery.1,v 1.8 2007/02/17 09:39:11 wiz Exp $
55 .\" $FreeBSD: src/usr.sbin/bluetooth/sdpcontrol/sdpcontrol.8,v 1.6 2005/07/09 19:04:43 markus Exp $
56 .\"
57 .Dd February 17, 2007
58 .Dt SDPQUERY 1
59 .Os
60 .Sh NAME
61 .Nm sdpquery
62 .Nd SDP query utility
63 .Sh SYNOPSIS
64 .Nm
65 .Fl h
66 .Nm
67 .Op Fl d Ar device
68 .Fl a Ar address
69 .Ar command
70 .Op Ar parameters ...
71 .Nm
72 .Op Fl c Ar path
73 .Fl l
74 .Ar command
75 .Op Ar parameters ...
76 .Sh DESCRIPTION
77 The
78 .Nm
79 utility attempts to query the specified Service Discovery Protocol
80 (SDP) server.
81 Remote SDP servers are identified by their address.
82 Connection to the local SDP server is made via the control socket.
83 The
84 .Nm
85 utility uses Service Search Attribute Requests and prints results to
86 standard output and error messages to standard error.
87 .Pp
88 The options are as follows:
89 .Bl -tag -width ".Fl a Ar address"
90 .It Fl a Ar address
91 Connect to the remote device with the specified address.
92 The address can be specified as BD_ADDR or a name.
93 If a name was specified, the
94 .Nm
95 utility attempts to resolve the name via
96 .Xr bt_gethostbyname 3 .
97 If no remote address is given,
98 .Nm
99 attempts to contact a local SDP server via the control socket.
100 .It Fl c Ar path
101 Specify path to the control socket.
102 The default path is
103 .Pa /var/run/sdp .
104 .It Fl d Ar device
105 Connect from the local device with the specifed address.
106 The device can be specified by BD_ADDR or device name.
107 See
108 .Xr btconfig 8
109 for a list of devices available.
110 If no device is specified, the
111 .Nm
112 utility will use the best available.
113 .It Fl l
114 Query the local SDP server via the control socket.
115 .It Fl h
116 Display usage message and exit.
117 .El
118 .Pp
119 The currently supported commands in
120 .Nm
121 are:
122 .Pp
123 .Bl -tag -width ".Cm search Ar service" -compact
124 .It Cm Browse Op Ar group
125 Browse for services.
126 The
127 .Ar group
128 parameter is a 16-bit UUID of the group to browse.
129 If omitted, the Public Browse Group. is used.
130 .Pp
131 .It Cm Search Ar service
132 Search for the
133 .Ar service .
134 The
135 .Ar service
136 parameter is a 16-bit UUID of the service to search for.
137 For the following services it is possible to use service name
138 instead of service UUID:
139 .Pp
140 .Bl -tag -compact -width "OPUSH"
141 .It CIP
142 Common ISDN Access
143 .It CTP
144 Cordless Telephony
145 .It DUN
146 DialUp Networking
147 .It FAX
148 Fax
149 .It FTRN
150 OBEX File Transfer
151 .It GN
152 Group ad-hoc Network
153 .It HID
154 Human Interface Device
155 .It HF
156 Handsfree
157 .It HSET
158 Headset
159 .It LAN
160 LAN Access Using PPP
161 .It NAP
162 Network Access Point
163 .It OPUSH
164 OBEX Object Push
165 .It PANU
166 Personal Area Networking User
167 .It SP
168 Serial Port
169 .El
170 .El
171 .Sh EXIT STATUS
172 .Ex -std
173 .Sh SEE ALSO
174 .Xr bluetooth 3 ,
175 .Xr sdp 3 ,
176 .Xr btconfig 8 ,
177 .Xr sdpd 8
178 .Sh HISTORY
179 The
180 .Nm
181 command first appeared in
182 .Fx 5.3
183 as
184 .Nm sdpcontrol .
185 It was ported to
186 .Nx 4.0
187 under its present name by
188 .An Iain Hibbert
189 under the sponsorship of Itronix, Inc and imported into
190 .Dx 1.11 .
191 .Sh AUTHORS
192 .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
193 .An Iain Hibbert
194 for Itronix, Inc.
195 .Sh CAVEATS
196 The
197 .Nm
198 utility only requests the following attributes from the SDP server:
199 .Pp
200 .Bl -enum -offset indent -compact
201 .It
202 Service Record Handle
203 .It
204 Service Class ID List
205 .It
206 Protocol Descriptor List
207 .It
208 Bluetooth Profile Descriptor List
209 .El