sbin/mount_hammer2/mount_hammer2.8

   1 .\" Copyright (c) 2017 The DragonFly Project.  All rights reserved.
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\"
   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
  11 .\"    the documentation and/or other materials provided with the
  12 .\"    distribution.
  13 .\" 3. Neither the name of The DragonFly Project nor the names of its
  14 .\"    contributors may be used to endorse or promote products derived
  15 .\"    from this software without specific, prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  20 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  21 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  23 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  25 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  26 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  27 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .Dd October 7, 2017
  31 .Dt MOUNT_HAMMER2 8
  32 .Os
  33 .Sh NAME
  34 .Nm mount_hammer2
  35 .Nd mount a HAMMER2 file system
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl o Ar options
  39 .Ar special Ns Op Cm @ Ns Ar label
  40 .Ar node
  41 .Nm
  42 .Op Fl o Ar options
  43 .Cm @ Ns Ar label
  44 .Ar node
  45 .Nm
  46 .Fl u
  47 .Op Fl o Ar options
  48 .Ar node
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility mounts a
  53 .Nm HAMMER2
  54 file system backed by
  55 .Ar special
  56 file at mount point
  57 .Ar node .
  58 PFS
  59 .Ar label
  60 is mounted.
  61 .Cm @ Ns Ar label
  62 (no
  63 .Ar special )
  64 is a short form, which mounts
  65 .Ar label
  66 from an already mounted
  67 .Nm HAMMER2
  68 filesystem.
  69 .Pp
  70 Default value for
  71 .Ar label
  72 is based on partition of
  73 .Ar special :
  74 .Ql a
  75 defaults to "BOOT" ,
  76 .Ql d
  77 defaults to "ROOT",
  78 and any other partition defaults to "DATA".
  79 .Pp
  80 The options are as follows:
  81 .Bl -tag -width indent
  82 .It Fl o Ar options
  83 Options are specified with a
  84 .Fl o
  85 flag followed by a comma separated string of options.
  86 See the
  87 .Xr mount 8
  88 man page for possible options and their meanings.
  89 The following
  90 .Nm HAMMER2
  91 specific options are also available:
  92 .Bl -tag -width indent
  93 .It Cm local
  94 Disable PFS clustering.
  95 .El
  96 .It Fl u
  97 Update the mount point.
  98 This is typically used to upgrade a mount to
  99 read-write or downgrade it to read-only.
 100 .El
 101 .Sh EXIT STATUS
 102 .Ex -std
 103 .Sh EXAMPLES
 104 Mount a
 105 .Nm HAMMER2
 106 file system on
 107 .Pa /mnt ,
 108 PFS "ROOT" is mounted:
 109 .Bd -literal -offset indent
 110 mount_hammer2 /dev/da0s1d /mnt
 111 .Ed
 112 .Pp
 113 A corresponding
 114 .Xr fstab 5
 115 entry is:
 116 .Bd -literal -offset indent
 117 /dev/da0s1d /mnt hammer2
 118 .Ed
 119 .Pp
 120 Mount PFS "TEST" from same filesystem:
 121 .Bd -literal -offset indent
 122 mount_hammer2 @TEST /mnt2
 123 .Ed
 124 .Sh SEE ALSO
 125 .Xr mount 2 ,
 126 .Xr unmount 2 ,
 127 .Xr fstab 5 ,
 128 .Xr disklabel32 8 ,
 129 .Xr disklabel64 8 ,
 130 .Xr fdisk 8 ,
 131 .Xr gpt 8 ,
 132 .Xr hammer2 8 ,
 133 .Xr mount 8 ,
 134 .Xr newfs_hammer2 8
 135 .Sh HISTORY
 136 The
 137 .Nm
 138 utility first appeared in
 139 .Dx 3.3 .
 140 .Sh AUTHORS
 141 This manual page was written by
 142 .An Thomas Nikolajsen .