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: /repoman/r/ncvs/src/sbin/ffsinfo/ffsinfo.8,v 1.6.2.6 2004/01/29 15:48:26 cperciva Exp $
  39 .\" $DragonFly: src/sbin/ffsinfo/ffsinfo.8,v 1.4 2004/07/08 17:59:01 cpressey Exp $
  40 .\"
  41 .Dd September 8, 2000
  42 .Dt FSINFO 8
  43 .Os
  44 .Sh NAME
  45 .Nm ffsinfo
  46 .Nd "dump all meta information of an existing ufs file system"
  47 .Sh SYNOPSIS
  48 .Nm
  49 .Op Fl L
  50 .Op Fl g Ar cylinder_group
  51 .Op Fl i Ar inode
  52 .Op Fl l Ar level
  53 .Op Fl o Ar outfile
  54 .Ar special | file
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 utility extends the
  59 .Xr dumpfs 8
  60 utility.
  61 .Pp
  62 The output is appended to the file
  63 .Pa outfile .
  64 Also expect the output file to be rather large.
  65 Up to 2 percent of the size of the specified file system is not uncommon.
  66 .Pp
  67 The following options are available:
  68 .Bl -tag -width indent
  69 .It Fl L
  70 Specifying this option skips the tests of the disklabel.
  71 This is done automatically, if the specified filename to dump is a plain file.
  72 .It Fl g Ar cylinder_group
  73 This restricts the dump to information about this cylinder group only.
  74 Here
  75 .Ar 0
  76 means the first cylinder group and
  77 .Ar -1
  78 the last one.
  79 .It Fl i Ar inode
  80 This restricts the dump to information about this particular inode only.
  81 Here the minimum acceptable inode is
  82 .Ar 2 .
  83 If this option is omitted but a cylinder group is defined then only inodes
  84 within that cylinder group are dumped.
  85 .It Fl l Ar level
  86 The level of detail which will be dumped.
  87 This value defaults to
  88 .Ar 255
  89 and is the
  90 .Dq bitwise or
  91 of the following table:
  92 .Pp
  93 .Bl -hang -width indent -compact
  94 .It Ar 0x001
  95 initial superblock
  96 .It Ar 0x002
  97 superblock copies in each cylinder group
  98 .It Ar 0x004
  99 cylinder group summary in initial cylinder group
 100 .It Ar 0x008
 101 cylinder group information
 102 .It Ar 0x010
 103 inode allocation bitmap
 104 .It Ar 0x020
 105 fragment allocation bitmap
 106 .It Ar 0x040
 107 cluster maps and summary
 108 .It Ar 0x080
 109 rotational layout tables
 110 .It Ar 0x100
 111 inode information
 112 .It Ar 0x200
 113 indirect block dump
 114 .El
 115 .It Fl o Ar outfile
 116 This allows to change the output filename where the dump is written to.
 117 The current default is
 118 .Pa /var/tmp/ffsinfo .
 119 If
 120 .Fl
 121 is provided, output will be sent to stdout.
 122 .El
 123 .Sh EXAMPLES
 124 .Dl ffsinfo -l 1023 /dev/vinum/testvol
 125 .Pp
 126 will dump
 127 .Pa /dev/vinum/testvol
 128 with all available information.
 129 .Sh BUGS
 130 Currently
 131 .Nm
 132 can only dump unmounted file systems.
 133 Do not try dumping a mounted file system, your system may panic and you will
 134 not be able to use the file system any longer.
 135 .Pp
 136 Also snapshots are handled like plain files.
 137 They should get their own level to provide for independent control of the
 138 amount of what gets dumped.
 139 It probably also makes sense to some extend to dump the snapshot as a
 140 file system.
 141 .Sh SEE ALSO
 142 .Xr disklabel 8 ,
 143 .Xr dumpfs 8 ,
 144 .Xr fsck 8 ,
 145 .Xr growfs 8 ,
 146 .Xr newfs 8 ,
 147 .Xr tunefs 8 ,
 148 .Xr vinum 8
 149 .Sh AUTHORS
 150 .An Christoph Herrmann Aq chm@FreeBSD.org
 151 .An Thomas-Henning von Kamptz Aq tomsoft@FreeBSD.org
 152 .An The GROWFS team Aq growfs@Tomsoft.COM
 153 .Sh HISTORY
 154 The
 155 .Nm
 156 utility first appeared in
 157 .Fx 4.4 .