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