ntfsprogs/ntfscluster.8.in

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