usr.sbin/fstyp/fstyp.8

   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 August 28, 2021
  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
  44 The
  45 .Nm
  46 utility is used to determine the filesystem type on a given device.
  47 It can recognize BeFS (BeOS), ISO-9660, exFAT, Ext2, FAT, NTFS, UFS, HAMMER, and HAMMER2 filesystems.
  48 When the
  49 .Fl u
  50 flag is specified,
  51 .Nm
  52 also recognizes certain additional metadata formats that cannot be
  53 handled using
  54 .Xr mount 8 .
  55 .Pp
  56 The filesystem name is printed to the standard output
  57 as, respectively:
  58 .Bl -item -offset indent -compact
  59 .It
  60 befs
  61 .It
  62 cd9660
  63 .It
  64 exfat
  65 .It
  66 ext2fs
  67 .It
  68 msdosfs
  69 .It
  70 ntfs
  71 .It
  72 ufs
  73 .It
  74 hammer
  75 .It
  76 hammer2
  77 .El
  78 .Pp
  79 Note that HAMMER filesystem consists of more than one volumes requires a path in blkdevs format.
  80 See
  81 .Xr hammer 8
  82 for blkdevs format.
  83 .Nm
  84 doesn't recognize partially specified block devices as HAMMER filesystem volumes unless
  85 .Fl u
  86 flag is specified.
  87 .Pp
  88 Because
  89 .Nm
  90 is built specifically to detect filesystem types, it differs from
  91 .Xr file 1
  92 in several ways.
  93 The output is machine-parsable, filesystem labels are supported,
  94 and does not try to recognize any file format other than filesystems.
  95 .Pp
  96 These options are available:
  97 .Bl -tag -width ".Fl l"
  98 .It Fl l
  99 In addition to filesystem type, print filesystem label if available.
 100 .It Fl s
 101 Ignore file type.
 102 By default,
 103 .Nm
 104 only works on regular files and disk-like device nodes.
 105 Trying to read other file types might have unexpected consequences or hang
 106 indefinitely.
 107 .It Fl u
 108 Include filesystems and devices that cannot be mounted directly by
 109 .Xr mount 8 .
 110 .El
 111 .Sh EXIT STATUS
 112 The
 113 .Nm
 114 utility exits 0 on success, and >0 if an error occurs or the filesystem
 115 type is not recognized.
 116 .Sh SEE ALSO
 117 .Xr file 1 ,
 118 .Xr autofs 5 ,
 119 .Xr hammer 8 ,
 120 .Xr hammer2 8 ,
 121 .Xr mount 8
 122 .Sh HISTORY
 123 The
 124 .Nm
 125 command appeared in
 126 .Fx 10.2 .
 127 The
 128 .Nm
 129 command appeared in
 130 .Dx 4.5 .
 131 .Sh AUTHORS
 132 .An -nosplit
 133 The
 134 .Nm
 135 utility was developed by
 136 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
 137 under sponsorship from the FreeBSD Foundation.
 138 ZFS and GELI support was added by
 139 .An Allan Jude Aq Mt allanjude@FreeBSD.org .
 140 .Pp
 141 The
 142 .Nm
 143 utility was ported to
 144 .Dx
 145 by
 146 .An Tomohiro Kusumi Aq Mt tkusumi@netbsd.org .
 147 Donated to DragonFlyBSD by PeerCorps Trust Fund.
 148 .Sh BUGS
 149 The
 150 .Nm
 151 utility on
 152 .Dx
 153 currently doesn't support
 154 .Xr zfs 8
 155 pool and
 156 .Xr geli 8
 157 providers supported on
 158 .Fx .