freebsd-skq/sbin/ffsinfo/ffsinfo.8

.\" Copyright (c) 2000 Christoph Herrmann, Thomas-Henning von Kamptz
.\" Copyright (c) 1980, 1989, 1993 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Christoph Herrmann and Thomas-Henning von Kamptz, Munich and Frankfurt.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgment:
.\"      This product includes software developed by the University of
.\"      California, Berkeley and its contributors, as well as Christoph
.\"      Herrmann and Thomas-Henning von Kamptz.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $TSHeader: src/sbin/ffsinfo/ffsinfo.8,v 1.3 2000/12/12 19:30:55 tomsoft Exp $
.\" $FreeBSD$
.\"
.Dd September 8, 2000
.Dt FSINFO 8
.Os
.Sh NAME
.Nm ffsinfo
.Nd "dump all meta information of an existing ufs file system"
.Sh SYNOPSIS
.Nm
.Op Fl g Ar cylinder_group
.Op Fl i Ar inode
.Op Fl l Ar level
.Op Fl o Ar outfile
.Ar special | file
.Sh DESCRIPTION
The
.Nm
utility extends the
.Xr dumpfs 8
utility.
.Pp
The output is appended to the file
.Pa outfile .
Also expect the output file to be rather large.
Up to 2 percent of the size of the specified file system is not uncommon.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl g Ar cylinder_group
This restricts the dump to information about this cylinder group only.
Here
.Ar 0
means the first cylinder group and
.Ar -1
the last one.
.It Fl i Ar inode
This restricts the dump to information about this particular inode only.
Here the minimum acceptable inode is
.Ar 2 .
If this option is omitted but a cylinder group is defined then only inodes
within that cylinder group are dumped.
.It Fl l Ar level
The level of detail which will be dumped.
This value defaults to
.Ar 255
and is the
.Dq bitwise or
of the following table:
.Pp
.Bl -hang -width indent -compact
.It Ar 0x001
initial superblock
.It Ar 0x002
superblock copies in each cylinder group
.It Ar 0x004
cylinder group summary in initial cylinder group
.It Ar 0x008
cylinder group information
.It Ar 0x010
inode allocation bitmap
.It Ar 0x020
fragment allocation bitmap
.It Ar 0x040
cluster maps and summary
.It Ar 0x100
inode information
.It Ar 0x200
indirect block dump
.El
.It Fl o Ar outfile
This sets the output filename where the dump is written to, and
must be specified.
If
.Fl
is provided, output will be sent to stdout.
.El
.Sh EXAMPLES
.Dl ffsinfo -o /var/tmp/ffsinfo -l 1023 /dev/vinum/testvol
.Pp
will dump
.Pa /dev/vinum/testvol
to
.Pa /var/tmp/ffsinfo
with all available information.
.Sh SEE ALSO
.Xr disklabel 8 ,
.Xr dumpfs 8 ,
.Xr fsck 8 ,
.Xr growfs 8 ,
.Xr newfs 8 ,
.Xr tunefs 8 ,
.Xr vinum 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 4.4 .
.Sh AUTHORS
.An Christoph Herrmann Aq chm@FreeBSD.org
.An Thomas-Henning von Kamptz Aq tomsoft@FreeBSD.org
.An The GROWFS team Aq growfs@Tomsoft.COM
.Sh BUGS
Snapshots are handled like plain files.
They should get their own level to provide for independent control of the
amount of what gets dumped.
It probably also makes sense to some extend to dump the snapshot as a
file system.
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.\" Copyright (c) 2000 Christoph Herrmann, Thomas-Henning von Kamptz`
			`.\" Copyright (c) 1980, 1989, 1993 The Regents of the University of California.`
			`.\" All rights reserved.`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`.\"`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.\" This code is derived from software contributed to Berkeley by`
			`.\" Christoph Herrmann and Thomas-Henning von Kamptz, Munich and Frankfurt.`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`.\"`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgment:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors, as well as Christoph`
			`.\" Herrmann and Thomas-Henning von Kamptz.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`.\"`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`.\" $TSHeader: src/sbin/ffsinfo/ffsinfo.8,v 1.3 2000/12/12 19:30:55 tomsoft Exp $`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.\" $FreeBSD$`
			`.\"`
			`.Dd September 8, 2000`
			`.Dt FSINFO 8`
Mdoc(7)ify. 2000-12-13 11:33:19 +00:00			`.Os`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Sh NAME`
			`.Nm ffsinfo`
s/filesystem/file system/g as discussed on -developers 2002-08-21 18:11:48 +00:00			`.Nd "dump all meta information of an existing ufs file system"`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Sh SYNOPSIS`
Mdoc(7)ify. 2000-12-13 11:33:19 +00:00			`.Nm`
			`.Op Fl g Ar cylinder_group`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Op Fl i Ar inode`
			`.Op Fl l Ar level`
			`.Op Fl o Ar outfile`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`.Ar special \| file`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-20 11:58:12 +00:00			`The`
			`.Nm`
			`utility extends the`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Xr dumpfs 8`
Use `The .Nm utility' 2002-04-20 11:58:12 +00:00			`utility.`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Pp`
Clarify behaviour of ffsinfo: It appends to outfile without removing any existing contents. PR: bin/61473 Submitted by: Alex Popa <razon@ldc.ro> MFC after: 7 days Approved by: rwatson (mentor) 2004-01-23 05:13:22 +00:00			`The output is appended to the file`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`.Pa outfile .`
			`Also expect the output file to be rather large.`
s/filesystem/file system/g as discussed on -developers 2002-08-21 18:11:48 +00:00			`Up to 2 percent of the size of the specified file system is not uncommon.`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`.Pp`
			`The following options are available:`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Bl -tag -width indent`
Mdoc(7)ify. 2000-12-13 11:33:19 +00:00			`.It Fl g Ar cylinder_group`
			`This restricts the dump to information about this cylinder group only.`
			`Here`
			`.Ar 0`
			`means the first cylinder group and`
			`.Ar -1`
			`the last one.`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.It Fl i Ar inode`
Mdoc(7)ify. 2000-12-13 11:33:19 +00:00			`This restricts the dump to information about this particular inode only.`
			`Here the minimum acceptable inode is`
			`.Ar 2 .`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`If this option is omitted but a cylinder group is defined then only inodes`
			`within that cylinder group are dumped.`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.It Fl l Ar level`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`The level of detail which will be dumped.`
Mdoc(7)ify. 2000-12-13 11:33:19 +00:00			`This value defaults to`
			`.Ar 255`
			`and is the`
			`.Dq bitwise or`
			`of the following table:`
			`.Pp`
			`.Bl -hang -width indent -compact`
			`.It Ar 0x001`
			`initial superblock`
			`.It Ar 0x002`
			`superblock copies in each cylinder group`
			`.It Ar 0x004`
			`cylinder group summary in initial cylinder group`
			`.It Ar 0x008`
			`cylinder group information`
			`.It Ar 0x010`
			`inode allocation bitmap`
			`.It Ar 0x020`
			`fragment allocation bitmap`
			`.It Ar 0x040`
			`cluster maps and summary`
			`.It Ar 0x100`
			`inode information`
			`.It Ar 0x200`
			`indirect block dump`
			`.El`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.It Fl o Ar outfile`
Grammatical improvement. 2005-04-08 10:32:22 +00:00			`This sets the output filename where the dump is written to, and`
Don't default to '/var/tmp/ffsinfo' for the output of ffsinfo(8), since /var/tmp is a world-writable directory. MFC after: 3 days Reported by: Jon Passki <cykyc@yahoo.com> 2005-03-31 04:05:17 +00:00			`must be specified.`
mdoc(7) police: nits. 2002-05-29 16:47:55 +00:00			`If`
			`.Fl`
			`is provided, output will be sent to stdout.`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.El`
			`.Sh EXAMPLES`
Don't default to '/var/tmp/ffsinfo' for the output of ffsinfo(8), since /var/tmp is a world-writable directory. MFC after: 3 days Reported by: Jon Passki <cykyc@yahoo.com> 2005-03-31 04:05:17 +00:00			`.Dl ffsinfo -o /var/tmp/ffsinfo -l 1023 /dev/vinum/testvol`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Pp`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`will dump`
			`.Pa /dev/vinum/testvol`
Don't default to '/var/tmp/ffsinfo' for the output of ffsinfo(8), since /var/tmp is a world-writable directory. MFC after: 3 days Reported by: Jon Passki <cykyc@yahoo.com> 2005-03-31 04:05:17 +00:00			`to`
			`.Pa /var/tmp/ffsinfo`
corrected spelling mistakes in comments check a couple of mallocs usage of errx linebreaks of DBG_ macros, correcting the usage of nroff macros Submitted by: grog, charnier Reviewed by: chm 2000-12-12 20:03:17 +00:00			`with all available information.`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Sh SEE ALSO`
			`.Xr disklabel 8 ,`
Mdoc(7)ify. 2000-12-13 11:33:19 +00:00			`.Xr dumpfs 8 ,`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Xr fsck 8 ,`
Mdoc(7)ify. 2000-12-13 11:33:19 +00:00			`.Xr growfs 8 ,`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Xr newfs 8 ,`
			`.Xr tunefs 8 ,`
Mdoc(7)ify. 2000-12-13 11:33:19 +00:00			`.Xr vinum 8`
added growfs(8) including ffsinfo(8) to the freebsd base system Reviewed by: grog 2000-12-09 15:27:35 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
Use `The .Nm utility' 2002-04-20 11:58:12 +00:00			`utility first appeared in`
MFS: in HISTORY section, fix release number of first appearance 2001-08-01 12:15:21 +00:00			`.Fx 4.4 .`
Sort sections. 2005-01-18 10:09:38 +00:00			`.Sh AUTHORS`
			`.An Christoph Herrmann Aq chm@FreeBSD.org`
			`.An Thomas-Henning von Kamptz Aq tomsoft@FreeBSD.org`
			`.An The GROWFS team Aq growfs@Tomsoft.COM`
			`.Sh BUGS`
			`Snapshots are handled like plain files.`
			`They should get their own level to provide for independent control of the`
			`amount of what gets dumped.`
			`It probably also makes sense to some extend to dump the snapshot as a`
			`file system.`