usr/src/man/man1m/fstyp.1m

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Copyright 1989 AT&T
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH FSTYP 1M "Dec 19, 2007"
   8 .SH NAME
   9 fstyp \- determine file system type
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBfstyp\fR [\fB-a\fR | \fB-v\fR] \fIspecial\fR [:\fIlogical-drive\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 \fBfstyp\fR allows the user to determine the file system type of unmounted file
  20 systems using heuristic programs.
  21 .sp
  22 .LP
  23 An \fBfstyp\fR module for each file system type to be checked is executed; each
  24 of these modules applies an appropriate heuristic to determine whether the
  25 supplied \fIspecial\fR file is of the type for which it checks. If it is, the
  26 program prints on standard output the usual file system identifier for that
  27 type (for example, ``ufs'') and exits with a return code of \fB0\fR; if none of
  28 the modules succeed, the error message \fBunknown_fstyp (no matches)\fR is
  29 returned and the exit status is \fB1\fR. If more than one module succeeds, the
  30 error message \fBunknown_fstyp (multiple matches)\fR is returned and the exit
  31 status is \fB2\fR. Other errors are printed in the same format.
  32 .sp
  33 .LP
  34 This command is unreliable and its results should not be used to make any
  35 decisions about subsequent use of a storage device or disk partition.
  36 .SH OPTIONS
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fB-a\fR\fR
  41 .ad
  42 .RS 6n
  43 Output all available file system attributes. If a file system has been
  44 successfully identified, and this option is specified, the \fIFSType\fR
  45 identifier is followed by one or more "name-value" pairs, one per line, in the
  46 format:
  47 .sp
  48 .in +2
  49 .nf
  50 name: value
  51 .fi
  52 .in -2
  53 .sp
  54
  55 The following conventions are recognized for the file system attributes:
  56 .RS +4
  57 .TP
  58 .ie t \(bu
  59 .el o
  60 String values are put in single quotes.
  61 .RE
  62 .RS +4
  63 .TP
  64 .ie t \(bu
  65 .el o
  66 Nested "name-value" list increases the indentation of its values by four
  67 whitespaces.
  68 .RE
  69 .RS +4
  70 .TP
  71 .ie t \(bu
  72 .el o
  73 For an array of "name-value" pairs, one array entry is printed per line, with
  74 the index following the name in square brackets.
  75 .RE
  76 For instance, in the following example, "\fItop_list\fR" is a "name-value"
  77 list, consisting of a string array "\fIstring_array\fR" and a "name-value" list
  78 array "\fIlist_array\fR". The second "list_array"element is an integer array
  79 "\fIint_array\fR" containing three elements.
  80 .sp
  81 .in +2
  82 .nf
  83 top_string: 'String'
  84 top_list:
  85     string_array[0]: 'S0'
  86     string_array[1]: 'S1'
  87     list_array[0]:
  88         int_one: 1
  89         string_two: 'S2'
  90     list_array[1]:
  91         int_array[0]: 1
  92         int_array[1]: 2
  93         int_array[2]: 3
  94 .fi
  95 .in -2
  96 .sp
  97
  98 In addition to the \fIFSType\fR-specific attributes, the following generic
  99 attributes may be present:
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fIgen_clean\fR\fR
 104 .ad
 105 .RS 13n
 106 Allowable values are "true" or "false". If the value is "false", the file
 107 system is damaged or was not unmounted cleanly and the \fBfsck\fR(1M) command
 108 must be run before this file system can be mounted.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fIgen_guid\fR\fR
 115 .ad
 116 .RS 12n
 117 Globally unique identifier. This string uniquely identifies the file system.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fIgen_version\fR\fR
 124 .ad
 125 .RS 15n
 126 A string describing the file system version.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fIgen_volume_label\fR\fR
 133 .ad
 134 .RS 20n
 135 Volume label, a human-readable string used to either describe or identify the
 136 file system.
 137 .RE
 138
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fB-v\fR\fR
 145 .ad
 146 .RS 6n
 147 Produce verbose output. This is usually information about the file systems
 148 superblock and varies across different \fIFSTypes\fR. See \fBufs\fR(7FS),
 149 \fBmkfs_ufs\fR(1M), and \fBtunefs\fR(1M) for details.
 150 .RE
 151
 152 .SH USAGE
 153 .sp
 154 .LP
 155 See \fBlargefile\fR(5) for the description of the behavior of \fBfstyp\fR when
 156 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
 157 .SH SEE ALSO
 158 .sp
 159 .LP
 160 \fBfsck\fR(1M), \fBmkfs_ufs\fR(1M), \fBtunefs\fR(1M), \fBattributes\fR(5),
 161 \fBlibfstyp\fR(3LIB), \fBlargefile\fR(5), \fBhsfs\fR(7FS), \fBufs\fR(7FS),
 162 \fBpcfs\fR(7FS)
 163 .SH NOTES
 164 .sp
 165 .LP
 166 The use of heuristics implies that the result of\fBfstyp\fR is not guaranteed
 167 to be accurate.
 168 .sp
 169 .LP
 170 This command is unreliable and its results should not be used to make any
 171 decisions about subsequent use of a storage device or disk partition.