xref: /freebsd/lib/geom/mountver/gmountver.8 (revision e8d8bef961a50d4dc22501cde4fb9fb0be1b2532)
1.\"-
2.\" Copyright (c) 2010 Edward Tomasz Napierala
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd May 18, 2015
28.Dt GMOUNTVER 8
29.Os
30.Sh NAME
31.Nm gmountver
32.Nd "control utility for disk mount verification GEOM class"
33.Sh SYNOPSIS
34.Nm
35.Cm create
36.Op Fl v
37.Ar prov ...
38.Nm
39.Cm destroy
40.Op Fl fv
41.Ar name
42.Nm
43.Cm list
44.Nm
45.Cm status
46.Op Fl s Ar name
47.Nm
48.Cm load
49.Op Fl v
50.Nm
51.Cm unload
52.Op Fl v
53.Sh DESCRIPTION
54The
55.Nm
56utility is used to control the mount verification GEOM class.
57When configured, it passes all the I/O requests to the underlying provider.
58When the underlying provider disappears - for example because the disk device
59got disconnected - it queues all the I/O requests and waits for the provider
60to reappear.
61When that happens, it attaches to it and sends the queued requests.
62.Pp
63The first argument to
64.Nm
65indicates an action to be performed:
66.Bl -tag -width ".Cm destroy"
67.It Cm create
68Enable mount verification for the given provider.
69If the operation succeeds, a new GEOM provider will be created using the
70given provider's name with a
71.Ql .mountver
72suffix.
73The kernel module
74.Pa geom_mountver.ko
75will be loaded if it is not loaded already.
76.It Cm destroy
77Destroy
78.Ar name .
79.It Cm list
80See
81.Xr geom 8 .
82.It Cm status
83See
84.Xr geom 8 .
85.It Cm load
86See
87.Xr geom 8 .
88.It Cm unload
89See
90.Xr geom 8 .
91.El
92.Pp
93Additional options:
94.Bl -tag -width indent
95.It Fl f
96Force the removal of the specified mountver device.
97.It Fl v
98Be more verbose.
99.El
100.Sh SYSCTL VARIABLES
101The following
102.Xr sysctl 8
103variables can be used to control the behavior of the
104.Nm MOUNTVER
105GEOM class.
106The default value is shown next to each variable.
107.Bl -tag -width indent
108.It Va kern.geom.mountver.debug : No 0
109Debug level of the
110.Nm MOUNTVER
111GEOM class.
112This can be set to a number between 0 and 3 inclusive.
113If set to 0 minimal debug information is printed, and if set to 3 the
114maximum amount of debug information is printed.
115.It Va kern.geom.mountver.check_ident : No 1
116This can be set to 0 or 1.
117If set to 0,
118.Nm
119will reattach to the device even if the device reports a different disk ID.
120.El
121.Sh EXIT STATUS
122Exit status is 0 on success, and 1 if the command fails.
123.Sh SEE ALSO
124.Xr geom 4 ,
125.Xr geom 8
126.Sh HISTORY
127The
128.Nm
129utility appeared in
130.Fx 9.0 .
131.Sh AUTHORS
132.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
133