Sync usage with man page.
[netbsd-mini2440.git] / usr.bin / sdpquery / sdpquery.1
blob8eabae54ed9ef7ac12a190535965c4890c0d249c
1 .\"     $NetBSD: sdpquery.1,v 1.13 2009/10/06 21:39:58 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) 2009 The NetBSD Foundation, Inc.
31 .\" Copyright (c) 2003 Maksim Yevmenkin <m_evmenkin@yahoo.com>
32 .\" All rights reserved.
33 .\"
34 .\" Redistribution and use in source and binary forms, with or without
35 .\" modification, are permitted provided that the following conditions
36 .\" are met:
37 .\" 1. Redistributions of source code must retain the above copyright
38 .\"    notice, this list of conditions and the following disclaimer.
39 .\" 2. Redistributions in binary form must reproduce the above copyright
40 .\"    notice, this list of conditions and the following disclaimer in the
41 .\"    documentation and/or other materials provided with the distribution.
42 .\"
43 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
44 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
47 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 .\" SUCH DAMAGE.
54 .\"
55 .\" $FreeBSD: src/usr.sbin/bluetooth/sdpcontrol/sdpcontrol.8,v 1.6 2005/07/09 19:04:43 markus Exp $
56 .\"
57 .Dd October 6, 2009
58 .Dt SDPQUERY 1
59 .Os
60 .Sh NAME
61 .Nm sdpquery
62 .Nd Service Discovery Protocol query utility
63 .Sh SYNOPSIS
64 .Nm
65 .Op Fl NRX
66 .Op Fl d Ar device
67 .Fl a Ar address
68 .Ar command
69 .Op Ar parameters ...
70 .Nm
71 .Op Fl NRX
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 retrieves complete Service Records as directed and prints
86 each record's attribute ID/value list to standard output and error
87 messages to standard error.
88 .Pp
89 The options are as follows:
90 .Bl -tag -width ".Fl a Ar address"
91 .It Fl a Ar address
92 Connect to the remote device with the specified address.
93 The address can be specified as BD_ADDR or a name.
94 If a name was specified, the
95 .Nm
96 utility attempts to resolve the name via
97 .Xr bt_gethostbyname 3 .
98 If no remote address is given,
99 .Nm
100 attempts to contact a local SDP server via the control socket.
101 .It Fl c Ar path
102 Specify path to the control socket.
103 The default path is
104 .Pa /var/run/sdp .
105 .It Fl d Ar device
106 Connect from the local device with the specifed address.
107 The device can be specified by BD_ADDR or device name.
109 .Xr btconfig 8
110 for a list of devices available.
111 If no device is specified, the
113 utility will use the best available.
114 .It Fl l
115 Query the local SDP server via the control socket.
116 .It Fl N
117 Additionally display numerical values.
118 .It Fl R
119 Display service attributes in raw (uninterpreted) format.
120 .It Fl X
121 Display service attribute values in hex.
124 The currently supported commands in
126 are:
128 .Bl -tag -width Browse -compact
129 .It Cm Browse Op Ar group
130 Browse for services.
132 .Ar group
133 parameter is the UUID of the group to browse.
134 If omitted, the "Public Browse Group" is used.
136 .It Cm Record Ar handle Op Ar handle...
137 Retrieve the Service Record with the given
138 .Ar handle .
139 Multiple handles can be given.
141 .It Cm Search Ar uuid Op Ar uuid...
142 Search for records matching the list of
143 UUIDs which can be given in numerical form, or the
144 following aliases are known:
146 .Bl -tag -offset indent -compact -width RFCOMMxxx
147 .It A2DP
148 Advanced Audio Distribution Profile
149 .It BNEP
150 Bluetooth Network Encapsulation Protocol
151 .It CIP
152 Common ISDN Access Service
153 .It CTP
154 Cordless Telephony Service
155 .It DUN
156 Dialup Networking Service
157 .It FAX
158 Fax Service
159 .It FTRN
160 File Transfer Service
161 .It GN
162 Group ad-hoc Network Service
163 .It HID
164 Human Interface Device Service
165 .It HF
166 Handsfree Service
167 .It HSET
168 Headset Service
169 .It L2CAP
170 Logical Link Control and Adaptation Protocol
171 .It LAN
172 LAN Access Using PPP Service
173 .It NAP
174 Network Access Point Service
175 .It OBEX
176 Object Exchange Protocol
177 .It OPUSH
178 Object Push Service
179 .It PANU
180 Personal Area Networking User Service
181 .It PNP
182 Plug'n'Play Information Service
183 .It RFCOMM
184 RFCOMM Protocol
185 .It SDP
186 Service Discovery Protocol
187 .It SP
188 Serial Port Service
189 .It SYNC
190 IrMC Sync Client Service
193 Note that in order for a record to match, it must contain all the
194 UUIDs in the ServiceSearchPattern and the maximum number is 12.
196 .Sh EXIT STATUS
197 .Ex -std
198 .Sh SEE ALSO
199 .Xr bluetooth 3 ,
200 .Xr sdp 3 ,
201 .Xr btconfig 8 ,
202 .Xr sdpd 8
203 .Sh HISTORY
206 command first appeared in
207 .Fx 5.3
209 .Nm sdpcontrol .
210 It was ported to
211 .Nx 4.0
212 under its present name by
213 .An Iain Hibbert
214 under the sponsorship of Itronix, Inc.
215 .Sh AUTHORS
216 .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
217 .An Iain Hibbert
218 for Itronix, Inc.