xref: /netbsd-src/usr.sbin/fusermount/fusermount.8 (revision 5d9460afed9e05d055287ec51130e3f00a080442)
1*5d9460afSwiz.\" $NetBSD: fusermount.8,v 1.4 2007/12/02 21:22:03 wiz Exp $ */
2460f24ecSagc.\"
3460f24ecSagc.\" Copyright (c) 2007 Alistair Crooks.  All rights reserved.
4460f24ecSagc.\"
5460f24ecSagc.\" Redistribution and use in source and binary forms, with or without
6460f24ecSagc.\" modification, are permitted provided that the following conditions
7460f24ecSagc.\" are met:
8460f24ecSagc.\" 1. Redistributions of source code must retain the above copyright
9460f24ecSagc.\"    notice, this list of conditions and the following disclaimer.
10460f24ecSagc.\" 2. Redistributions in binary form must reproduce the above copyright
11460f24ecSagc.\"    notice, this list of conditions and the following disclaimer in the
12460f24ecSagc.\"    documentation and/or other materials provided with the distribution.
13460f24ecSagc.\" 3. The name of the author may not be used to endorse or promote
14460f24ecSagc.\"    products derived from this software without specific prior written
15460f24ecSagc.\"    permission.
16460f24ecSagc.\"
17460f24ecSagc.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
18460f24ecSagc.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19460f24ecSagc.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20460f24ecSagc.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
21460f24ecSagc.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22460f24ecSagc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23460f24ecSagc.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24460f24ecSagc.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25460f24ecSagc.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26460f24ecSagc.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27460f24ecSagc.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28460f24ecSagc.\"
29460f24ecSagc.\"
30c3f5008eSagc.Dd June 11, 2007
31460f24ecSagc.Dt FUSERMOUNT 8
32460f24ecSagc.Os
33460f24ecSagc.Sh NAME
34460f24ecSagc.Nm fusermount
35460f24ecSagc.Nd manage librefuse mount items
36460f24ecSagc.Sh SYNOPSIS
37460f24ecSagc.Nm
38*5d9460afSwiz.Op Fl chpVx
39460f24ecSagc.Op Fl d Ar name
40460f24ecSagc.Ar refuseoptions
41460f24ecSagc.Nm
42460f24ecSagc.Fl u
43460f24ecSagc.Ar mountpoint(s)
44460f24ecSagc.Sh DESCRIPTION
45460f24ecSagcThe
46460f24ecSagc.Nm
47460f24ecSagcutility acts as a frontend to the
48460f24ecSagc.Xr refuse 3
49460f24ecSagclibrary, allowing mounting and unmounting of
50460f24ecSagcrefuse-based
51460f24ecSagcfile systems.
52460f24ecSagc.Pp
53460f24ecSagcThere are essentially two forms of the
54460f24ecSagc.Nm
55460f24ecSagccommand.
56460f24ecSagcThe first, and default option, is to mount a
57460f24ecSagcrefuse-based
58460f24ecSagcfile system.
59460f24ecSagcBy using the
60460f24ecSagc.Fl u
61460f24ecSagcargument, the file system can be unmounted.
62460f24ecSagc.Pp
63460f24ecSagcThe arguments to
64460f24ecSagc.Nm
65460f24ecSagcare as follows:
66460f24ecSagc.Bl -tag -width Ds
67460f24ecSagc.It Fl c
68*5d9460afSwizSet a flag to enable kernel caching of files.
69460f24ecSagcAt present this option has no effect.
70460f24ecSagc.It Fl d Ar name
71*5d9460afSwizMake the name argument appear as the file system
72460f24ecSagcname in
73460f24ecSagc.Xr mount 8
74460f24ecSagcand
75460f24ecSagc.Xr df 1
76460f24ecSagcoutput.
77460f24ecSagc.It Fl h
78*5d9460afSwizPrint a usage message and exit.
79460f24ecSagc.It Fl p
80*5d9460afSwizCheck the file permissions.
81460f24ecSagcAt present this option has no effect.
82*5d9460afSwiz.It Fl V
83*5d9460afSwizDisplay the
84*5d9460afSwiz.Nm
85*5d9460afSwizversion on stdout, and then exit successfully.
86460f24ecSagc.It Fl x
87*5d9460afSwizAllow mortal (non-root) users to access the file system.
88460f24ecSagcAt present, this option has no effect.
89460f24ecSagc.El
90460f24ecSagc.Pp
91460f24ecSagcThe
92460f24ecSagc.Nm
93460f24ecSagcutility is included mainly for compatibility reasons, since some
94460f24ecSagcfile systems demand its existence.
95460f24ecSagc.Sh EXIT STATUS
96460f24ecSagc.Nm
97460f24ecSagcreturns 0 for successful operation, or
98460f24ecSagcnon-zero if one of the operations did not complete successfully.
99*5d9460afSwiz.Sh EXAMPLES
100e54f9cf6SagcThe command
101e54f9cf6Sagc.Dl fusermount -d ntfs-3g unused mount.ntfs-3g ntfs.img /mnt
102e54f9cf6Sagcwill mount the file
103e54f9cf6Sagc.Pa ntfs.img
104e54f9cf6Sagcon the directory
105e54f9cf6Sagc.Pa /mnt .
106e54f9cf6SagcPlease note the
107e54f9cf6Sagc.Pa unused
108e54f9cf6Sagcargument in the command, which is necessary for compatibility
109e54f9cf6Sagcwith other implementations of the
110e54f9cf6Sagc.Nm
111e54f9cf6Sagccommand.
112460f24ecSagc.Sh SEE ALSO
113460f24ecSagc.Xr df 1 ,
114*5d9460afSwiz.Xr puffs 3 ,
115*5d9460afSwiz.Xr refuse 3 ,
116460f24ecSagc.Xr mount 8
117460f24ecSagc.Sh HISTORY
118460f24ecSagcThe
119460f24ecSagc.Nm
120460f24ecSagcutility first appeared in
121460f24ecSagc.Nx 5.0 .
122460f24ecSagc.Sh AUTHORS
123460f24ecSagcThe
124460f24ecSagc.Nm
125460f24ecSagcutility was written by
126460f24ecSagc.An Alistair Crooks
127460f24ecSagc.Aq agc@NetBSD.org .
128