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