lib/geom/mountver/gmountver.8

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