File system police. Add RCS Id. Improve SYNOPSIS. Use more markup.

This commit is contained in:
wiz 2018-01-09 09:41:29 +00:00
parent 2df58e1698
commit f24dbfeb68

View File

@ -1,3 +1,5 @@
.\" $NetBSD: fstyp.8,v 1.2 2018/01/09 09:41:29 wiz Exp $
.\"
.\" Copyright (c) 2017 The NetBSD Foundation, Inc.
.\" Copyright (c) 2016 The DragonFly Project
.\" Copyright (c) 2014 The FreeBSD Foundation
@ -37,18 +39,16 @@
.Os
.Sh NAME
.Nm fstyp
.Nd determine filesystem type
.Nd determine file system type
.Sh SYNOPSIS
.Nm
.Op Fl l
.Op Fl s
.Op Fl u
.Op Fl lsu
.Ar special
.Sh DESCRIPTION
The
.Nm
utility is used to determine the filesystem type on a given device.
It can recognize ISO-9660, Ext2, FAT, NTFS, and UFS filesystems.
utility is used to determine the file system type on a given device.
It can recognize ISO-9660, Ext2, FAT, NTFS, and UFS file systems.
When the
.Fl u
flag is specified,
@ -56,10 +56,9 @@ flag is specified,
also recognizes certain additional metadata formats that cannot be
handled using
.Xr mount 8 ,
such as
ZFS pools.
such as ZFS pools.
.Pp
The filesystem name is printed to the standard output
The file system name is printed to the standard output
as, respectively:
.Bl -item -offset indent -compact
.It
@ -78,16 +77,16 @@ zfs
.Pp
Because
.Nm
is built specifically to detect filesystem types, it differs from
is built specifically to detect file system types, it differs from
.Xr file 1
in several ways.
The output is machine-parsable, filesystem labels are supported,
and does not try to recognize any file format other than filesystems.
The output is machine-parsable, file system labels are supported,
and it does not try to recognize any file format other than file systems.
.Pp
These options are available:
.Bl -tag -width ".Fl l"
.It Fl l
In addition to filesystem type, print filesystem label if available.
In addition to file system type, print file system label if available.
.It Fl s
Ignore file type.
By default,
@ -96,13 +95,13 @@ only works on regular files and disk-like device nodes.
Trying to read other file types might have unexpected consequences or hang
indefinitely.
.It Fl u
Include filesystems and devices that cannot be mounted directly by
Include file systems and devices that cannot be mounted directly by
.Xr mount 8 .
.El
.Sh EXIT STATUS
The
.Nm
utility exits 0 on success, and >0 if an error occurs or the filesystem
utility exits 0 on success, and >0 if an error occurs or the file system
type is not recognized.
.Sh SEE ALSO
.Xr file 1 ,
@ -128,7 +127,9 @@ The
.Nm
utility was developed by
.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
under sponsorship from the FreeBSD Foundation.
under sponsorship from the
.Fx
Foundation.
ZFS and GELI support was added by
.An Allan Jude Aq Mt allanjude@FreeBSD.org .
.Pp
@ -141,8 +142,5 @@ and
by
.An Tomohiro Kusumi Aq Mt kusumi.tomohiro@gmail.com .
.Sh BUGS
.Xr geli 8
and
.Xr hammer 8
are currently unsupported on
geli and hammer are currently unsupported on
.Nx .