xref: /dragonfly/sbin/ffsinfo/ffsinfo.8 (revision 8edfbc5e)
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.\"
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 L
49.Op Fl g Ar cylinder_group
50.Op Fl i Ar inode
51.Op Fl l Ar level
52.Op Fl o Ar outfile
53.Ar special | file
54.Sh DESCRIPTION
55The
56.Nm
57utility extends the
58.Xr dumpfs 8
59utility.
60.Pp
61The output is appended to the file
62.Pa outfile .
63Also expect the output file to be rather large.
64Up to 2 percent of the size of the specified file system is not uncommon.
65.Pp
66The following options are available:
67.Bl -tag -width indent
68.It Fl L
69Specifying this option skips the tests of the disklabel.
70This is done automatically, if the specified filename to dump is a plain file.
71.It Fl g Ar cylinder_group
72This restricts the dump to information about this cylinder group only.
73Here
74.Ar 0
75means the first cylinder group and
76.Ar -1
77the last one.
78.It Fl i Ar inode
79This restricts the dump to information about this particular inode only.
80Here the minimum acceptable inode is
81.Ar 2 .
82If this option is omitted but a cylinder group is defined then only inodes
83within that cylinder group are dumped.
84.It Fl l Ar level
85The level of detail which will be dumped.
86This value defaults to
87.Ar 255
88and is the
89.Dq bitwise or
90of the following table:
91.Pp
92.Bl -hang -width indent -compact
93.It Ar 0x001
94initial superblock
95.It Ar 0x002
96superblock copies in each cylinder group
97.It Ar 0x004
98cylinder group summary in initial cylinder group
99.It Ar 0x008
100cylinder group information
101.It Ar 0x010
102inode allocation bitmap
103.It Ar 0x020
104fragment allocation bitmap
105.It Ar 0x040
106cluster maps and summary
107.It Ar 0x080
108rotational layout tables
109.It Ar 0x100
110inode information
111.It Ar 0x200
112indirect block dump
113.El
114.It Fl o Ar outfile
115This allows to change the output filename where the dump is written to.
116By default output goes to stdout.
117.El
118.Sh EXAMPLES
119.Dl ffsinfo -l 1023 /dev/vinum/testvol
120.Pp
121will dump
122.Pa /dev/vinum/testvol
123with all available information.
124.Sh SEE ALSO
125.Xr disklabel 8 ,
126.Xr dumpfs 8 ,
127.Xr fsck 8 ,
128.Xr growfs 8 ,
129.Xr newfs 8 ,
130.Xr tunefs 8 ,
131.Xr vinum 8
132.Sh HISTORY
133The
134.Nm
135utility first appeared in
136.Fx 4.4 .
137.Sh AUTHORS
138.An Christoph Herrmann Aq Mt chm@FreeBSD.org
139.An Thomas-Henning von Kamptz Aq Mt tomsoft@FreeBSD.org
140.An The GROWFS team Aq Mt growfs@Tomsoft.COM
141.Sh BUGS
142Dumping a mounted filesystem will work, but may produce data which is
143not completely synchronized.
144