fusefs: proofread man pages

Reported by:	bcr, mandoc, textproc/igor
Sponsored by:	The FreeBSD Foundation
This commit is contained in:
Alan Somers 2019-07-31 16:07:16 +00:00
parent f093e49ae2
commit db90284c31
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/projects/fuse2/; revision=350466
2 changed files with 34 additions and 33 deletions

View file

@ -34,7 +34,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd July 18, 2019
.Dd July 31, 2019
.Dt MOUNT_FUSEFS 8
.Os
.Sh NAME
@ -113,27 +113,27 @@ Intended for use in scripts and the
.Xr sudoers 5
file.
.It Fl S , Ic --safe
Run in safe mode (i.e. reject invoking a filesystem daemon)
Run in safe mode (i.e., reject invoking a filesystem daemon).
.It Fl v
Be verbose
.It Fl D, Ic --daemon Ar daemon
Be verbose.
.It Fl D , Ic --daemon Ar daemon
Call the specified
.Ar daemon
.It Fl O, Ic --daemon_opts Ar opts
.Ar daemon .
.It Fl O , Ic --daemon_opts Ar opts
Add
.Ar opts
to the daemon's command line
.It Fl s, Ic --special Ar special
to the daemon's command line.
.It Fl s , Ic --special Ar special
Use
.Ar special
as special
.It Fl m, Ic --mountpath Ar node
as special.
.It Fl m , Ic --mountpath Ar node
Mount on
.Ar node
.It Fl h, Ic --help
Show help
.It Fl V, Ic --version
Show version information
.Ar node .
.It Fl h , Ic --help
Show help.
.It Fl V , Ic --version
Show version information.
.It Fl o
Mount options are specified via
.Fl o .
@ -144,12 +144,12 @@ by prefixing them with
.It Cm allow_other
Do not apply
.Sx STRICT ACCESS POLICY .
Only root can use this option
Only root can use this option.
.It Cm async
I/O to the file system may be done asynchronously.
Writes may delayed and/or reordered.
Writes may be delayed and/or reordered.
.It Cm default_permissions
Enable traditional (file mode based) permission checking in kernel
Enable traditional (file mode based) permission checking in kernel.
.It Cm intr
Allow signals to interrupt operations that are blocked waiting for a reply from the server.
When this option is in use, system calls may fail with
@ -157,15 +157,15 @@ When this option is in use, system calls may fail with
whenever a signal is received.
.It Cm max_read Ns = Ns Ar n
Limit size of read requests to
.Ar n
.Ar n .
.It Cm neglect_shares
Do not refuse unmounting if there are secondary mounts
Do not refuse unmounting if there are secondary mounts.
.It Cm private
Refuse shared mounting of the daemon.
This is the default behaviour, to allow sharing, expicitly use
.Fl o Cm noprivate
.Fl o Cm noprivate .
.It Cm push_symlinks_in
Prefix absolute symlinks with the mountpoint
Prefix absolute symlinks with the mountpoint.
.It Cm subtype Ns = Ns Ar fsname
Suffix
.Ar fsname
@ -187,11 +187,11 @@ However, there are some which do require in-kernel support.
Currently the options supported by the kernel are:
.Bl -tag -width indent
.It Cm direct_io
Bypass the buffer cache system
Bypass the buffer cache system.
.It Cm kernel_cache
By default cached buffers of a given file are flushed at each
.Xr open 2 .
This option disables this behaviour
This option disables this behaviour.
.El
.Sh DAEMON MOUNTS
Usually users do not need to use
@ -214,7 +214,7 @@ only if the filesystem daemon has the same credentials (uid, real uid, gid,
real gid) as the user.
.Pp
This is applied for Fuse mounts by default and only root can mount without
the strict access policy (i.e. the
the strict access policy (i.e., the
.Cm allow_other
mount option).
.Pp
@ -226,7 +226,7 @@ Users might opt to willingly relax strict access policy (as far they
are concerned) by doing their own secondary mount (See
.Sx SHARED MOUNTS ) .
.Sh SHARED MOUNTS
A Fuse daemon can be shared (i.e. mounted multiple times).
A Fuse daemon can be shared (i.e., mounted multiple times).
When doing the first (primary) mount, the spawner and the mounter of the daemon
must have the same uid, or the mounter should be the superuser.
.Pp
@ -245,7 +245,7 @@ is used or not.
.Pp
The device name of a secondary mount is the device name of the corresponding
primary mount, followed by a '#' character and the index of the secondary
mount; e.g.
mount; e.g.,
.Pa /dev/fuse0#3 .
.Sh SECURITY
System administrators might want to use a custom mount policy (ie., one going
@ -259,7 +259,7 @@ However, given that
is capable of invoking an arbitrary program, one must be careful when doing this.
.Nm
is designed in a way such that it makes that easy.
For this purpose, there are options which disable certain risky features (i.e.
For this purpose, there are options which disable certain risky features (
.Fl S
and
.Fl A ) ,
@ -362,7 +362,7 @@ does not call any external utility and also provides a hacky
was written as the part of the
.Fx
implementation of the Fuse userspace filesystem framework (see
.Xr https://github.com/libfuse/libfuse )
.Lk https://github.com/libfuse/libfuse )
and first appeared in the
.Pa sysutils/fusefs-kmod
port, supporting

View file

@ -28,7 +28,7 @@
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.Dd June 27, 2019
.Dd July 31, 2019
.Dt FUSEFS 5
.Os
.Sh NAME
@ -60,7 +60,7 @@ Finally, the
API is portable.
Many daemons can run on multiple operating systems with minimal modifications.
.Sh SYSCTL VARIABLES
The following
The following
.Xr sysctl 8
variables are available:
.Bl -tag -width indent
@ -95,12 +95,13 @@ Total number of lookup cache misses.
Current number of allocated FUSE vnodes.
.It Va vfs.fusefs.stats.ticket_count
Current number of allocated FUSE tickets, which is roughly equal to the number
number of FUSE operations currently being processed by daemons.
of FUSE operations currently being processed by daemons.
.\" Undocumented sysctls
.\" ====================
.\" vfs.fusefs.enforce_dev_perms: I don't understand it well enough.
.\" vfs.fusefs.iov_credit: I don't understand it well enough
.\" vfs.fusefs.iov_permanent_bufsize: I don't understand it well enough
.El
.Sh SEE ALSO
.Xr mount_fusefs 8
.Sh HISTORY
@ -109,7 +110,7 @@ The
driver was written as the part of the
.Fx
implementation of the FUSE userspace file system framework (see
.Xr https://github.com/libfuse/libfuse )
.Lk https://github.com/libfuse/libfuse )
and first appeared in the
.Pa sysutils/fusefs-kmod
port, supporting