NetBSD/usr.sbin/dumpfs/dumpfs.8

.\"	$NetBSD: dumpfs.8,v 1.18 2004/01/03 21:05:21 wiz Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" 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. 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.
.\"
.\"     @(#)dumpfs.8	8.1 (Berkeley) 6/5/93
.\"
.Dd January 3, 2004
.Dt DUMPFS 8
.Os
.Sh NAME
.Nm dumpfs
.Nd dump file system information
.Sh SYNOPSIS
.Nm
.Op Fl acFimsv
.Ar filesys No \&| Ar device
.Op Ar ...
.Sh DESCRIPTION
.Nm
prints out detailed information about the specified filesystems.
.Pp
Options:
.Bl -tag -width Ds
.It Fl a
Print details from each alternate superblock.
.It Fl c
Print details of each cylinder group.
.It Fl F
Dump a file system image from a file, not a special device.
.It Fl i
Print details of each allocated inode.
.It Fl m
Print details of the cylinder group summary.
.It Fl s
Print details of the superblock.
.It Fl v
Be even more verbose.
.El
.Pp
If none of
.Fl a ,
.Fl c ,
.Fl i ,
.Fl m ,
or
.Fl s
are given, then
.Nm
defaults to
.Fl cmsv .
.Pp
.Nm
is useful mostly for finding out certain file system
information such as the file system block size, minimum
free space percentage, and the file system level that
can be upgraded with the
.Fl c
option of
.Xr fsck_ffs 8 .
All of this information is output by
.Nm
.Fl s .
.Sh SEE ALSO
.Xr disktab 5 ,
.Xr fs 5 ,
.Xr disklabel 8 ,
.Xr fsck 8 ,
.Xr fsck_ffs 8 ,
.Xr newfs 8 ,
.Xr tunefs 8
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.2 .
The
.Fl a ,
.Fl c ,
.Fl i ,
.Fl m ,
and
.Fl s
options, and the inode dump were added for
.Nx 2.0 .
Bump date for previous. 2004-01-04 00:05:21 +03:00			`.\" $NetBSD: dumpfs.8,v 1.18 2004/01/03 21:05:21 wiz Exp $`
convert to new RCS Id conventions; reduce my headache 1995-03-18 17:54:19 +03:00			`.\"`
Update from 4.4-Lite, with local changes. 1994-06-08 22:57:30 +04:00			`.\" Copyright (c) 1983, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03: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.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22366, verified by myself. 2003-08-07 15:25:11 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" 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.`
			`.\"`
convert to new RCS Id conventions; reduce my headache 1995-03-18 17:54:19 +03:00			`.\" @(#)dumpfs.8 8.1 (Berkeley) 6/5/93`
added rcs ids to all files 1993-03-22 11:04:00 +03:00			`.\"`
Bump date for previous. 2004-01-04 00:05:21 +03:00			`.Dd January 3, 2004`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt DUMPFS 8`
More and more .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Many more to come. 1999-03-22 21:43:46 +03:00			`.Os`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh NAME`
			`.Nm dumpfs`
			`.Nd dump file system information`
			`.Sh SYNOPSIS`
Determine filesystem level (ref: fsck_ffs(8) -c ...) and display it. Code was derivied from observing how fsck_ffs `upgrades' to a given level, and has been tested on recent NetBSD filesystems (reports as "3"), SunOS ("1"), and ULTRIX ("0"). I haven't found a filesystem of level "2" to test, but the code should detect it. Fixes [bin/1353] 1997-04-26 09:41:32 +04:00			`.Nm`
Add a -a option to dump all alternate superblocks 2003-09-26 11:02:43 +04:00			`.Op Fl acFimsv`
- ansi KNF - add -F flag to specify "argument is an fs image" (effectively a no-op, but here for consistency with other tools). 2001-08-14 05:02:02 +04:00			`.Ar filesys No \&\| Ar device`
Sort options (AaBb...); drop trailing space; use Nx instead of verbose NetBSD; add commas. 2003-08-30 16:48:01 +04:00			`.Op Ar ...`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh DESCRIPTION`
Determine filesystem level (ref: fsck_ffs(8) -c ...) and display it. Code was derivied from observing how fsck_ffs `upgrades' to a given level, and has been tested on recent NetBSD filesystems (reports as "3"), SunOS ("1"), and ULTRIX ("0"). I haven't found a filesystem of level "2" to test, but the code should detect it. Fixes [bin/1353] 1997-04-26 09:41:32 +04:00			`.Nm`
Include a (very raw) dump of the inodes. Add options to determine what is dumped (default to old behaviour). 2003-08-30 14:30:52 +04:00			`prints out detailed information about the specified filesystems.`
			`.Pp`
			`Options:`
			`.Bl -tag -width Ds`
Add a -a option to dump all alternate superblocks 2003-09-26 11:02:43 +04:00			`.It Fl a`
			`Print details from each alternate superblock.`
Include a (very raw) dump of the inodes. Add options to determine what is dumped (default to old behaviour). 2003-08-30 14:30:52 +04:00			`.It Fl c`
			`Print details of each cylinder group.`
Sort options (AaBb...); drop trailing space; use Nx instead of verbose NetBSD; add commas. 2003-08-30 16:48:01 +04:00			`.It Fl F`
			`Dump a file system image from a file, not a special device.`
Include a (very raw) dump of the inodes. Add options to determine what is dumped (default to old behaviour). 2003-08-30 14:30:52 +04:00			`.It Fl i`
			`Print details of each allocated inode.`
			`.It Fl m`
			`Print details of the cylinder group summary.`
			`.It Fl s`
			`Print details of the superblock.`
			`.It Fl v`
			`Be even more verbose.`
			`.El`
			`.Pp`
			`If none of`
Add a -a option to dump all alternate superblocks 2003-09-26 11:02:43 +04:00			`.Fl a ,`
Include a (very raw) dump of the inodes. Add options to determine what is dumped (default to old behaviour). 2003-08-30 14:30:52 +04:00			`.Fl c ,`
			`.Fl i ,`
Sort options (AaBb...); drop trailing space; use Nx instead of verbose NetBSD; add commas. 2003-08-30 16:48:01 +04:00			`.Fl m ,`
Include a (very raw) dump of the inodes. Add options to determine what is dumped (default to old behaviour). 2003-08-30 14:30:52 +04:00			`or`
			`.Fl s`
			`are given, then`
			`.Nm`
			`defaults to`
restore traditional output for older filesystems add byte swapping support for inode printing 2004-01-03 22:32:58 +03:00			`.Fl cmsv .`
Determine filesystem level (ref: fsck_ffs(8) -c ...) and display it. Code was derivied from observing how fsck_ffs `upgrades' to a given level, and has been tested on recent NetBSD filesystems (reports as "3"), SunOS ("1"), and ULTRIX ("0"). I haven't found a filesystem of level "2" to test, but the code should detect it. Fixes [bin/1353] 1997-04-26 09:41:32 +04:00			`.Pp`
			`.Nm`
			`is useful mostly for finding out certain file system`
			`information such as the file system block size, minimum`
			`free space percentage, and the file system level that`
			`can be upgraded with the`
			`.Fl c`
Whitespace nits. 2002-01-19 06:10:26 +03:00			`option of`
Determine filesystem level (ref: fsck_ffs(8) -c ...) and display it. Code was derivied from observing how fsck_ffs `upgrades' to a given level, and has been tested on recent NetBSD filesystems (reports as "3"), SunOS ("1"), and ULTRIX ("0"). I haven't found a filesystem of level "2" to test, but the code should detect it. Fixes [bin/1353] 1997-04-26 09:41:32 +04:00			`.Xr fsck_ffs 8 .`
Include a (very raw) dump of the inodes. Add options to determine what is dumped (default to old behaviour). 2003-08-30 14:30:52 +04:00			`All of this information is output by`
			`.Nm`
			`.Fl s .`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SEE ALSO`
			`.Xr disktab 5 ,`
Determine filesystem level (ref: fsck_ffs(8) -c ...) and display it. Code was derivied from observing how fsck_ffs `upgrades' to a given level, and has been tested on recent NetBSD filesystems (reports as "3"), SunOS ("1"), and ULTRIX ("0"). I haven't found a filesystem of level "2" to test, but the code should detect it. Fixes [bin/1353] 1997-04-26 09:41:32 +04:00			`.Xr fs 5 ,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Xr disklabel 8 ,`
Determine filesystem level (ref: fsck_ffs(8) -c ...) and display it. Code was derivied from observing how fsck_ffs `upgrades' to a given level, and has been tested on recent NetBSD filesystems (reports as "3"), SunOS ("1"), and ULTRIX ("0"). I haven't found a filesystem of level "2" to test, but the code should detect it. Fixes [bin/1353] 1997-04-26 09:41:32 +04:00			`.Xr fsck 8 ,`
fix typo. from msaitoh@spa.is.uec.ac.jp, [misc/3584] 1997-05-08 03:19:03 +04:00			`.Xr fsck_ffs 8 ,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Xr newfs 8 ,`
Determine filesystem level (ref: fsck_ffs(8) -c ...) and display it. Code was derivied from observing how fsck_ffs `upgrades' to a given level, and has been tested on recent NetBSD filesystems (reports as "3"), SunOS ("1"), and ULTRIX ("0"). I haven't found a filesystem of level "2" to test, but the code should detect it. Fixes [bin/1353] 1997-04-26 09:41:32 +04:00			`.Xr tunefs 8`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.Bx 4.2 .`
Include a (very raw) dump of the inodes. Add options to determine what is dumped (default to old behaviour). 2003-08-30 14:30:52 +04:00			`The`
Add a -a option to dump all alternate superblocks 2003-09-26 11:02:43 +04:00			`.Fl a ,`
Include a (very raw) dump of the inodes. Add options to determine what is dumped (default to old behaviour). 2003-08-30 14:30:52 +04:00			`.Fl c ,`
			`.Fl i ,`
Sort options (AaBb...); drop trailing space; use Nx instead of verbose NetBSD; add commas. 2003-08-30 16:48:01 +04:00			`.Fl m ,`
Include a (very raw) dump of the inodes. Add options to determine what is dumped (default to old behaviour). 2003-08-30 14:30:52 +04:00			`and`
			`.Fl s`
Sort options (AaBb...); drop trailing space; use Nx instead of verbose NetBSD; add commas. 2003-08-30 16:48:01 +04:00			`options, and the inode dump were added for`
			`.Nx 2.0 .`