xref: /openbsd-src/lib/libfuse/fuse_chan_fd.3 (revision 41ce3b17e73f6b7d2d9e1a3d961e4bab2d895cb5)
1.\" $OpenBSD: fuse_chan_fd.3,v 1.3 2022/03/31 17:27:17 naddy Exp $
2.\"
3.\" Copyright (c) 2018 Helg Bredow <helg.bredow@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: March 31 2022 $
18.Dt FUSE_CHAN_FD 3
19.Os
20.Sh NAME
21.Nm fuse_chan_fd
22.Nd get the file descriptor for an open FUSE device
23.Sh SYNOPSIS
24.In fuse.h
25.Ft int
26.Fn fuse_chan_fd "struct fuse_chan *ch"
27.Sh DESCRIPTION
28.Fn fuse_chan_fd
29will return the file descriptor to the FUSE device opened for reading
30and writing by
31.Xr fuse_mount 3 .
32.Sh RETURN VALUES
33If successful,
34.Fn fuse_chan_fd
35returns a non-negative integer, termed a file descriptor.
36If
37.Fa ch
38is NULL, a value of -1 is returned.
39.Sh SEE ALSO
40.Xr fuse_mount 3 ,
41.Xr open 3 ,
42.Xr fuse 4
43.Sh STANDARDS
44The
45.Fn fuse_chan_fd
46function conforms to FUSE 2.6.
47.Sh HISTORY
48The
49.Fn fuse_chan_fd
50function first appeared in
51.Ox 5.4 .
52.Sh AUTHORS
53.An Sylvestre Gallon Aq Mt ccna.syl@gmail.com
54