usr.sbin/fusermount/fusermount.8

   1 .\" $NetBSD: fusermount.8,v 1.3 2007/06/11 21:16:23 agc Exp $ */
   2 .\"
   3 .\" Copyright (c) 2007 Alistair Crooks.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote
  14 .\"    products derived from this software without specific prior written
  15 .\"    permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
  18 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  21 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  25 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26 .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27 .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\"
  30 .Dd June 11, 2007
  31 .Dt FUSERMOUNT 8
  32 .Os
  33 .Sh NAME
  34 .Nm fusermount
  35 .Nd manage librefuse mount items
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl chpVx
  39 .Op Fl d Ar name
  40 .Ar refuseoptions
  41 .Nm
  42 .Fl u
  43 .Ar mountpoint(s)
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility acts as a frontend to the
  48 .Xr refuse 3
  49 library, allowing mounting and unmounting of
  50 refuse-based
  51 file systems.
  52 .Pp
  53 There are essentially two forms of the
  54 .Nm
  55 command.
  56 The first, and default option, is to mount a
  57 refuse-based
  58 file system.
  59 By using the
  60 .Fl u
  61 argument, the file system can be unmounted.
  62 .Pp
  63 The arguments to
  64 .Nm
  65 are as follows:
  66 .Bl -tag -width Ds
  67 .It Fl c
  68 Set a flag to enable kernel caching of files.
  69 At present this option has no effect.
  70 .It Fl d Ar name
  71 Make the name argument appear as the file system
  72 name in
  73 .Xr mount 8
  74 and
  75 .Xr df 1
  76 output.
  77 .It Fl h
  78 Print a usage message and exit.
  79 .It Fl p
  80 Check the file permissions.
  81 At present this option has no effect.
  82 .It Fl V
  83 Display the
  84 .Nm
  85 version on stdout, and then exit successfully.
  86 .It Fl x
  87 Allow mortal (non-root) users to access the file system.
  88 At present, this option has no effect.
  89 .El
  90 .Pp
  91 The
  92 .Nm
  93 utility is included mainly for compatibility reasons, since some
  94 file systems demand its existence.
  95 .Sh EXIT STATUS
  96 .Nm
  97 returns 0 for successful operation, or
  98 non-zero if one of the operations did not complete successfully.
  99 .Sh EXAMPLES
 100 The command
 101 .Dl fusermount -d ntfs-3g unused mount.ntfs-3g ntfs.img /mnt
 102 will mount the file
 103 .Pa ntfs.img
 104 on the directory
 105 .Pa /mnt .
 106 Please note the
 107 .Pa unused
 108 argument in the command, which is necessary for compatibility
 109 with other implementations of the
 110 .Nm
 111 command.
 112 .Sh SEE ALSO
 113 .Xr df 1 ,
 114 .Xr puffs 3 ,
 115 .Xr refuse 3 ,
 116 .Xr mount 8
 117 .Sh HISTORY
 118 The
 119 .Nm
 120 utility first appeared in
 121 .Nx 5.0 .
 122 .Sh AUTHORS
 123 The
 124 .Nm
 125 utility was written by
 126 .An Alistair Crooks
 127 .Aq agc@NetBSD.org .