sbin/ffsinfo/ffsinfo.8

   1 .\" Copyright (c) 2000 Christoph Herrmann, Thomas-Henning von Kamptz
   2 .\" Copyright (c) 1980, 1989, 1993 The Regents of the University of California.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" Christoph Herrmann and Thomas-Henning von Kamptz, Munich and Frankfurt.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgment:
  18 .\"      This product includes software developed by the University of
  19 .\"      California, Berkeley and its contributors, as well as Christoph
  20 .\"      Herrmann and Thomas-Henning von Kamptz.
  21 .\" 4. Neither the name of the University nor the names of its contributors
  22 .\"    may be used to endorse or promote products derived from this software
  23 .\"    without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\"
  37 .\" $TSHeader: src/sbin/ffsinfo/ffsinfo.8,v 1.3 2000/12/12 19:30:55 tomsoft Exp $
  38 .\" $FreeBSD$
  39 .\"
  40 .Dd September 8, 2000
  41 .Dt FFSINFO 8
  42 .Os
  43 .Sh NAME
  44 .Nm ffsinfo
  45 .Nd "dump all meta information of an existing ufs file system"
  46 .Sh SYNOPSIS
  47 .Nm
  48 .Op Fl g Ar cylinder_group
  49 .Op Fl i Ar inode
  50 .Op Fl l Ar level
  51 .Op Fl o Ar outfile
  52 .Ar special | file
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 utility extends the
  57 .Xr dumpfs 8
  58 utility.
  59 .Pp
  60 The output is appended to the file
  61 .Pa outfile .
  62 Also expect the output file to be rather large.
  63 Up to 2 percent of the size of the specified file system is not uncommon.
  64 .Pp
  65 The following options are available:
  66 .Bl -tag -width indent
  67 .It Fl g Ar cylinder_group
  68 This restricts the dump to information about this cylinder group only.
  69 Here
  70 .Ar 0
  71 means the first cylinder group and
  72 .Ar -1
  73 the last one.
  74 .It Fl i Ar inode
  75 This restricts the dump to information about this particular inode only.
  76 Here the minimum acceptable inode is
  77 .Ar 2 .
  78 If this option is omitted but a cylinder group is defined then only inodes
  79 within that cylinder group are dumped.
  80 .It Fl l Ar level
  81 The level of detail which will be dumped.
  82 This value defaults to
  83 .Ar 255
  84 and is the
  85 .Dq bitwise or
  86 of the following table:
  87 .Pp
  88 .Bl -hang -width indent -compact
  89 .It Ar 0x001
  90 initial superblock
  91 .It Ar 0x002
  92 superblock copies in each cylinder group
  93 .It Ar 0x004
  94 cylinder group summary in initial cylinder group
  95 .It Ar 0x008
  96 cylinder group information
  97 .It Ar 0x010
  98 inode allocation bitmap
  99 .It Ar 0x020
 100 fragment allocation bitmap
 101 .It Ar 0x040
 102 cluster maps and summary
 103 .It Ar 0x100
 104 inode information
 105 .It Ar 0x200
 106 indirect block dump
 107 .El
 108 .It Fl o Ar outfile
 109 This sets the output filename where the dump is written to, and
 110 must be specified.
 111 If
 112 .Fl
 113 is provided, output will be sent to stdout.
 114 .El
 115 .Sh EXAMPLES
 116 .Dl ffsinfo -o /var/tmp/ffsinfo -l 1023 /dev/vinum/testvol
 117 .Pp
 118 will dump
 119 .Pa /dev/vinum/testvol
 120 to
 121 .Pa /var/tmp/ffsinfo
 122 with all available information.
 123 .Sh SEE ALSO
 124 .Xr disklabel 8 ,
 125 .Xr dumpfs 8 ,
 126 .Xr fsck 8 ,
 127 .Xr growfs 8 ,
 128 .Xr newfs 8 ,
 129 .Xr tunefs 8 ,
 130 .Xr vinum 8
 131 .Sh HISTORY
 132 The
 133 .Nm
 134 utility first appeared in
 135 .Fx 4.4 .
 136 .Sh AUTHORS
 137 .An Christoph Herrmann Aq chm@FreeBSD.org
 138 .An Thomas-Henning von Kamptz Aq tomsoft@FreeBSD.org
 139 .An The GROWFS team Aq growfs@Tomsoft.COM
 140 .Sh BUGS
 141 Snapshots are handled like plain files.
 142 They should get their own level to provide for independent control of the
 143 amount of what gets dumped.
 144 It probably also makes sense to some extend to dump the snapshot as a
 145 file system.