1 '\" te
   2 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
   3 .\" Copyright (c) 2002-2006 Szabolcs Szakacsits
   4 .\" Copyright (c) 2002-2005 Anton Altaparmakov
   5 .\" Copyright (c) 2002-2003 Richard Russon
   6 .\" Copyright (c) 2007 Yura Pakhuchiy
   7 .\" This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation ; either version 2 of the License, or (at your option) any later version.  This program is distributed
   8 .\" in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.  You should have received a copy of the GNU General Public License along with this program
   9 .\" (in the main directory of the Linux-NTFS distribution in the file COPYING);  if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 11-1307 USA
  10 .TH NTFSCAT 1M "May 28, 2009"
  11 .SH NAME
  12 ntfscat \- display NTFS files and streams on the standard output
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBntfscat\fR [\fIoptions\fR] \fIdevice\fR [\fIfile\fR]
  17 .fi
  18 
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBntfscat\fR command reads a file or stream from an NTFS volume and
  23 display the contents on the standard output.
  24 .sp
  25 .LP
  26 The case of the filename passed to \fBntfscat\fR is ignored.
  27 .SH OPTIONS
  28 .sp
  29 .LP
  30 Supported options are listed below. Most options have both single-letter and
  31 full-name forms. Multiple single-letter options that do not take an argument
  32 can be combined. For example, \fB-fv\fR is the equivalent of \fB-f\fR \fB-v\fR.
  33 A full-name option can be abbreviated to a unique prefix of its name.
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fB-a\fR, \fB--attribute\fR \fItype\fR\fR
  38 .ad
  39 .sp .6
  40 .RS 4n
  41 Display the contents of a particular attribute type. By default, the unnamed
  42 \fB$DATA\fR attribute will be shown. The attribute can be specified by a number
  43 in decimal or hexadecimal, or by name.
  44 .sp
  45 .in +2
  46 .nf
  47 Hex     Decimal Name
  48 0x10    16      "$STANDARD_INFORMATION"
  49 0x20    32      "$ATTRIBUTE_LIST"
  50 0x30    48      "$FILE_NAME"
  51 0x40    64      "$OBJECT_ID"
  52 0x50    80      "$SECURITY_DESCRIPTOR"
  53 0x60    96      "$VOLUME_NAME"
  54 0x70    112     "$VOLUME_INFORMATION"
  55 0x80    128     "$DATA"
  56 0x90    144     "$INDEX_ROOT"
  57 0xA0    160     "$INDEX_ALLOCATION"
  58 0xB0    176     "$BITMAP"
  59 0xC0    192     "$REPARSE_POINT"
  60 0xD0    208     "$EA_INFORMATION"
  61 0xE0    224     "$EA"
  62 0xF0    240     "$PROPERTY_SET"
  63 0x100   256     "$LOGGED_UTILITY_STREAM"
  64 .fi
  65 .in -2
  66 .sp
  67 
  68 The attribute names can be specified without the leading dollar sign (\fB$\fR)
  69 symbol. If you use the \fB$\fR symbol, you must quote the name to prevent the
  70 shell from interpreting the name.
  71 .RE
  72 
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fB-f\fR, \fB--force\fR\fR
  77 .ad
  78 .sp .6
  79 .RS 4n
  80 Overrides some sensible defaults, such as not using a mounted volume. Use this
  81 option with caution.
  82 .RE
  83 
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fB-h\fR, \fB--help\fR\fR
  88 .ad
  89 .sp .6
  90 .RS 4n
  91 Show a list of options with a brief description of each.
  92 .RE
  93 
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB-i\fR, \fB--inode\fR \fInum\fR\fR
  98 .ad
  99 .sp .6
 100 .RS 4n
 101 Specify a file by its inode number instead of its name.
 102 .RE
 103 
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB-n\fR, \fB--attribute-name\fR \fIname\fR\fR
 108 .ad
 109 .sp .6
 110 .RS 4n
 111 Display the attribute identified by \fIname\fR.
 112 .RE
 113 
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fB-q\fR, \fB--quiet\fR\fR
 118 .ad
 119 .sp .6
 120 .RS 4n
 121 Suppress some debug, warning, and error messages.
 122 .RE
 123 
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fB-V\fR, \fB--version\fR\fR
 128 .ad
 129 .sp .6
 130 .RS 4n
 131 Show the version number, copyright, and license information.
 132 .RE
 133 
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fB-v\fR, \fB--verbose\fR\fR
 138 .ad
 139 .sp .6
 140 .RS 4n
 141 Display more debug, warning, and error messages.
 142 .RE
 143 
 144 .SH EXAMPLES
 145 .LP
 146 \fBExample 1 \fRDisplaying Contents of File in Root
 147 .sp
 148 .LP
 149 The following command displays the contents of a file in the root of an NTFS
 150 volume.
 151 
 152 .sp
 153 .in +2
 154 .nf
 155 # \fBntfscat /dev/dsk/c0d0p1 boot.ini\fR
 156 .fi
 157 .in -2
 158 .sp
 159 
 160 .LP
 161 \fBExample 2 \fRDisplaying Contents of File in Subdirectory
 162 .sp
 163 .LP
 164 The following command displays the contents of a file in a subdirectory of an
 165 NTFS volume.
 166 
 167 .sp
 168 .in +2
 169 .nf
 170 # \fBntfscat /dev/dsk/c0d0p1 /winnt/system32/drivers/etc/hosts\fR
 171 .fi
 172 .in -2
 173 .sp
 174 
 175 .LP
 176 \fBExample 3 \fRDisplay Contents of an Attribute
 177 .sp
 178 .LP
 179 The following command displays the contents of the \fB$INDEX_ROOT\fR attribute
 180 of the root directory (inode 5).
 181 
 182 .sp
 183 .in +2
 184 .nf
 185 # \fBntfscat /dev/dsk/c0d0p1 -a INDEX_ROOT -i 5\fR
 186 .fi
 187 .in -2
 188 .sp
 189 
 190 .SH ATTRIBUTES
 191 .sp
 192 .LP
 193 See \fBattributes\fR(5) for descriptions of the following attributes:
 194 .sp
 195 
 196 .sp
 197 .TS
 198 box;
 199 c | c
 200 l | l .
 201 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 202 _
 203 Interface Stability     Uncommitted
 204 .TE
 205 
 206 .SH SEE ALSO
 207 .sp
 208 .LP
 209 \fBntfsls\fR(1M), \fBntfsprogs\fR(1M), \fBparted\fR(1M), \fBattributes\fR(5)
 210 .sp
 211 .LP
 212 http://wiki.linux-ntfs.org
 213 .SH AUTHORS
 214 .sp
 215 .LP
 216 \fBntfscat\fR was written by Richard Russon, Anton Altaparmakov and Szabolcs
 217 Szakacsits.