xref: /freebsd/usr.sbin/fstyp/fstyp.8 (revision 734e82fe33aa764367791a7d603b383996c6b40b)
1.\" Copyright (c) 2014 The FreeBSD Foundation
2.\"
3.\" This software was developed by Edward Tomasz Napierala under sponsorship
4.\" from the FreeBSD Foundation.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd December 24, 2019
28.Dt FSTYP 8
29.Os
30.Sh NAME
31.Nm fstyp
32.Nd determine filesystem type
33.Sh SYNOPSIS
34.Nm
35.Op Fl l
36.Op Fl s
37.Op Fl u
38.Ar special
39.Sh DESCRIPTION
40The
41.Nm
42utility is used to determine the filesystem type on a given device.
43It can recognize BeFS (BeOS), ISO-9660, exFAT, Ext2, FAT, NTFS, and UFS filesystems.
44When the
45.Fl u
46flag is specified,
47.Nm
48also recognizes certain additional metadata formats that cannot be
49handled using
50.Xr mount 8 ,
51such as
52.Xr geli 8
53providers, and
54ZFS pools.
55.Pp
56The filesystem name is printed to the standard output
57as, respectively:
58.Bl -item -offset indent -compact
59.It
60befs
61.It
62cd9660
63.It
64exfat
65.It
66ext2fs
67.It
68geli
69.It
70hammer
71.It
72hammer2
73.It
74msdosfs
75.It
76ntfs
77.It
78ufs
79.It
80zfs
81.El
82.Pp
83Because
84.Nm
85is built specifically to detect filesystem types, it differs from
86.Xr file 1
87in several ways.
88The output is machine-parsable, filesystem labels are supported,
89the utility runs sandboxed using
90.Xr capsicum 4 ,
91and does not try to recognize any file format other than filesystems.
92.Pp
93These options are available:
94.Bl -tag -width ".Fl l"
95.It Fl l
96In addition to filesystem type, print filesystem label if available.
97.It Fl s
98Ignore file type.
99By default,
100.Nm
101only works on regular files and disk-like device nodes.
102Trying to read other file types might have unexpected consequences or hang
103indefinitely.
104.It Fl u
105Include filesystems and devices that cannot be mounted directly by
106.Xr mount 8 .
107.El
108.Sh EXIT STATUS
109The
110.Nm
111utility exits 0 on success, and >0 if an error occurs or the filesystem
112type is not recognized.
113.Sh SEE ALSO
114.Xr file 1 ,
115.Xr capsicum 4 ,
116.Xr autofs 5 ,
117.Xr geli 8 ,
118.Xr glabel 8 ,
119.Xr mount 8 ,
120.Xr zpool 8
121.Sh HISTORY
122The
123.Nm
124command appeared in
125.Fx 10.2 .
126.Sh AUTHORS
127.An -nosplit
128The
129.Nm
130utility was developed by
131.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
132under sponsorship from the FreeBSD Foundation.
133ZFS and GELI support was added by
134.An Allan Jude Aq Mt allanjude@FreeBSD.org .
135