lib/geom/mountver/gmountver.8

   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 .Dd May 18, 2015
  26 .Dt GMOUNTVER 8
  27 .Os
  28 .Sh NAME
  29 .Nm gmountver
  30 .Nd "control utility for disk mount verification GEOM class"
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Cm create
  34 .Op Fl v
  35 .Ar prov ...
  36 .Nm
  37 .Cm destroy
  38 .Op Fl fv
  39 .Ar name
  40 .Nm
  41 .Cm list
  42 .Nm
  43 .Cm status
  44 .Op Fl s Ar name
  45 .Nm
  46 .Cm load
  47 .Op Fl v
  48 .Nm
  49 .Cm unload
  50 .Op Fl v
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 utility is used to control the mount verification GEOM class.
  55 When configured, it passes all the I/O requests to the underlying provider.
  56 When the underlying provider disappears - for example because the disk device
  57 got disconnected - it queues all the I/O requests and waits for the provider
  58 to reappear.
  59 When that happens, it attaches to it and sends the queued requests.
  60 .Pp
  61 The first argument to
  62 .Nm
  63 indicates an action to be performed:
  64 .Bl -tag -width ".Cm destroy"
  65 .It Cm create
  66 Enable mount verification for the given provider.
  67 If the operation succeeds, a new GEOM provider will be created using the
  68 given provider's name with a
  69 .Ql .mountver
  70 suffix.
  71 The kernel module
  72 .Pa geom_mountver.ko
  73 will be loaded if it is not loaded already.
  74 .It Cm destroy
  75 Destroy
  76 .Ar name .
  77 .It Cm list
  78 See
  79 .Xr geom 8 .
  80 .It Cm status
  81 See
  82 .Xr geom 8 .
  83 .It Cm load
  84 See
  85 .Xr geom 8 .
  86 .It Cm unload
  87 See
  88 .Xr geom 8 .
  89 .El
  90 .Pp
  91 Additional options:
  92 .Bl -tag -width indent
  93 .It Fl f
  94 Force the removal of the specified mountver device.
  95 .It Fl v
  96 Be more verbose.
  97 .El
  98 .Sh SYSCTL VARIABLES
  99 The following
 100 .Xr sysctl 8
 101 variables can be used to control the behavior of the
 102 .Nm MOUNTVER
 103 GEOM class.
 104 The default value is shown next to each variable.
 105 .Bl -tag -width indent
 106 .It Va kern.geom.mountver.debug : No 0
 107 Debug level of the
 108 .Nm MOUNTVER
 109 GEOM class.
 110 This can be set to a number between 0 and 3 inclusive.
 111 If set to 0 minimal debug information is printed, and if set to 3 the
 112 maximum amount of debug information is printed.
 113 .It Va kern.geom.mountver.check_ident : No 1
 114 This can be set to 0 or 1.
 115 If set to 0,
 116 .Nm
 117 will reattach to the device even if the device reports a different disk ID.
 118 .El
 119 .Sh EXIT STATUS
 120 Exit status is 0 on success, and 1 if the command fails.
 121 .Sh SEE ALSO
 122 .Xr geom 4 ,
 123 .Xr geom 8
 124 .Sh HISTORY
 125 The
 126 .Nm
 127 utility appeared in
 128 .Fx 9.0 .
 129 .Sh AUTHORS
 130 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org