xref: /freebsd/usr.sbin/fstyp/fstyp.8 (revision 4232f826683298e85d469c0ef17259cecd13b2c7)
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 January 14, 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.Ar special
41.Sh DESCRIPTION
42The
43.Nm
44utility is used to determine the filesystem type on a given device.
45It can recognize ISO-9660, Ext2, FAT, NTFS, and UFS filesystems.
46The filesystem name is printed to the standard output
47as, respectively,
48.Li cd9660 ,
49.Li ext2fs ,
50.Li msdosfs ,
51.Li ntfs ,
52or
53.Li ufs .
54.Pp
55Because
56.Nm
57is built specifically to detect filesystem types, it differs from
58.Xr file 1
59in several ways.
60The output is machine-parsable, filesystem labels are supported,
61the utility runs sandboxed using
62.Xr capsicum 4 ,
63and does not try to recognize any file format other than filesystems.
64.Pp
65These options are available:
66.Bl -tag -width ".Fl l"
67.It Fl l
68In addition to filesystem type, print filesystem label if available.
69.It Fl s
70Ignore file type.
71By default,
72.Nm
73only works on regular files and disk-like device nodes.
74Trying to read other file types might have unexpected consequences or hang
75indefinitely.
76.El
77.Sh EXIT STATUS
78The
79.Nm
80utility exits 0 on success, and >0 if an error occurs or the filesystem
81type is not recognized.
82.Sh SEE ALSO
83.Xr file 1 ,
84.Xr capsicum 4 ,
85.Xr glabel 8 ,
86.Xr mount 8
87.Sh HISTORY
88The
89.Nm
90command appeared in
91.Fx 11.0 .
92.Sh AUTHORS
93The
94.Nm
95utility was developed by
96.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
97under sponsorship from the FreeBSD Foundation.
98