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 February 12, 2018
  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 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 cd9660
  61 .It
  62 exfat
  63 .It
  64 ext2fs
  65 .It
  66 msdosfs
  67 .It
  68 ntfs
  69 .It
  70 ufs
  71 .It
  72 hammer
  73 .It
  74 hammer2
  75 .El
  76 .Pp
  77 Note that HAMMER filesystem consists of more than one volumes requires a path in blkdevs format.
  78 See
  79 .Xr hammer 8
  80 for blkdevs format.
  81 .Nm
  82 doesn't recognize partially specified block devices as HAMMER filesystem volumes unless
  83 .Fl u
  84 flag is specified.
  85 .Pp
  86 Because
  87 .Nm
  88 is built specifically to detect filesystem types, it differs from
  89 .Xr file 1
  90 in several ways.
  91 The output is machine-parsable, filesystem labels are supported,
  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 autofs 5 ,
 117 .Xr hammer 8 ,
 118 .Xr hammer2 8 ,
 119 .Xr mount 8
 120 .Sh HISTORY
 121 The
 122 .Nm
 123 command appeared in
 124 .Fx 10.2 .
 125 The
 126 .Nm
 127 command appeared in
 128 .Dx 4.5 .
 129 .Sh AUTHORS
 130 .An -nosplit
 131 The
 132 .Nm
 133 utility was developed by
 134 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
 135 under sponsorship from the FreeBSD Foundation.
 136 ZFS and GELI support was added by
 137 .An Allan Jude Aq Mt allanjude@FreeBSD.org .
 138 .Pp
 139 The
 140 .Nm
 141 utility was ported to
 142 .Dx
 143 by
 144 .An Tomohiro Kusumi Aq Mt kusumi.tomohiro@gmail.com .
 145 Donated to DragonFlyBSD by PeerCorps Trust Fund.
 146 .Sh BUGS
 147 The
 148 .Nm
 149 utility on
 150 .Dx
 151 currently doesn't support
 152 .Xr zfs 8
 153 pool and
 154 .Xr geli 8
 155 providers supported on
 156 .Fx .