diff options
| author | plunky <plunky@NetBSD.org> | 2009-05-20 17:22:56 +0000 |
|---|---|---|
| committer | plunky <plunky@NetBSD.org> | 2009-05-20 17:22:56 +0000 |
| commit | 60180f5cfb9ee057365f56a622912e152726179d (patch) | |
| tree | b1d28e6855ceb375e767eed3468c094b336d3a14 /lib/libbluetooth | |
| parent | e8266b2f6ad19314ea248747c0599a504a76c2dc (diff) | |
adjust markup language according to mdoc(7)
.Fa for function arguments (instead of Ar)
.Va for variable names (errno)
.Ft for structure type
Diffstat (limited to 'lib/libbluetooth')
| -rw-r--r-- | lib/libbluetooth/sdp.3 | 40 | ||||
| -rw-r--r-- | lib/libbluetooth/sdp_data.3 | 22 |
2 files changed, 31 insertions, 31 deletions
diff --git a/lib/libbluetooth/sdp.3 b/lib/libbluetooth/sdp.3 index bb9ead49dbd..2da852d708c 100644 --- a/lib/libbluetooth/sdp.3 +++ b/lib/libbluetooth/sdp.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: sdp.3,v 1.2 2009/05/12 10:32:45 wiz Exp $ +.\" $NetBSD: sdp.3,v 1.3 2009/05/20 17:22:56 plunky Exp $ .\" .\" Copyright (c) 2009 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -118,7 +118,7 @@ not currently enforced. .Bl -tag -width xxxx .It Fn sdp_open "laddr" "raddr" Open a SDP session to a remote Bluetooth device. -.Ar laddr +.Fa laddr refers to the local bluetooth device address and may be .Dv NULL in which case it will default to @@ -126,7 +126,7 @@ in which case it will default to .It Fn sdp_open_local "control" Open a SDP session to a server using a local socket. The -.Ar control +.Fa control socket path may be given as .Dv NULL in which case the default control path @@ -137,55 +137,55 @@ Close SDP session and release all resources. .It Fn sdp_service_search "ss" "ssp" "handlep" "num" Perform a complete ServiceSearch transaction on the SDP session. At most -.Ar num +.Fa num service record handles matching the ServiceSearchPattern -.Ar ssp +.Fa ssp will be returned in the array pointed to by -.Ar handlep . +.Fa handlep . .It Fn sdp_service_attribute "ss" "handle" "ail" "response" Perform a complete ServiceAttribute transaction on the SDP session. The ServiceRecord with ServiceRecordHandle -.Ar handle +.Fa handle will be parsed using the AttributeIDList -.Ar ail . +.Fa ail . If the transaction succeeds, the -.Ar response +.Fa response data buffer will contain a validated data element list of attribute ID/value pairs from the selected record. .It Fn sdp_service_search_attribute "ss" "ssp" "ail" "response" Perform a complete ServiceSearchAttribute transaction on the SDP session. All ServiceRecords matching the ServiceSearchPattern -.Ar ssp +.Fa ssp will be parsed using the AttributeIDList -.Ar ail . +.Fa ail . If the transaction succeeds, the -.Ar response +.Fa response data buffer will contain a valid data element list of sequences, where each sequence is the attribute ID/value list from a matched record. .It Fn sdp_record_insert "ss" "bdaddr" "handlep" "record" Insert a ServiceRecord -.Ar record . +.Fa record . If -.Ar bdaddr +.Fa bdaddr is given, the service record will be restricted to clients connecting through the Bluetooth controller with that BD_ADDR. When the -.Ar handlep +.Fa handlep pointer is non NULL, the resulting ServiceRecordHandle will be written to the address given. The record will be valid while the session is active and will be purged when the session is closed. .It Fn sdp_record_update "ss" "handle" "record" Update a ServiceRecord that is owned by this session. -.Ar handle +.Fa handle is the identifier returned by the .Fn sdp_record_insert call, and -.Ar record +.Fa record is the updated ServiceRecord as described above. .It Fn sdp_record_remove "ss" "handle" Remove a ServiceRecord owned by this session. -.Ar handle +.Fa handle is the identifier returned by the .Fn sdp_record_insert call. @@ -214,7 +214,7 @@ on failure. For service lookup and record manipulation routines, a boolean value is returned indicating success or failure. On failure, -.Ar errno +.Va errno will be set to indicate the error. .Sh FILES .Pa /var/run/sdp @@ -229,7 +229,7 @@ A provided function argument was not valid. A response from the remote server was not understood. .It Bq Er ENOATTR The record -.Ar handle +.Fa handle did not exist on the server. .El .Sh SEE ALSO diff --git a/lib/libbluetooth/sdp_data.3 b/lib/libbluetooth/sdp_data.3 index 302f114aa36..f11e8c80ff9 100644 --- a/lib/libbluetooth/sdp_data.3 +++ b/lib/libbluetooth/sdp_data.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: sdp_data.3,v 1.1 2009/05/12 10:05:06 plunky Exp $ +.\" $NetBSD: sdp_data.3,v 1.2 2009/05/20 17:22:56 plunky Exp $ .\" .\" Copyright (c) 2009 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -166,9 +166,9 @@ typedef struct { .Ed .Pp Where -.Ar next +.Fa next points to the next available byte, and -.Ar end +.Fa end points to the first address past end of the data area, such that .Qq end = next + length . .Pp @@ -215,7 +215,7 @@ UUID with 16-bit value given. If the UUID matches, the function will return .Dv true and the -.Ar next +.Fa next field of the SDP data buffer will be advanced to the next element. Otherwise .Dv false @@ -225,16 +225,16 @@ routines examine the next data element in the data buffer for an element of the given type. If the type matches, the function will extract the typed value to the address given and advance the -.Ar next +.Fa next field of the SDP data buffer to the next element then return .Dv true . Otherwise .Dv false will be returned. Note, these functions will not modify the -.Ar data +.Fa data argument unless the correct type was found, and will update the -.Ar data +.Fa data argument first to allow discarding in the case where a .Dv sdp_data_t was being returned. @@ -247,14 +247,14 @@ the function will return otherwise .Dv true will be returned and the -.Ar next +.Fa next field of the SDP data pointer will be advanced. In the case of .Fn sdp_put_seq and .Fn sdp_put_alt , the -.Ar length +.Fa length argument may be -1, in which case the generated sequence header will describe all the remaining buffer space. For @@ -262,7 +262,7 @@ For and .Fn sdp_put_url the -.Ar length +.Fa length argument may be -1 in which case the string pointer is treated as nul terminated. .It The Fn sdp_set_xxxx @@ -279,7 +279,7 @@ In the case of and .Fn sdp_set_alt , the -.Ar length +.Fa length argument may be -1, in which case the sequence header will be adjusted to describe the entire data space where possible. .It The Fn sdp_data_xxxx |
