xref: /dragonfly/usr.sbin/fstyp/fstyp.8 (revision cae2835b)
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 April 14, 2016
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, and HAMMER 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.El
72.Pp
73Note that HAMMER filesystem consists of more than one volumes requires a path in blkdevs format.
74See
75.Xr hammer 8
76for blkdevs format.
77.Nm
78doesn't recognize partially specified block devices as HAMMER filesystem volumes unless
79.Fl u
80flag is specified.
81.Pp
82Because
83.Nm
84is built specifically to detect filesystem types, it differs from
85.Xr file 1
86in several ways.
87The output is machine-parsable, filesystem labels are supported,
88and does not try to recognize any file format other than filesystems.
89.Pp
90These options are available:
91.Bl -tag -width ".Fl l"
92.It Fl l
93In addition to filesystem type, print filesystem label if available.
94.It Fl s
95Ignore file type.
96By default,
97.Nm
98only works on regular files and disk-like device nodes.
99Trying to read other file types might have unexpected consequences or hang
100indefinitely.
101.It Fl u
102Include filesystems and devices that cannot be mounted directly by
103.Xr mount 8 .
104.El
105.Sh EXIT STATUS
106The
107.Nm
108utility exits 0 on success, and >0 if an error occurs or the filesystem
109type is not recognized.
110.Sh SEE ALSO
111.Xr file 1 ,
112.Xr autofs 5 ,
113.Xr mount 8 ,
114.Xr hammer 8
115.Sh HISTORY
116The
117.Nm
118command appeared in
119.Fx 10.2 .
120The
121.Nm
122command appeared in
123.Dx 4.5 .
124.Sh AUTHORS
125The
126.Nm
127utility was developed by
128.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
129under sponsorship from the FreeBSD Foundation.
130ZFS and GELI support was added by
131.An Allan Jude Aq Mt allanjude@FreeBSD.org
132.Pp
133The
134.Nm
135utility was ported to
136.Dx
137by
138.An Tomohiro Kusumi Aq Mt kusumi.tomohiro@gmail.com .
139Donated to DragonFlyBSD by PeerCorps Trust Fund.
140.Sh BUGS
141The
142.Nm
143utility on
144.Dx
145currently doesn't support
146.Xr zfs 8
147pool and
148.Xr geli 8
149providers supported on
150.Fx .
151