Module Name: src
Committed By: wiz
Date: Wed Sep 1 13:04:11 UTC 2010
Modified Files:
src/lib/libperfuse: libperfuse.3
Log Message:
Some fixes. Comment out ERRORS section until it has content.
To generate a diff of this commit:
cvs rdiff -u -r1.1 -r1.2 src/lib/libperfuse/libperfuse.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libperfuse/libperfuse.3
diff -u src/lib/libperfuse/libperfuse.3:1.1 src/lib/libperfuse/libperfuse.3:1.2
--- src/lib/libperfuse/libperfuse.3:1.1 Wed Aug 25 07:16:00 2010
+++ src/lib/libperfuse/libperfuse.3 Wed Sep 1 13:04:11 2010
@@ -1,4 +1,4 @@
-.\" $NetBSD: libperfuse.3,v 1.1 2010/08/25 07:16:00 manu Exp $
+.\" $NetBSD: libperfuse.3,v 1.2 2010/09/01 13:04:11 wiz Exp $
.\"
.\" Copyright (c) 2010 Emmanuel Dreyfus. All rights reserved.
.\"
@@ -23,7 +23,6 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.ds str-Lb-libperfuse PUFFS enabled relay to FUSE Library (libperfuse, \-lperfuse)
.Dd August 12, 2010
.Dt LIBPERFUSE 2
.Os
@@ -31,8 +30,9 @@
.Nm perfuse_mount ,
.Nm perfuse_open
.Nd Request a
-.Xr puffs 3 mount from
-.Xr perfused 8 .
+.Xr puffs 3
+mount from
+.Xr perfused 8
.Sh LIBRARY
.Lb libperfuse
.Sh SYNOPSIS
@@ -43,11 +43,11 @@
.Fn perfuse_open "const char *path" "int flags"
.Sh DESCRIPTION
.Fn perfuse_mount
-sends a mount request to
+sends a mount request to
.Xr perfused 8 .
It is intended as a drop-in replacement for
.Xr mount 2
-for FUSE filesystems daemons and libraries, so that they can work with
+for FUSE file systems daemons and libraries, so that they can work with
.Xr perfused 8 .
.Pp
The function prototype mimics Linux's
@@ -55,56 +55,61 @@
with the following arguments:
.Bl -tag -width indent
.It Ar source
-The source fileystem that will appear in
-.Xr df 1 ,
+The source file system that will appear in
+.Xr df 1
and
.Xr mount 8
-listings. Defaults to
+listings.
+Defaults to
.Pa /dev/fuse
-if NULL.
+if
+.Dv NULL .
.It Ar dir
-The filesystem mount point.
+The file system mount point.
.It Ar filesystemtype
-The gileystem type, as displayed by
-.Xr df 1 ,
+The file system type, as displayed by
+.Xr df 1
and
.Xr mount 8 .
-Defaults to "fuse"
-if NULL.
+Defaults to
+.Dq fuse
+if
+.Dv NULL .
.It Ar mountflags
-This contains the same value as in
+This contains the same value as a
.Xr mount 2
.Ar flags
argument.
.It Ar data
-This contains the same value as in
+This contains the same value as a
.Xr mount 2
.Ar data
argument.
.El
.Pp
.Fn perfuse_open
-is a drop-in replacement for the
+is a drop-in replacement for the
.Xr open 2
system call where
.Pa /dev/fuse
-is used. If
+is used.
+If
.Ar path
is different than
.Pa /dev/fuse ,
-.Fn perfuse_open
+.Fn perfuse_open
handles control to the regular
.Xr open 2 .
.Sh RETURN VALUES
.Fn perfuse_mount
returns a file descriptor to the
.Pa /dev/fuse
-socket on success, and cause exit on failure.
-.Sh ERRORS
-.Fn perfuse_mount
-will fail when one of the following occurs:
-.Bl -tag -width Er
-.El
+socket on success, and causes exit on failure.
+.\".Sh ERRORS
+.\".Fn perfuse_mount
+.\"will fail when one of the following occurs:
+.\".Bl -tag -width Er
+.\".El
.Sh SEE ALSO
.Xd df 1 ,
.Xr mount 2 ,
@@ -113,5 +118,5 @@
.Xr perfused 8
.Sh AUTHORS
The program was written by
-.An Emmanuel Dreyfus
+.An Emmanuel Dreyfus
.Aq [email protected] .