21742bd2ec
- Added missing man pages for the new functions. - Updated the main libdivecomputer man page to reflect the new flow. - Fixed minor typos in the dc_parser_get_field and dc_parser_samples_foreach functions.
81 lines
2.0 KiB
Groff
81 lines
2.0 KiB
Groff
.\"
|
|
.\" libdivecomputer
|
|
.\"
|
|
.\" Copyright (C) 2020 Vincent Hagen <vinnie@script4web.nl>
|
|
.\"
|
|
.\" This library is free software; you can redistribute it and/or
|
|
.\" modify it under the terms of the GNU Lesser General Public
|
|
.\" License as published by the Free Software Foundation; either
|
|
.\" version 2.1 of the License, or (at your option) any later version.
|
|
.\"
|
|
.\" This library is distributed in the hope that it will be useful,
|
|
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
.\" Lesser General Public License for more details.
|
|
.\"
|
|
.\" You should have received a copy of the GNU Lesser General Public
|
|
.\" License along with this library; if not, write to the Free Software
|
|
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
.\" MA 02110-1301 USA
|
|
.\"
|
|
.Dd June 5, 2020
|
|
.Dt DC_SERIAL_OPEN 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm dc_serial_open
|
|
.Nd Opens an iostream for a serial device
|
|
.Sh LIBRARY
|
|
.Lb libdivecomputer
|
|
.Sh SYNOPSIS
|
|
.In libdivecomputer/serial.h
|
|
.Ft dc_status_t
|
|
.Fo dc_serial_open
|
|
.Fa "dc_iostream_t **iostream"
|
|
.Fa "dc_context_t *context"
|
|
.Fa "const char *name"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
Opens an iostream for a serial device.
|
|
Accepts a
|
|
.Fa context
|
|
opened with
|
|
.Xr dc_context_new 3
|
|
and a
|
|
.Fa name
|
|
device name, usually found through
|
|
.Xr dc_serial_iterator_new 3
|
|
with
|
|
.Xr dc_serial_device_get_name 3 .
|
|
.Pp
|
|
Upon returning
|
|
.Dv DC_STATUS_SUCCESS ,
|
|
the
|
|
.Fa iostream
|
|
pointer must be freed with
|
|
.Xr dc_iostream_close 3 .
|
|
.Sh RETURN VALUES
|
|
Returns
|
|
.Dv DC_STATUS_SUCCESS
|
|
on success or one of several error values on error.
|
|
On success, the
|
|
.Fa iostream
|
|
pointer is filled in with an open handle.
|
|
.Sh SEE ALSO
|
|
.Xr dc_context_new 3 ,
|
|
.Xr dc_iostream_close 3 ,
|
|
.Xr dc_usbhid_open 3 ,
|
|
.Xr dc_irda_open 3 ,
|
|
.Xr dc_bluetooth_open 3 ,
|
|
.Xr dc_serial_iterator_new 3 ,
|
|
.Xr dc_serial_device_get_name 3 .
|
|
.Sh AUTHORS
|
|
The
|
|
.Lb libdivecomputer
|
|
library was written by
|
|
.An Jef Driesen ,
|
|
.Mt jef@libdivecomputer.org .
|
|
.br
|
|
This manpage is written by
|
|
.An Vincent Hagen ,
|
|
.Mt vinnie@script4web.nl .
|