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 NTFSCLUSTER 1M "May 28, 2009"
  11 .SH NAME
  12 ntfscluster \- identify files in a specified region of an NTFS volume
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBntfscluster\fR [\fIoptions\fR] \fIdevice\fR
  17 .fi
  18 
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBntfscluster\fR utility has three modes of operation: \fBinfo\fR,
  23 \fBsector\fR, and \fBcluster\fR, described as follows.
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fBInfo\fR\fR
  28 .ad
  29 .sp .6
  30 .RS 4n
  31 The default mode, \fBinfo\fR is currently not implemented. It will display
  32 general information about the NTFS volume when it is working.
  33 .RE
  34 
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fBSector\fR\fR
  39 .ad
  40 .sp .6
  41 .RS 4n
  42 The \fBsector\fR mode displays a list of files that have data in the specified
  43 range of sectors. This mode is put in effect by the \fB--sector\fR option.
  44 .RE
  45 
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBCluster\fR\fR
  50 .ad
  51 .sp .6
  52 .RS 4n
  53 The \fBcluster\fR mode displays a list of files that have data in the specified
  54 range of clusters. When the cluster size is one sector, this is equivalent to
  55 the \fBsector\fR mode of operation. This mode is put in effect by the
  56 \fB--cluster\fR option.
  57 .RE
  58 
  59 .SH OPTIONS
  60 .sp
  61 .LP
  62 Supported options are listed below. Most options have both single-letter and
  63 full-name forms. Multiple single-letter options that do not take an argument
  64 can be combined. For example, \fB-fv\fR is the equivalent of \fB-f\fR \fB-v\fR.
  65 A full-name option can be abbreviated to a unique prefix of its name.
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-c\fR, \fB--cluster\fR \fIrange\fR\fR
  70 .ad
  71 .sp .6
  72 .RS 4n
  73 Any files whose data is in this range of clusters will be displayed.
  74 .RE
  75 
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fB-F\fR, \fB--filename\fR \fIfilename\fR\fR
  80 .ad
  81 .sp .6
  82 .RS 4n
  83 Display information about \fIfilename\fR.
  84 .RE
  85 
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB-f\fR, \fB--force\fR\fR
  90 .ad
  91 .sp .6
  92 .RS 4n
  93 Overrides some sensible defaults, such as not working with a mounted volume.
  94 Use this option with caution.
  95 .RE
  96 
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fB-h\fR, \fB--help\fR\fR
 101 .ad
 102 .sp .6
 103 .RS 4n
 104 Show a list of options with a brief description of each.
 105 .RE
 106 
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fB-I\fR, \fB--inode\fR \fInum\fR\fR
 111 .ad
 112 .sp .6
 113 .RS 4n
 114 Show information about this inode.
 115 .RE
 116 
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fB-i\fR, \fB--info\fR\fR
 121 .ad
 122 .sp .6
 123 .RS 4n
 124 This option is not yet implemented.
 125 .RE
 126 
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fB-q\fR, \fB--quiet\fR\fR
 131 .ad
 132 .sp .6
 133 .RS 4n
 134 Suppress some debug, warning, and error messages.
 135 .RE
 136 
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fB-s\fR, \fB--sector\fR \fIrange\fR\fR
 141 .ad
 142 .sp .6
 143 .RS 4n
 144 Any files whose data is in this range of sectors will be displayed.
 145 .RE
 146 
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fB-V\fR, \fB--version\fR\fR
 151 .ad
 152 .sp .6
 153 .RS 4n
 154 Show the version number, copyright, and license information.
 155 .RE
 156 
 157 .sp
 158 .ne 2
 159 .na
 160 \fB\fB-v\fR, \fB--verbose\fR\fR
 161 .ad
 162 .sp .6
 163 .RS 4n
 164 Display more debug, warning, and error messages.
 165 .RE
 166 
 167 .SH EXAMPLES
 168 .LP
 169 \fBExample 1 \fRDisplaying Information About a Volume
 170 .sp
 171 .LP
 172 The following command displays information about the volume
 173 \fB/dev/dsk/c0d0p1\fR.
 174 
 175 .sp
 176 .in +2
 177 .nf
 178 # \fBntfscluster /dev/dsk/c0d0p1\fR
 179 .fi
 180 .in -2
 181 .sp
 182 
 183 .LP
 184 \fBExample 2 \fRDisplaying List of Files in a Cluster Range
 185 .sp
 186 .LP
 187 The following command looks for files in the first 500 clusters of
 188 \fB/dev/dsk/c0d0p1\fR.
 189 
 190 .sp
 191 .in +2
 192 .nf
 193 # \fBntfscluster -c 0-500 /dev/dsk/c0d0p1\fR
 194 .fi
 195 .in -2
 196 .sp
 197 
 198 .SH ATTRIBUTES
 199 .sp
 200 .LP
 201 See \fBattributes\fR(5) for descriptions of the following attributes:
 202 .sp
 203 
 204 .sp
 205 .TS
 206 box;
 207 c | c
 208 l | l .
 209 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 210 _
 211 Interface Stability     Uncommitted
 212 .TE
 213 
 214 .SH SEE ALSO
 215 .sp
 216 .LP
 217 \fBntfsinfo\fR(1M), \fBntfsprogs\fR(1M), \fBparted\fR(1M), \fBattributes\fR(5)
 218 .sp
 219 .LP
 220 http://wiki.linux-ntfs.org
 221 .SH AUTHORS
 222 .sp
 223 .LP
 224 \fBntfscluster\fR was written by Richard Russon, with contributions from Anton
 225 Altaparmakov.