| @@ -1,39 +1,39 @@ | | | @@ -1,39 +1,39 @@ |
1 | .\" $NetBSD: ukfs.3,v 1.15 2018/02/08 09:05:17 dholland Exp $ | | 1 | .\" $NetBSD: ukfs.3,v 1.16 2018/03/12 11:56:34 pgoyette Exp $ |
2 | .\" | | 2 | .\" |
3 | .\" Copyright (c) 2008 Antti Kantee. All rights reserved. | | 3 | .\" Copyright (c) 2008 Antti Kantee. All rights reserved. |
4 | .\" | | 4 | .\" |
5 | .\" Redistribution and use in source and binary forms, with or without | | 5 | .\" Redistribution and use in source and binary forms, with or without |
6 | .\" modification, are permitted provided that the following conditions | | 6 | .\" modification, are permitted provided that the following conditions |
7 | .\" are met: | | 7 | .\" are met: |
8 | .\" 1. Redistributions of source code must retain the above copyright | | 8 | .\" 1. Redistributions of source code must retain the above copyright |
9 | .\" notice, this list of conditions and the following disclaimer. | | 9 | .\" notice, this list of conditions and the following disclaimer. |
10 | .\" 2. Redistributions in binary form must reproduce the above copyright | | 10 | .\" 2. Redistributions in binary form must reproduce the above copyright |
11 | .\" notice, this list of conditions and the following disclaimer in the | | 11 | .\" notice, this list of conditions and the following disclaimer in the |
12 | .\" documentation and/or other materials provided with the distribution. | | 12 | .\" documentation and/or other materials provided with the distribution. |
13 | .\" | | 13 | .\" |
14 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | | 14 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
15 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | | 15 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
16 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | | 16 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
17 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | | 17 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
18 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | | 18 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
19 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | | 19 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
20 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | | 20 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
21 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | | 21 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
22 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | | 22 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
23 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | | 23 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
24 | .\" SUCH DAMAGE. | | 24 | .\" SUCH DAMAGE. |
25 | .\" | | 25 | .\" |
26 | .Dd February 13, 2014 | | 26 | .Dd March 12, 2018 |
27 | .Dt UKFS 3 | | 27 | .Dt UKFS 3 |
28 | .Os | | 28 | .Os |
29 | .Sh NAME | | 29 | .Sh NAME |
30 | .Nm ukfs | | 30 | .Nm ukfs |
31 | .Nd user kernel file system library interface | | 31 | .Nd user kernel file system library interface |
32 | .Sh LIBRARY | | 32 | .Sh LIBRARY |
33 | ukfs Library (libukfs, \-lukfs) | | 33 | ukfs Library (libukfs, \-lukfs) |
34 | .Sh SYNOPSIS | | 34 | .Sh SYNOPSIS |
35 | .In rump/ukfs.h | | 35 | .In rump/ukfs.h |
36 | .Sh DESCRIPTION | | 36 | .Sh DESCRIPTION |
37 | The | | 37 | The |
38 | .Nm | | 38 | .Nm |
39 | library provides direct access to file systems without having to | | 39 | library provides direct access to file systems without having to |
| @@ -47,27 +47,27 @@ is built upon | | | @@ -47,27 +47,27 @@ is built upon |
47 | .Xr rump 3 | | 47 | .Xr rump 3 |
48 | kernels, all kernel file systems which are supported by rump kernels | | 48 | kernels, all kernel file systems which are supported by rump kernels |
49 | are available. | | 49 | are available. |
50 | It allows to write utilities for accessing file systems | | 50 | It allows to write utilities for accessing file systems |
51 | without having to duplicate file system internals knowledge already | | 51 | without having to duplicate file system internals knowledge already |
52 | present in kernel file system drivers. | | 52 | present in kernel file system drivers. |
53 | .Pp | | 53 | .Pp |
54 | .Nm | | 54 | .Nm |
55 | provides a high-level pathname based interface for accessing file systems. | | 55 | provides a high-level pathname based interface for accessing file systems. |
56 | If a lower level interface it desired, | | 56 | If a lower level interface it desired, |
57 | .Xr rump 3 | | 57 | .Xr rump 3 |
58 | kernels should be used directly. | | 58 | kernels should be used directly. |
59 | However, much like system calls, the interfaces of | | 59 | However, much like system calls, the interfaces of |
60 | .Nm , | | 60 | .Nm |
61 | are self-contained and require no tracking and release of resources. | | 61 | are self-contained and require no tracking and release of resources. |
62 | The only exception is the file system handle | | 62 | The only exception is the file system handle |
63 | .Ft struct ukfs | | 63 | .Ft struct ukfs |
64 | which should be released after use. | | 64 | which should be released after use. |
65 | .Sh INITIALIZATION | | 65 | .Sh INITIALIZATION |
66 | .Bl -ohang | | 66 | .Bl -ohang |
67 | .It Ft int | | 67 | .It Ft int |
68 | .Fn ukfs_init | | 68 | .Fn ukfs_init |
69 | .It Ft int | | 69 | .It Ft int |
70 | .Fn ukfs_modload "const char *fname" | | 70 | .Fn ukfs_modload "const char *fname" |
71 | .It Ft int | | 71 | .It Ft int |
72 | .Fn ukfs_modload_dir "const char *dirname" | | 72 | .Fn ukfs_modload_dir "const char *dirname" |
73 | .It Ft ssize_t | | 73 | .It Ft ssize_t |