svn commit: r241447 - projects/fuse/sbin/mount_fusefs
Attilio Rao
attilio at FreeBSD.org
Thu Oct 11 17:32:04 UTC 2012
Author: attilio
Date: Thu Oct 11 17:32:03 2012
New Revision: 241447
URL: http://svn.freebsd.org/changeset/base/241447
Log:
- Fix grammar [1].
- Remove /dev/fuseN occurrences and use correct /dev/fuse one.
[1] Submitted by: Kevin Oberman <kob6558 AT gmail DOT com>
Reviewed by: gjb (partially)
Modified:
projects/fuse/sbin/mount_fusefs/mount_fusefs.8
Modified: projects/fuse/sbin/mount_fusefs/mount_fusefs.8
==============================================================================
--- projects/fuse/sbin/mount_fusefs/mount_fusefs.8 Thu Oct 11 16:15:18 2012 (r241446)
+++ projects/fuse/sbin/mount_fusefs/mount_fusefs.8 Thu Oct 11 17:32:03 2012 (r241447)
@@ -27,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd January 13, 2006
+.Dd October 11, 2012
.Dt MOUNT_FUSEFS 8
.Os
.Sh NAME
@@ -48,41 +48,35 @@
.Ar special node
.Op Ar fuse_daemon ...
.Sh DESCRIPTION
-The most basic way of usage is as follows: before calling
-.Nm ,
-one starts a fuse daemon on the given
+Basic usage is to start a fuse daemon on the given
.Ar special
-(in practice, the daemon gets one automatically, which can then be indentified
-via
-.Xr fstat 1 ) ,
-and that special file can then be mounted by
+file. In practice, the daemon is assigned a
+.Ar special
+file automatically, which can then be indentified via
+.Xr fstat 1 .
+That special file can then be mounted by
.Nm .
.Pp
-However, the procedure of spawning a daemon can be automated so that it's
-also performed by
+However, the procedure of spawning a daemon will usually be automated
+so that it is performed by
.Nm .
If the command invoking a given
.Ar fuse_daemon
is appended to the list of arguments,
.Nm
-will call then
+will call the
.Ar fuse_daemon
-via that command, in a way that
+via that command. In that way the
.Ar fuse_daemon
will be instructed to attach itself to
.Ar special .
-From that on mounting goes as in the simple case. (See also
+From that on mounting goes as in the simple case. (See
.Sx DAEMON MOUNTS . )
.Pp
The
.Ar special
-argument can be utilized by
-.Nm
-in the following ways:
-.Bl -bullet -offset indent
-.It
-Basicly, it will be treated as the path of the special file to mount.
-.It
+argument normally will be treated as the path of the special file to mount.
+.Pp
However, if
.Pa auto
is passed as
@@ -90,47 +84,46 @@ is passed as
then
.Nm
will look for a suitable free fuse device by itself.
-.It
-Moreover, if
+.Pp
+Finally, if
.Ar special
-is an integer, then it will be interpreted as the number
+is an integer it will be interpreted as the number
of the file descriptor of an already open fuse device
(used when the Fuse library invokes
-.Nm ,
-cf.
+.Nm .
+(See
.Sx DAEMON MOUNTS ) .
-.El
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl A , Ic --reject-allow_other
Prohibit the
.Cm allow_other
-mount flag. Intended for to be used in scripts and the
+mount flag. Intended for use in scripts and the
.Xr sudoers 5
file.
.It Fl S , Ic --safe
-Run in safe mode, that is, reject invoking a filesystem daemon.
+Run in safe mode (i.e. reject invoking a filesystem daemon)
.It Fl v
-Be verbose.
+Be verbose
.It Fl D, Ic --daemon Ar daemon
Call the specified
-.Ar daemon .
+.Ar daemon
.It Fl O, Ic --daemon_opts Ar opts
Add
.Ar opts
-to the daemon's command line.
+to the daemon's command line
.It Fl s, Ic --special Ar special
Use
.Ar special
-as special.
+as special
.It Fl m, Ic --mountpath Ar node
Mount on
-.Ar node .
+.Ar node
.It Fl h, Ic --help
-Show help.
+Show help
.It Fl V, Ic --version
-Show version information.
+Show version information
.It Fl o
Mount options are specified via
.Fl o .
@@ -139,22 +132,22 @@ by prefixing them with
.Dq no ) :
.Bl -tag -width indent
.It Cm default_permissions
-Enable traditional (file mode based) permission checking in kernel.
+Enable traditional (file mode based) permission checking in kernel
.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 max_read Ns = Ns Ar n
-Limit size of read requests with
-.Ar n .
+Limit size of read requests to
+.Ar n
.It Cm private
Refuse shared mounting of the daemon. This is the default behaviour,
-to allow sharing, use expicitly
-.Fl o Cm noprivate .
+to allow sharing, expicitly use
+.Fl o Cm noprivate
.It Cm neglect_shares
-Don't refuse unmounting if there are secondary mounts.
+Don't refuse unmounting if there are secondary mounts
.It Cm push_symlinks_in
-Prefix absolute symlinks with mountpoint.
+Prefix absolute symlinks with the mountpoint
.El
.Pp
.El
@@ -165,88 +158,90 @@ are supported by the Fuse library. One c
to a Fuse daemon. Most of these options have effect only on the behaviour of
the daemon (that is, their scope is limited to userspace). However,
there are some which do require in-kernel support.
-Currently the following ones are supported by the kernel:
+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
+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 don't need to use
.Nm
directly, as the Fuse library enables Fuse daemons to invoke
-.Nm
-by themselves. That is,
+.Nm .
+That is,
.Pp
-.Dl fuse_daemon mountpoint
+.Dl fuse_daemon device mountpoint
.Pp
has the same effect as
.Pp
.Dl mount_fusefs auto mountpoint fuse_daemon
.Pp
-This is the recommended way of usage, unless you want to go beyond basic usage
-(eg, run daemon on a low privilege level, but mount it as root).
+This is the recommended usage when you want basic usage
+(eg, run the daemon at a low privilege level but mount it as root).
.Sh STRICT ACCESS POLICY
The strict access policy for Fuse filesystems lets one to use the filesystem
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 (cf. the
+This is applied for Fuse mounts by default and only root can mount without
+the strict access policy (ie. the
.Cm allow_other
mount option).
.Pp
-The reason is to shield users from the daemon
+This is to shield users from the daemon
.Dq spying
on their I/O activities.
.Pp
-Users might opt for willingly relax strict access policy (as far they
-are concerned) by doing their own secondary mount (cf.
+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, ie. mounted multiple times.
+A Fuse daemon can be shared (ie. 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
After the primary mount is in place, secondary mounts can be done by anyone
-(unless this feature is disabled by
-.Cm private ) .
+unless this feature is disabled by
+.Cm private .
The behaviour of a secondary mount is analogous to that of symbolic
links: they redirect all filesystem operations to the primary mount.
.Pp
Doing a secondary mount is like signing an agreement: by this action, the mounter
-agrees that the Fuse daemon can trace her I/O activities. From that on, she is not
-banned from using the filesystem (either via her own mount or via the primary mount),
-regardless whether
+agrees that the Fuse daemon can trace her I/O activities. From then on
+she is not banned from using the filesystem (either via her own mount or
+via the primary mount), regardless whether
.Cm allow_other
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, like
+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.
.Pa /dev/fuse0#3 .
.Sh SECURITY
-System administratos might want to use a custom mount policy (ie., one going beyond the
+System administrators might want to use a custom mount policy (ie., one going
+beyond the
.Va vfs.usermount
sysctl). The primary tool for such purposes is
.Xr sudo 8 .
However, given that
.Nm
-is capable of invoking an arbitrary program, one must be careful about this.
+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 (cf.
+there are options which disable certain risky features (ie.
.Fl S
and
.Fl A ) ,
and command line parsing is done in a flexible way: mixing options and
-non-options allowed, but processing them stops at the third non-option argument
-(after the first two has been utilized as device and mountpoint). The rest of
-the command line specifies the daemon and its arguments. (Alternatively, the
-daemon, the special and the mount path can be specified using the respective
-options.) Note that
+non-options is allowed, but processing them stops at the third non-option
+argument (after the first two has been utilized as device and mountpoint).
+The rest of the command line specifies the daemon and its arguments.
+(Alternatively, the daemon, the special and the mount path can be
+specified using the respective options.) Note that
.Nm
ignores the environment variable
.Ev POSIXLY_CORRECT
@@ -256,54 +251,55 @@ In general, to be as scripting /
.Xr sudoers 5
friendly as possible, no information has a fixed
position in the command line, but once a given piece of information is
-provided, subsequent arguments/options cannot override it (maybe with the
+provided, subsequent arguments/options cannot override it (with the
exception of some non-critical ones).
.Sh ENVIRONMENT
.Bl -tag -width ".Ev MOUNT_FUSEFS_SAFE"
.It Ev MOUNT_FUSEFS_SAFE
-Setting this has the same effect as the
+This has the same effect as the
.Fl S
option.
.It Ev MOUNT_FUSEFS_VERBOSE
-Setting this has the same effect as the
+This has the same effect as the
.Fl v
option.
.It Ev MOUNT_FUSEFS_IGNORE_UNKNOWN
-If this is set,
+If set,
.Nm
will ignore uknown mount options.
.It Ev MOUNT_FUSEFS_CALL_BY_LIB
-Adjust behaviour to the needs of the FUSE library. Currently it has effect
-on help output.
+Adjust behaviour to the needs of the FUSE library. Currently it effects
+help output.
.El
.Pp
-Although the following variables don't have effect on
+Although the following variables don't have any effect on
.Nm
itself, they affect the behaviour of fuse daemons:
.Bl -tag -width ".Ev FUSE_DEV_NAME"
.It Ev FUSE_DEV_NAME
-Device to get attached to. If not set, the multiplexer path
+Device to attach. If not set, the multiplexer path
.Ar /dev/fuse
is used.
.It Ev FUSE_DEV_FD
File desciptor of an opened Fuse device to use. Overrides
.Ev FUSE_DEV_NAME .
.It Ev FUSE_NO_MOUNT
-If this is set, the library won't attempt to mount the filesystem, even
+If set, the library won't attempt to mount the filesystem, even
if a mountpoint argument is supplied.
.El
.Sh FILES
-.Bl -tag -width /dev/fuseN
-.It Pa /dev/fuseN
-Fuse devices by which the kernel and Fuse daemons can communicate.
+.Bl -tag -width /dev/fuse
+.It Pa /dev/fuse
+Fuse device with which the kernel and Fuse daemons can communicate.
.It Pa /dev/fuse
The multiplexer path. An
.Xr open 2
-performed on it automatically gets passed to a free Fuse device by the kernel (which might be
-just created for this puprose).
+performed on it automatically is passed to a free Fuse device by the kernel
+(which might be created just for this puprose).
.El
.Sh EXAMPLES
-Mounting the example filesystem of the Fuse distribution (from its directory): either
+Mount the example filesystem in the Fuse distribution (from its directory):
+either
.Pp
.Dl ./fusexmp /mnt/fuse
.Pp
@@ -314,8 +310,8 @@ or
Doing the same in two steps, using
.Pa /dev/fuse0 :
.Pp
-.Dl FUSE_DEV_NAME=/dev/fuse0 ./fusexmp &&
-.Dl mount_fusefs /dev/fuse0 /mnt/fuse
+.Dl FUSE_DEV_NAME=/dev/fuse ./fusexmp &&
+.Dl mount_fusefs /dev/fuse /mnt/fuse
.Pp
A script wrapper for fusexmp which ensures that
.Nm
@@ -324,25 +320,17 @@ doesn't call any external utility and al
.Pp
.Dl #!/bin/sh -e
.Pp
-.Dl n=`ls /dev/fuse* | awk 'END{ print FNR }'`
-.Dl FUSE_DEV_NAME=/dev/fuse$n fusexmp
-.Dl mount_fusefs -S /dev/fuse$n /mnt/fuse \(lq$@\(rq
-.Pp
-A better (race-free) script wrapper:
-.Pp
-.Dl #!/bin/sh -e
-.Pp
-.Dl exec 3<>/dev/fuse
-.Dl FUSE_DEV_FD=3 fusexmp
-.Dl mount_fusefs -S 3 /mnt/fuse \(lq$@\(rq
+.Dl FUSE_DEV_NAME=/dev/fuse fusexmp
+.Dl mount_fusefs -S /dev/fuse /mnt/fuse \(lq$@\(rq
.Sh SEE ALSO
.Xr fstat 1 ,
.Xr mount 8 ,
.Xr umount 8 ,
.Xr sudo 8
.Sh CAVEATS
-Secondary mounts are to be unmounted via their device name. If they attempted to be unmounted via
-their filesystem root path, the unmount request will be forwarded to the primary mount path.
+Secondary mounts should be unmounted via their device name. If an attempt is
+made to be unmount them via their filesystem root path, the unmount request
+will be forwarded to the primary mount path.
In general, unmounting by device name is less error-prone than by mount path
(although the latter will also work under normal circumstances).
.Pp
@@ -352,17 +340,17 @@ and
.Fl O
options, it will be invoked via
.Xr system 3 ,
-and the daemon's command line will be also appended a
+and the daemon's command line will also have an
.Dq &
-sygill, so that we don't have to wait for its termination. That is, you'd better
-use a simple command line when invoking the daemon via these options.
+control operator appended, so that we don't have to wait for its termination.
+You should use a simple command line when invoking the daemon via these options.
.Sh HISTORY
.Nm
appears as the part of the FreeBSD implementation of the Fuse userspace filesystem
framework (see http://fuse.sourceforge.net). This user interface is FreeBSD specific.
.Sh BUGS
.Ar special
-is treated as a multiplexer if and only if it's literally the same as
+is treated as a multiplexer if and only if it is literally the same as
.Pa auto
or
.Pa /dev/fuse .
More information about the svn-src-projects
mailing list