ntfsprogs/ntfscluster.8.in

   1 .\" Copyright (c) 2003\-2005 Richard Russon.
   2 .\" This file may be copied under the terms of the GNU Public License.
   3 .\"
   4 .TH NTFSCLUSTER 8 "November 2005" "ntfs-3g @VERSION@"
   5 .SH NAME
   6 ntfscluster \- identify files in a specified region of an NTFS volume.
   7 .SH SYNOPSIS
   8 .B ntfscluster
   9 [\fIoptions\fR] \fIdevice\fR
  10 .SH DESCRIPTION
  11 .B ntfscluster
  12 has three modes of operation:
  13 .IR info ,
  14 .I sector
  15 and
  16 .IR cluster .
  17 .SS Info
  18 .PP
  19 The default mode,
  20 .I info
  21 is currently not implemented.  It will display general information about the
  22 NTFS volume when it is working.
  23 .SS Sector
  24 .PP
  25 The
  26 .I sector
  27 mode will display a list of files that have data in the specified range of
  28 sectors.
  29 .SS Cluster
  30 The
  31 .I cluster
  32 mode will display a list of files that have data in the specified range of
  33 clusters.  When the cluster size is one sector, this will be equivalent to the
  34 .I sector
  35 mode of operation.
  36 .SH OPTIONS
  37 Below is a summary of all the options that
  38 .B ntfscluster
  39 accepts.  Nearly all options have two equivalent names.  The short name is
  40 preceded by
  41 .B \-
  42 and the long name is preceded by
  43 .BR \-\- .
  44 Any single letter options, that don't take an argument, can be combined into a
  45 single command, e.g.
  46 .B \-fv
  47 is equivalent to
  48 .BR "\-f \-v" .
  49 Long named options can be abbreviated to any unique prefix of their name.
  50 .TP
  51 \fB\-c\fR, \fB\-\-cluster\fR RANGE
  52 Any files whose data is in this range of clusters will be displayed.
  53 .TP
  54 \fB\-F\fR, \fB\-\-filename\fR NAME
  55 Show information about this file.
  56 .TP
  57 \fB\-f\fR, \fB\-\-force\fR
  58 This will override some sensible defaults, such as not working with a mounted
  59 volume.  Use this option with caution.
  60 .TP
  61 \fB\-h\fR, \fB\-\-help\fR
  62 Show a list of options with a brief description of each one.
  63 .TP
  64 \fB\-I\fR, \fB\-\-inode\fR NUM
  65 Show information about this inode.
  66 .TP
  67 \fB\-i\fR, \fB\-\-info\fR
  68 This option is not yet implemented.
  69 .TP
  70 \fB\-q\fR, \fB\-\-quiet\fR
  71 Reduce the amount of output to a minimum.  Naturally, it doesn't make sense to
  72 combine this option with \fB\-\-verbose\fR
  73 .TP
  74 \fB\-s\fR, \fB\-\-sector\fR RANGE
  75 Any files whose data is in this range of sectors will be displayed.
  76 .TP
  77 \fB\-v\fR, \fB\-\-verbose\fR
  78 Increase the amount of output that
  79 .B ntfscluster
  80 prints.
  81 .TP
  82 \fB\-V\fR, \fB\-\-version\fR
  83 Show the version number, copyright and license for
  84 .BR ntfscluster .
  85 .SH EXAMPLES
  86 Get some information about the volume /dev/hda1.
  87 .RS
  88 .sp
  89 .B ntfscluster /dev/hda1
  90 .sp
  91 .RE
  92 Look for files in the first 500 clusters of /dev/hda1.
  93 .RS
  94 .sp
  95 .B ntfscluster \-c 0\-500 /dev/hda1
  96 .sp
  97 .RE
  98 .SH BUGS
  99 The
 100 .I info
 101 mode isn't implemented yet.
 102 .B ntfscluster
 103 is quite limited, but it has no known bugs.  If you find a bug please send an
 104 email describing the problem to the development team:
 105 .br
 106 .nh
 107 ntfs\-3g\-devel@lists.sf.net
 108 .hy
 109 .SH AUTHORS
 110 .B ntfscluster
 111 was written by Richard Russon, with contributions from Anton Altaparmakov.
 112 It was ported to ntfs-3g by Erik Larsson.
 113 .SH AVAILABILITY
 114 .B ntfscluster
 115 is part of the
 116 .B ntfs-3g
 117 package and is available from:
 118 .br
 119 .nh
 120 http://www.tuxera.com/community/
 121 .hy
 122 .SH SEE ALSO
 123 .BR ntfsinfo (8),
 124 .BR ntfsprogs (8)