usr.sbin/fstyp/fstyp.8

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