usr.sbin/fstyp/fstyp.8

   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 .\" $FreeBSD$
  28 .\"
  29 .Dd December 24, 2019
  30 .Dt FSTYP 8
  31 .Os
  32 .Sh NAME
  33 .Nm fstyp
  34 .Nd determine filesystem type
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl l
  38 .Op Fl s
  39 .Op Fl u
  40 .Ar special
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility is used to determine the filesystem type on a given device.
  45 It can recognize BeFS (BeOS), ISO-9660, exFAT, Ext2, FAT, NTFS, and UFS filesystems.
  46 When the
  47 .Fl u
  48 flag is specified,
  49 .Nm
  50 also recognizes certain additional metadata formats that cannot be
  51 handled using
  52 .Xr mount 8 ,
  53 such as
  54 .Xr geli 8
  55 providers, and
  56 ZFS pools.
  57 .Pp
  58 The filesystem name is printed to the standard output
  59 as, respectively:
  60 .Bl -item -offset indent -compact
  61 .It
  62 befs
  63 .It
  64 cd9660
  65 .It
  66 exfat
  67 .It
  68 ext2fs
  69 .It
  70 geli
  71 .It
  72 hammer
  73 .It
  74 hammer2
  75 .It
  76 msdosfs
  77 .It
  78 ntfs
  79 .It
  80 ufs
  81 .It
  82 zfs
  83 .El
  84 .Pp
  85 Because
  86 .Nm
  87 is built specifically to detect filesystem types, it differs from
  88 .Xr file 1
  89 in several ways.
  90 The output is machine-parsable, filesystem labels are supported,
  91 the utility runs sandboxed using
  92 .Xr capsicum 4 ,
  93 and does not try to recognize any file format other than filesystems.
  94 .Pp
  95 These options are available:
  96 .Bl -tag -width ".Fl l"
  97 .It Fl l
  98 In addition to filesystem type, print filesystem label if available.
  99 .It Fl s
 100 Ignore file type.
 101 By default,
 102 .Nm
 103 only works on regular files and disk-like device nodes.
 104 Trying to read other file types might have unexpected consequences or hang
 105 indefinitely.
 106 .It Fl u
 107 Include filesystems and devices that cannot be mounted directly by
 108 .Xr mount 8 .
 109 .El
 110 .Sh EXIT STATUS
 111 The
 112 .Nm
 113 utility exits 0 on success, and >0 if an error occurs or the filesystem
 114 type is not recognized.
 115 .Sh SEE ALSO
 116 .Xr file 1 ,
 117 .Xr capsicum 4 ,
 118 .Xr autofs 5 ,
 119 .Xr geli 8 ,
 120 .Xr glabel 8 ,
 121 .Xr mount 8 ,
 122 .Xr zpool 8
 123 .Sh HISTORY
 124 The
 125 .Nm
 126 command appeared in
 127 .Fx 10.2 .
 128 .Sh AUTHORS
 129 .An -nosplit
 130 The
 131 .Nm
 132 utility was developed by
 133 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
 134 under sponsorship from the FreeBSD Foundation.
 135 ZFS and GELI support was added by
 136 .An Allan Jude Aq Mt allanjude@FreeBSD.org .