sbin/mount_hammer/mount_hammer.8

   1 .\" Copyright (c) 2007 The DragonFly Project.  All rights reserved.
   2 .\"
   3 .\" This code is derived from software contributed to The DragonFly Project
   4 .\" by Matthew Dillon <dillon@backplane.com>
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\"
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\" 3. Neither the name of The DragonFly Project nor the names of its
  17 .\"    contributors may be used to endorse or promote products derived
  18 .\"    from this software without specific, prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\" $DragonFly: src/sbin/mount_hammer/mount_hammer.8,v 1.13 2008/07/27 17:12:13 thomas Exp $
  34 .Dd June 24, 2008
  35 .Dt MOUNT_HAMMER 8
  36 .Os
  37 .Sh NAME
  38 .Nm mount_hammer
  39 .Nd mount a HAMMER file system
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl o Ar options
  43 .Op Fl T Ar transaction-id
  44 .Ar special ...
  45 .Ar node
  46 .Nm
  47 .Op Fl o Ar options
  48 .Op Fl T Ar transaction-id
  49 .Ar special[:special]*
  50 .Ar node
  51 .Nm
  52 .Op Fl u
  53 .Op Fl o Ar options
  54 .Ar node
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 utility mounts a
  59 .Nm HAMMER
  60 file system backed by
  61 .Ar special
  62 file(s) at mount point
  63 .Ar node .
  64 .Pp
  65 The options are as follows:
  66 .Bl -tag -width indent
  67 .It Fl o Ar options
  68 Specify mount options, which are a comma delimited set of options (see
  69 .Xr mount 8 ) .
  70 Supported mount options are:
  71 .Bl -tag -width indent
  72 .It Ar ro
  73 Issue a read-only mount.
  74 .It Ar nohistory
  75 Put the entire file system in no-history mode.  Change history is not
  76 retained.
  77 Use of this option may increase the overhead of doing mirroring.
  78 This option is generally only used in an emergency.
  79 .It Ar master=<id>
  80 Assign a master id for the entire mount which applies to all PFSs under
  81 the mount.  This is intended to help support multi-master and fail-over
  82 operation.  Multi-master operation is not yet supported.  If you intend
  83 to upgrade slaves to masters and downgrade masters to slaves as part of
  84 a fail-over setup, it's a good idea to assign a different master id
  85 to the
  86 .Nm HAMMER
  87 mounts making up the fail-over group.
  88 .It Ar nomirror
  89 By default a
  90 .Nm HAMMER
  91 mount assigns a master id of 0.  You can force
  92 no-mirror operation by specifying this option.  This option disables
  93 mirror transaction id propagation in the B-Tree and will improve write
  94 performance somewhat but also prevents incremental mirroring from working
  95 at all, and is not recommended.
  96 .El
  97 .It Fl T Ar transaction-id
  98 Mount the file system as-of a particular
  99 transaction id.
 100 The mount will automatically be made read-only.
 101 The
 102 .Ar transaction-id
 103 must be specified as a 64 bit hex value prefixed with "0x".
 104 .It Fl u
 105 Update the mount point.  This is typically used to upgrade a mount to
 106 read-write or downgrade it to read-only.
 107 .El
 108 .Sh NOTES
 109 Note that issuing a read-only mount which requires UNDOs to be run will
 110 still run the UNDOs, but will not flush the buffer cache buffers until/if
 111 the mount is updated to read-write.
 112 .Sh EXAMPLES
 113 Mount a
 114 .Nm HAMMER
 115 file system made up of two volumes onto
 116 .Pa /mnt :
 117 .Bd -literal -offset indent
 118 mount_hammer -o ro,noatime /dev/ad0s1d /dev/ad1s1d /mnt
 119 .Ed
 120 .Pp
 121 A corresponding
 122 .Xr fstab 5
 123 entry is:
 124 .Bd -literal -offset indent
 125 /dev/ad0s1d:/dev/ad1s1d /mnt hammer ro,noatime
 126 .Ed
 127 .Sh DIAGNOSTICS
 128 Exit status is 0 on success and 1 on error.
 129 .Sh SEE ALSO
 130 .Xr mount 2 ,
 131 .Xr unmount 2 ,
 132 .Xr fstab 5 ,
 133 .Xr HAMMER 5 ,
 134 .Xr disklabel 8 ,
 135 .Xr disklabel64 8 ,
 136 .Xr fdisk 8 ,
 137 .Xr gpt 8 ,
 138 .Xr hammer 8 ,
 139 .Xr mount 8 ,
 140 .Xr newfs_hammer 8
 141 .Sh HISTORY
 142 The
 143 .Nm
 144 utility first appeared in
 145 .Dx 1.11 .
 146 .Sh AUTHORS
 147 .An Matthew Dillon Aq dillon@backplane.com