tidy evil roff usage

add/document missing options
add missing authors
standardise program usage()
standardise options look
update download and contact details
edge.strict_endians
flatcap 2005-11-21 21:25:14 +00:00
parent abf0cfba5d
commit af6f7606e4
21 changed files with 898 additions and 870 deletions

View File

@ -1,21 +1,13 @@
.\" -*- nroff -*-
.\" Copyright (c) 2001,2002 Anton Altaparmakov. All Rights Reserved.
.\" Copyright (c) 2005 Richard Russon. All Rights Reserved.
.\" Copyright (c) 2001,2002 Anton Altaparmakov.
.\" Copyright (c) 2005 Richard Russon.
.\" This file may be copied under the terms of the GNU Public License.
.\" Adapted from e2fsprogs-1.19/misc/mke2fs.8.in by Theodore Ts'o.
.\"
.TH MKNTFS 8 "June 2005" "ntfsprogs version @VERSION@"
.TH MKNTFS 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
mkntfs \- create an NTFS 1.2 (Windows NT/2000/XP) file system
.SH SYNOPSIS
.B mkntfs
[
.I options
]
.B device
[
.I number-of-sectors
]
[\fIoptions\fR] \fIdevice \fR[\fInumber\-of\-sectors\fR]
.P
.B mkntfs
[
@ -23,7 +15,7 @@ mkntfs \- create an NTFS 1.2 (Windows NT/2000/XP) file system
]
[
.B \-c
.I cluster-size
.I cluster\-size
]
[
.B \-F
@ -43,7 +35,7 @@ mkntfs \- create an NTFS 1.2 (Windows NT/2000/XP) file system
]
[
.B \-L
.I volume-label
.I volume\-label
]
[
.B \-l
@ -53,7 +45,7 @@ mkntfs \- create an NTFS 1.2 (Windows NT/2000/XP) file system
]
[
.B \-p
.I part-start-sect
.I part\-start\-sect
]
[
.B \-Q
@ -63,11 +55,11 @@ mkntfs \- create an NTFS 1.2 (Windows NT/2000/XP) file system
]
[
.B \-S
.I sectors-per-track
.I sectors\-per\-track
]
[
.B \-s
.I sector-size
.I sector\-size
]
[
.B \-T
@ -80,18 +72,18 @@ mkntfs \- create an NTFS 1.2 (Windows NT/2000/XP) file system
]
[
.B \-w
.I ntfs-version
.I ntfs\-version
]
[
.B \-z
.I mft-zone-multiplier
.I mft\-zone\-multiplier
]
[
.B \-\-debug
]
.I device
[
.I number-of-sectors
.I number\-of\-sectors
]
.SH DESCRIPTION
.B mkntfs
@ -100,148 +92,93 @@ a disk partition).
.I device
is the special file corresponding to the device (e.g
.IR /dev/hdXX ).
.I number-of-sectors
.I number\-of\-sectors
is the number of blocks on the device. If omitted,
.B mkntfs
automagically figures the file system size.
.SH OPTIONS
Below is a summary of all the options that
.B mkntfs
accepts. Nearly all options have two equivalent names. The short name is preceded by
.BR \-
accepts. Nearly all options have two equivalent names. The short name is
preceded by
.B \-
and the long name is preceded by
.BR \-\- .
Any single letter options, that don't take an argument, can be combined into a
single command, e.g.
.BR \-fv
.B \-fv
is equivalent to
.BR "\-f \-v" .
Long named options can be abbreviated to any unique prefix of their name.
.TP
.BR
.SS Basic options
.BR
.B \-f
.br
.ns
.TP
.B \-\-fast
.br
.ns
\fB\-f\fR, \fB\-\-fast\fR, \fB\-Q\fR, \fB\-\-quick\fR
Perform quick (fast) format. This will skip both zeroing of the volume and bad
sector checking.
.TP
.B \-Q
.br
.ns
.TP
.B \-\-quick
Perform quick (fast) format. This will skip both zeroing of the volume and bad sector
checking.
.TP
.BI \-L " STRING"
.br
.ns
.TP
.BI \-\-label " STRING"
\fB\-L\fR, \fB\-\-label\fR STRING
Set the volume label for the filesystem.
.TP
.B \-C
.br
.ns
.TP
.B \-\-enable-compression
\fB\-C\fR, \fB\-\-enable\-compression\fR
Enable compression on the volume.
.TP
.BI \-c " BYTES"
.br
.ns
.TP
.BI \-\-cluster-size " BYTES"
\fB\-c\fR, \fB\-\-cluster\-size\fR BYTES
Specify the size of clusters in bytes. Valid cluster size values are powers of
two, with at least 256, and at most 65536 bytes per cluster. If omitted,
.B mkntfs
determines the
.I cluster-size
determines the
.I cluster\-size
from the volume size. The value is determined as follows:
.TS
box;
lB lB lB
l l r.
Volume size Default cluster size
0 - 512MB 512 bytes
512MB - 1GB 1024 bytes
1GB - 2GB 2048 bytes
0 \- 512MB 512 bytes
512MB \- 1GB 1024 bytes
1GB \- 2GB 2048 bytes
2GB + 4096 bytes
.TE
.sp
.sp
Note that the default cluster size is set to be at least equal to the sector
size as a cluster cannot be smaller than a sector. Also, note that values
greater than 4096 have the side effect that compression is disabled on the
volume (due to limitations in the NTFS compression algorithm currently in use
by Windows).
.TP
.B \-I
.br
.ns
.TP
.B \-\-disable-indexing
\fB\-I\fR, \fB\-\-no\-indexing\fR
Disable content indexing on the volume. (This is only meaningful on
Windows 2000 and later. Windows NT 4.0 and earlier ignore this as they do
not implement content indexing at all.)
.TP
.B \-n
.br
.ns
.TP
.B \-\-no-action
\fB\-n\fR, \fB\-\-no\-action\fR
Causes
.B mkntfs
to not actually create a filesystem, but display what it would do if it were
to create a filesystem. All steps of the format are carried out except the
actual writing to the device.
.TP
.BR
.SS Advanced options
.BR
.BI \-s " BYTES"
.br
.ns
.TP
.BI \-\-sector-size " BYTES"
\fB\-s\fR, \fB\-\-sector\-size\fR BYTES
Specify the size of sectors in bytes. Valid sector size values are 256, 512,
1024, 2048 and 4096 bytes per sector. If omitted,
.B mkntfs
attempts to determine the
.I sector-size
.I sector\-size
automatically and if that fails a default of 512 bytes per sector is used.
.TP
.BI \-p " SECTOR"
.br
.ns
.TP
.BI \-\-partition-start " SECTOR
Specify the partition start sector. The maximum is 4294967295 (2^32-1). If
\fB\-p\fR, \fB\-\-partition\-start\fR SECTOR
Specify the partition start sector. The maximum is 4294967295 (2^32\-1). If
omitted,
.B mkntfs
attempts to determine
.I part-start-sect
.I part\-start\-sect
automatically and if that fails a default of 0 is used. Note that
.I part-start-sect
.I part\-start\-sect
is required for Windows to be able to boot from the created volume.
.TP
.BI \-H " NUM"
.br
.ns
.TP
.BI \-\-heads " NUM"
\fB\-H\fR, \fB\-\-heads\fR NUM
Specify the number of heads. The maximum is 65535 (0xffff). If omitted,
.B mkntfs
attempts to determine the number of
@ -250,27 +187,17 @@ automatically and if that fails a default of 0 is used. Note that
.I heads
is required for Windows to be able to boot from the created volume.
.TP
.BI \-S " NUM"
.br
.ns
.TP
.BI \-\-sectors-per-track " NUM"
\fB\-S\fR, \fB\-\-sectors\-per\-track\fR NUM
Specify the number of sectors per track. The maximum is 65535 (0xffff). If
omitted,
.B mkntfs
attempts to determine the number of
.I sectors-per-track
.I sectors\-per\-track
automatically and if that fails a default of 0 is used. Note that
.I sectors-per-track
.I sectors\-per\-track
is required for Windows to be able to boot from the created volume.
.TP
.BI \-z " NUM"
.br
.ns
.TP
.BI \-\-mft-zone-multiplier " NUM"
\fB\-z\fR, \fB\-\-mft\-zone\-multiplier\fR NUM
Set the MFT zone multiplier, which determines the size of the MFT zone to use
on the volume. The MFT zone is the area at the beginning of the volume reserved
for the master file table (MFT), which stores the on disk inodes (MFT records).
@ -281,6 +208,7 @@ the MFT zone is resized on the fly as required during operation of the NTFS
driver but choosing a good value will reduce fragmentation. Valid values
are 1, 2, 3 and 4. The values have the following meaning:
.TS
box;
lB lB
lB lB
c l.
@ -291,102 +219,52 @@ multiplier (% of volume size)
3 37.5%
4 50.0%
.TE
.sp
.TP
.B \-T
.br
.ns
.TP
.B \-\-zero-time
\fB\-T\fR, \fB\-\-zero\-time\fR
Fake the time to be 00:00:00 UTC, Jan 1, 1970 instead of the current system
time. This is only really useful for debugging purposes.
.TP
.B \-w STRING
.br
.ns
\fB\-w\fR, \fB\-\-ntfs\-version\fR STRING
Select the version of NTFS you wish to use. This can be one of "1.2", "3.0",
or "3.1".
.TP
.B \-\-ntfs-version STRING
Select the version of NTFS you wish to use. This can be one of "1.2", "3.0", or "3.1".
.TP
.B \-F
.br
.ns
.TP
.B \-\-force
\fB\-F\fR, \fB\-\-force\fR
Force
.B mkntfs
to run, even if the specified
.I device
is not a block special device, or appears to be mounted.
.TP
.BR
.SS Output options
.BR
.B \-q
.br
.ns
.TP
.B \-\-quiet
\fB\-q\fR, \fB\-\-quiet\fR
Quiet execution; only errors are written to stderr, no output to stdout
occurs at all. Useful if
.B mkntfs
is run in a script.
.TP
.B \-v
.br
.ns
.TP
.B \-\-verbose
\fB\-v\fR, \fB\-\-verbose\fR
Verbose execution.
.TP
.B \-\-debug
\fB\-\-debug\fR
Really verbose execution; includes the verbose output from the
.B \-v
option as well as additional output useful for debugging
.B mkntfs.
.TP
.BR
.SS Help options
.BR
.B \-V
.br
.ns
.TP
.B \-\-version
\fB\-V\fR, \fB\-\-version\fR
Print the version number of
.B mkntfs
and exit.
.TP
.B \-l
.br
.ns
.TP
.B \-\-license
\fB\-l\fR, \fB\-\-license\fR
Print the licensing information of
.B mkntfs
and exit.
.TP
.B \-h
.br
.ns
.TP
.B \-\-help
Print the usage information of
.B mkntfs
and exit.
.TP
.BR
\fB\-h\fR, \fB\-\-help\fR
Show a list of options with a brief description of each one.
.SH BUGS
.B mkntfs
writes the backup boot sector to the last sector of the block
@ -396,7 +274,7 @@ up to and including todays 2.4.18) either only report an even number of sectors
when the sector size is below 1024 bytes, which is the case for most hard
drives today (512 bytes sector size) or they return the correct number but
accessing the last sector fails. Either way, this means that when a partition
has an odd number of 512-byte sectors, the last sector is either not reported
has an odd number of 512\-byte sectors, the last sector is either not reported
to us at all or it is not writable by us and hence the created NTFS volume
will either have the backup boot sector placed one sector ahead of where it
should be or it cannot be written at all. For this reason,
@ -406,20 +284,33 @@ runs automatically and creates a copy of the backup boot sector in the correct
location. This also has the benefit of catching any bugs in
.B mkntfs
as check disk would find any corrupt structures and repair them, as well as
report them. - If you do see any problems reported, please report the messages
to the author.
report them.
.sp
If you find a bug please send an email describing the problem to the
development team:
.br
There may be other bugs. Please, report them to the author.
.SH AUTHOR
This version of
.nh
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.SH AUTHORS
.B mkntfs
has been written by Anton Altaparmakov <aia21@cantab.net> (if that fails, use
<antona@users.sourceforge.net>).
was written by Anton Altaparmakov, Richard Russon and Szabolcs Szakacsits, with
contributions from Erik Sornes.
.SH AVAILABILITY
.B mkntfs
is part of the ntfsprogs package and is available for download from
http://sourceforge.net/project/showfiles.php?group_id=13956 in source (tar ball
and rpm) and pre-compiled binary (i386 rpm and deb) form.
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR badblocks (8),
.BR ntfsprogs (8)

View File

@ -222,7 +222,7 @@ static void mkntfs_usage(void)
"Basic options:\n"
" -f, --fast Perform a quick format\n"
" -Q, --quick Perform a quick format\n"
" -L, --label string Set the volume label\n"
" -L, --label STRING Set the volume label\n"
" -C, --enable-compression Enable compression on the volume\n"
" -c, --cluster-size BYTES Specify the cluster size for the volume\n"
" -I, --no-indexing Disable indexing on the volume\n"
@ -248,6 +248,7 @@ static void mkntfs_usage(void)
" -l, --license Display licensing information\n"
" -h, --help Display this help\n"
"\n", basename(EXEC_NAME));
ntfs_log_info("%s%s\n", ntfs_bugs, ntfs_home);
}
/**

View File

@ -1,19 +1,14 @@
.\" -*- nroff -*-
.\" Copyright (c) 2003 Richard Russon. All Rights Reserved.
.\" Copyright (c) 2003\-2005 Richard Russon.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH NTFSCAT 8 "October 2005" "ntfsprogs version @VERSION@"
.TH NTFSCAT 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfscat \- print NTFS files and streams on the standard output
.SH SYNOPSIS
.B ntfscat
[
.I options
]
.B device file
[\fIoptions\fR] \fIdevice \fR[\fIfile\fR]
.SH DESCRIPTION
.B ntfscat
will read a file or stream from an NTFS volume and display the contents
will read a file or stream from an NTFS volume and display the contents
on the standard output.
.PP
The case of the filename passed to
@ -22,94 +17,73 @@ is ignored.
.SH OPTIONS
Below is a summary of all the options that
.B ntfscat
accepts. All options have two equivalent names. The short name is preceded by
.BR \-
accepts. Nearly all options have two equivalent names. The short name is
preceded by
.B \-
and the long name is preceded by
.BR \-\- .
Any single letter options, that don't take an argument, can be combined into a
single command, e.g.
.BR \-fv
.B \-fv
is equivalent to
.BR "\-f \-v" .
Long named options can be abbreviated to any unique prefix of their name.
.TP
.B "\-a " type
.br
.ns
.TP
.B "\-\-attribute " type
\fB\-a\fR, \fB\-\-attribute\fR TYPE
Display the contents of a particular attribute type. By default, the unnamed
$DATA attribute will be shown. The attribute can be specified by a number
$DATA attribute will be shown. The attribute can be specified by a number
in decimal or hexadecimal, or by name.
.TS
box;
lB lB lB
l l l.
Hex Decimal Name
0x10 16 "$STANDARD_INFORMATION",
0x20 32 "$ATTRIBUTE_LIST",
0x30 48 "$FILE_NAME",
0x40 64 "$OBJECT_ID",
0x50 80 "$SECURITY_DESCRIPTOR",
0x60 96 "$VOLUME_NAME",
0x70 112 "$VOLUME_INFORMATION",
0x80 128 "$DATA",
0x90 144 "$INDEX_ROOT",
0xA0 160 "$INDEX_ALLOCATION",
0xB0 176 "$BITMAP",
0xC0 192 "$REPARSE_POINT",
0xD0 208 "$EA_INFORMATION",
0xE0 224 "$EA",
0xF0 240 "$PROPERTY_SET",
0x100 256 "$LOGGED_UTILITY_STREAM",
0x10 16 "$STANDARD_INFORMATION"
0x20 32 "$ATTRIBUTE_LIST"
0x30 48 "$FILE_NAME"
0x40 64 "$OBJECT_ID"
0x50 80 "$SECURITY_DESCRIPTOR"
0x60 96 "$VOLUME_NAME"
0x70 112 "$VOLUME_INFORMATION"
0x80 128 "$DATA"
0x90 144 "$INDEX_ROOT"
0xA0 160 "$INDEX_ALLOCATION"
0xB0 176 "$BITMAP"
0xC0 192 "$REPARSE_POINT"
0xD0 208 "$EA_INFORMATION"
0xE0 224 "$EA"
0xF0 240 "$PROPERTY_SET"
0x100 256 "$LOGGED_UTILITY_STREAM"
.TE
.br
.sp
.sp
.B Notes
.br
The attribute names may be given without the leading $ symbol.
.br
If you use the $ symbol, you must escape it from the shell.
If you use the $ symbol, you must quote the name to prevent the shell
interpreting the name.
.TP
.B "\-n " name
.br
.ns
.TP
.B "\-\-attribute-name " name
\fB\-n\fR, \fB\-\-attribute\-name\fR NAME
Display this named attribute, stream.
.TP
.B "\-i " num
.br
.ns
.TP
.B "\-\-inode " num
\fB\-i\fR, \fB\-\-inode\fR NUM
Specify a file by its inode number instead of its name.
.TP
.B \-h
.br
.ns
\fB\-f\fR, \fB\-\-force\fR
This will override some sensible defaults, such as not using a mounted volume.
Use this option with caution.
.TP
.B \-\-help
\fB\-h\fR, \fB\-\-help\fR
Show a list of options with a brief description of each one.
.TP
.B \-q
.br
.ns
.TP
.B \-\-quiet
\fB\-q\fR, \fB\-\-quiet\fR
Suppress some debug/warning/error messages.
.TP
.B \-V
.br
.ns
.TP
.B \-\-version
\fB\-V\fR, \fB\-\-version\fR
Show the version number, copyright and license
.BR ntfscat .
.TP
.B \-v
.br
.ns
.TP
.B \-\-verbose
\fB\-v\fR, \fB\-\-verbose\fR
Display more debug/warning/error messages.
.SH EXAMPLES
Display the contents of a file in the root of an NTFS volume.
@ -122,31 +96,42 @@ Display the contents of a file in a subdirectory of an NTFS volume.
.RS
.sp
.B ntfscat /dev/hda1 /winnt/system32/drivers/etc/hosts
.RE
.sp
.RE
Display the contents of the $INDEX_ROOT attribute of the root directory (inode
5).
.RS
.sp
.B ntfscat /dev/hda1 \-a INDEX_ROOT \-i 5 | hexdump \-C
.sp
.RE
.SH KNOWN ISSUES
There are no known problems. If you think you had found any then
please report it to
.nh
<linux-ntfs-dev@lists.sourceforge.net>
.hy
.SH AUTHOR
.B ntfscat
was written by Richard Russon (FlatCap)
.SH AVAILABILITY
.B ntfscat
is part of the ntfsprogs package and is available from
.SH BUGS
There are no known problems with
.BR ntfscat .
If you find a bug please send an email describing the problem to the
development team:
.br
.nh
http://linux\-ntfs.sourceforge.net/downloads.html
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.SH AUTHORS
.B ntfscat
was written by Richard Russon, Anton Altaparmakov and Szabolcs Szakacsits.
.SH AVAILABILITY
.B ntfscat
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR ntfsls (8),
.BR ntfsprogs (8)

View File

@ -76,14 +76,14 @@ static void version(void)
static void usage(void)
{
ntfs_log_info("\nUsage: %s [options] device [file]\n\n"
" -a, --attribute type Display this attribute type\n"
" -n, --attribute-name name Display this attribute name\n"
" -i, --inode num Display this inode\n\n"
" -f --force Use less caution\n"
" -h --help Print this help\n"
" -q --quiet Less output\n"
" -V --version Version information\n"
" -v --verbose More output\n\n",
" -a, --attribute TYPE Display this attribute type\n"
" -n, --attribute-name NAME Display this attribute name\n"
" -i, --inode NUM Display this inode\n\n"
" -f, --force Use less caution\n"
" -h, --help Print this help\n"
" -q, --quiet Less output\n"
" -V, --version Version information\n"
" -v, --verbose More output\n\n",
//" -r --raw Display the compressed or encrypted file",
EXEC_NAME);
ntfs_log_info("%s%s\n", ntfs_bugs, ntfs_home);

View File

@ -1,11 +1,9 @@
.\" -*- nroff -*-
.\" Copyright (c) 2003 Richard Russon
.\" Copyright (c) 2003-2005 Szabolcs Szakacsits
.\" Copyright (c) 2004 Per Olofsson
.\" All Rights Reserved.
.\" Copyright (c) 2003\-2005 Richard Russon.
.\" Copyright (c) 2003\-2005 Szabolcs Szakacsits.
.\" Copyright (c) 2004 Per Olofsson.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH NTFSCLONE 8 "Sep 2005" "ntfsprogs version @VERSION@"
.TH NTFSCLONE 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfsclone \- Efficiently clone, image, restore or rescue an NTFS
.SH SYNOPSIS
@ -13,11 +11,11 @@ ntfsclone \- Efficiently clone, image, restore or rescue an NTFS
[\fIOPTIONS\fR]
.I SOURCE
.br
.B ntfsclone \-\-save-image
.B ntfsclone \-\-save\-image
[\fIOPTIONS\fR]
.I SOURCE
.br
.B ntfsclone \-\-restore-image
.B ntfsclone \-\-restore\-image
[\fIOPTIONS\fR]
.I SOURCE
.br
@ -33,42 +31,40 @@ copies only the used data. Unused disk space becomes zero (cloning to
sparse file), encoded with control codes (saving in special image format),
left unchanged (cloning to a disk/partition) or
filled with zeros (cloning to standard output).
.B ntfsclone
can be useful to make backups, an exact snapshot of an NTFS filesystem
and restore it later on, or for developers to test NTFS read/write
functionality, troubleshoot/investigate users' issues using the clone
without the risk of destroying the original filesystem.
The clone, if not using the special image format, is an exact copy of the original
NTFS filesystem from sector to sector thus it can be also mounted
The clone, if not using the special image format, is an exact copy of the
original NTFS filesystem from sector to sector thus it can be also mounted
just like the original NTFS filesystem.
For example if you clone to a file and the kernel has loopback device and
NTFS support then the file can be mounted as
.RS
.sp
.B mount \-t ntfs \-o loop ntfsclone.img /mnt/ntfsclone
.SH SPARSE FILES
A file is sparse if it has unallocated blocks (holes). The reported size of such
files are always higher than the disk space consumed by them.
The
.BR du
.sp
.RE
.SS Sparse Files
A file is sparse if it has unallocated blocks (holes). The reported size of
such files are always higher than the disk space consumed by them. The
.B du
command can tell the real disk space used by a sparse file.
The holes are always read as zeros. All major Linux filesystem like,
ext2, ext3, reiserfs, Reiser4, JFS and XFS, supports
sparse files but for example the ISO 9600 CD-ROM filesystem doesn't.
.SH HANDLING LARGE SPARSE FILES
sparse files but for example the ISO 9600 CD\-ROM filesystem doesn't.
.SS Handling Large Sparse Files
As of today Linux provides inadequate support for managing (tar,
cp, gzip, gunzip, bzip2, bunzip2, cat, etc) large sparse files.
The only main Linux filesystem
having support for efficient sparse file handling is XFS by the
XFS_IOC_GETBMAPX
.BR ioctl\fR.
.BR ioctl .
However none of the common utilities supports it.
This means when you tar, cp, gzip, bzip2, etc a large sparse file
they will always read the entire file, even if you use the "sparse support"
options.
.BR bzip2
compresses large sparse files much better than
.BR gzip
@ -76,8 +72,7 @@ but it does so
also much slower. Moreover neither of them handles large sparse
files efficiently during uncompression from disk space usage point
of view.
At present the most efficient way, both speed and space-wise, to
At present the most efficient way, both speed and space\-wise, to
compress and uncompress large sparse files by common tools
is using
.BR tar
@ -86,16 +81,16 @@ with the options
(handle sparse files "efficiently") and
.B \-j
(filter the archive through bzip2). Although
.BR tar
.B tar
still reads and analyses the entire file, it doesn't pass on the
large data blocks having only zeros to filters and it also avoids
writing large amount of zeros to the disk needlessly. But since
.BR tar
.B tar
can't create an archive from the standard input, you can't do this
in-place by just reading
.BR ntfsclone
in\-place by just reading
.B ntfsclone
standard output.
.SH THE SPECIAL IMAGE FORMAT
.SS The Special Image Format
It's also possible, actually it's recommended, to save an NTFS filesystem
to a special image format.
Instead of representing unallocated blocks as holes, they are
@ -105,7 +100,6 @@ filesystem images over the network and similar, and can be used as a
replacement for Ghost or Partition Image if it is combined with other
tools. The downside is that you can't mount the image directly, you
need to restore it first.
To save an image using the special image format, use the
.B \-s
or the
@ -118,21 +112,19 @@ option. Note that you can restore images from standard input by
using '\-' as the
.I SOURCE
file.
.SH METADATA-ONLY CLONING
.SS Metadata\-only Cloning
One of the features of
.BR ntfsclone
.B ntfsclone
is that, it can also save only the NTFS metadata using the option
.B \-m
or
.B \-\-metadata
and the clone still will be
mountable. In this case all non-metadata file content will be lost and
mountable. In this case all non\-metadata file content will be lost and
reading them back will result always zeros.
The metadata-only image can be compressed very
well, usually to not more than 1-3 MB thus it's relatively easy to transfer
The metadata\-only image can be compressed very
well, usually to not more than 1\-3 MB thus it's relatively easy to transfer
for investigation, troubleshooting.
In this mode of ntfsclone,
.B NONE
of the user's data is saved, including the resident user's data
@ -140,47 +132,50 @@ embedded into metadata. All is filled with zeros.
Moreover all the file timestamps, deleted and unused spaces inside
the metadata are filled with zeros. Thus this mode is inappropriate
for example for forensic analyses.
Please note, filenames are not wiped out. They might contain
sensitive information, so think twice before sending such an
image to anybody.
.SH OPTIONS
Below is a summary of all the options that
.B ntfsclone
accepts. All options have two equivalent names. The short name is preceded by
.BR \-
accepts. Nearly all options have two equivalent names. The short name is
preceded by
.B \-
and the long name is preceded by
.BR \-\- .
Any single letter options, that don't take an argument, can be combined into a
single command, e.g.
.BR \-fm
.B \-fv
is equivalent to
.BR "\-f \-m" .
.BR "\-f \-v" .
Long named options can be abbreviated to any unique prefix of their name.
.TP
.BI "\-o, \-\-output " FILE
Clone NTFS to the non-existent
.I FILE\fR. If
\fB\-o\fR, \fB\-\-output\fR FILE
Clone NTFS to the non\-existent
.IR FILE .
If
.I FILE
is '-' then clone to the
is '\-' then clone to the
standard output.
.TP
.BI "\-O, \-\-overwrite " FILE
\fB\-O\fR, \fB\-\-overwrite\fR FILE
Clone NTFS to
.I FILE\fR, overwriting if exists.
.IR FILE ,
overwriting if exists.
.TP
.B \-s, \-\-save\-image
\fB\-s\fR, \fB\-\-save\-image\fR
Save to the special image format. This is the most efficient way space and
speed-wise if imaging is done to the standard output, e.g. for image
speed\-wise if imaging is done to the standard output, e.g. for image
compression, encryption or streaming through a network.
.TP
.B \-r, \-\-restore\-image
\fB\-r\fR, \fB\-\-restore\-image\fR
Restore from the special image format specified by
.I SOURCE\fR.
.I SOURCE .
If the
.I SOURCE
is '\-' then the image is read from the standard input.
.TP
.B \-\-rescue
\fB\-\-rescue\fR
Ignore disk read errors so disks having bad sectors, e.g. dying disks, can be
rescued the most efficiently way, with minimal stress on them. Ntfsclone works
at the lowest, sector level in this mode too thus more data can be rescued.
@ -191,23 +186,23 @@ beginning of such sectors are marked by "BadSectoR\\0".
Clone
.B ONLY METADATA
(for NTFS experts). Moreover only cloning to a file is allowed.
You can't metadata-only clone to a device, image or standard output.
You can't metadata\-only clone to a device, image or standard output.
.TP
.B \-\-ignore\-fs\-check
\fB\-\-ignore\-fs\-check\fR
Ignore the result of the filesystem consistency check. This option is allowed
to be used only with the
.BR --metadata
\fB\-m\fR, \fB\-\-metadata\fR
option, for the safety of user's data. The clusters which cause the
inconsistency are saved too.
.TP
.B \-f, \-\-force
\fB\-f\fR, \fB\-\-force\fR
Forces ntfsclone to proceed if the filesystem is marked
"dirty" for consistency check.
.TP
.B \-h, \-\-help
\fB\-h\fR, \fB\-\-help\fR
Show a list of options with a brief description of each one.
.SH EXIT CODES
The exit code is 0 on success, non-zero otherwise.
The exit code is 0 on success, non\-zero otherwise.
.SH EXAMPLES
Save an NTFS to a file in the special image format
.RS
@ -218,13 +213,13 @@ Save an NTFS to a file in the special image format
Restore an NTFS from a special image file to its original partition
.RS
.sp
.B ntfsclone \-\-restore-image \-\-overwrite /dev/hda1 backup.img
.B ntfsclone \-\-restore\-image \-\-overwrite /dev/hda1 backup.img
.sp
.RE
Save an NTFS into a compressed image.
.RS
.sp
.B ntfsclone \-\-save-image \-o \- /dev/hda1 | gzip \-c > backup.img.gz
.B ntfsclone \-\-save\-image \-o \- /dev/hda1 | gzip \-c > backup.img.gz
.sp
.RE
Restore an NTFS volume from a compressed image file
@ -232,13 +227,13 @@ Restore an NTFS volume from a compressed image file
.sp
.B gunzip \-c backup.img.gz | \\\\
.br
.B ntfsclone \-\-restore-image \-\-overwrite /dev/hda1 \-
.B ntfsclone \-\-restore\-image \-\-overwrite /dev/hda1 \-
.sp
.RE
Backup an NTFS volume to a remote host, using ssh.
.RS
.sp
.B ntfsclone \-\-save-image \-\-output \- /dev/hda1 | \\\\
.B ntfsclone \-\-save\-image \-\-output \- /dev/hda1 | \\\\
.br
.B gzip \-c | ssh host 'cat > backup.img.gz'
.sp
@ -246,9 +241,9 @@ Backup an NTFS volume to a remote host, using ssh.
Restore an NTFS volume from a remote host via ssh.
.RS
.sp
.B ssh host 'cat backup.img.gz' | gunzip -c | \\\\
.B ssh host 'cat backup.img.gz' | gunzip \-c | \\\\
.br
.B ntfsclone \-\-restore-image \-\-overwrite /dev/hda1 \-
.B ntfsclone \-\-restore\-image \-\-overwrite /dev/hda1 \-
.sp
.RE
Stream an image from a web server and restore it to a partition
@ -259,10 +254,10 @@ Stream an image from a web server and restore it to a partition
.B ntfsclone \-\-restore\-image \-\-overwrite /dev/hda1 \-
.sp
.RE
Clone an NTFS volume to a non-existent file
Clone an NTFS volume to a non\-existent file
.RS
.sp
.B ntfsclone \-\-output ntfs-clone.img /dev/hda1
.B ntfsclone \-\-output ntfs\-clone.img /dev/hda1
.sp
.RE
Pack NTFS metadata for NTFS experts
@ -271,30 +266,43 @@ Pack NTFS metadata for NTFS experts
.B ntfsclone \-\-metadata \-\-output ntfsmeta.img /dev/hda1
.br
.B tar \-cjSf ntfsmeta.img.tar.bz2 ntfsmeta.img
.SH KNOWN ISSUES
This program has no known bugs. If you think you have found one then
please send an email to
.sp
.RE
.SH BUGS
There are no known problems with
.BR ntfsclone .
If you find a bug please send an email describing the problem to the
development team:
.br
.nh
<linux-ntfs-dev@lists.sourceforge.net>.
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.sp
Sometimes it might appear ntfsclone froze if the clone is on ReiserFS
and even CTRL-C won't stop it. This is not a bug in ntfsclone, however
and even CTRL\-C won't stop it. This is not a bug in ntfsclone, however
it's due to ReiserFS being extremely inefficient creating large
sparse files and not handling signals during this operation. This
ReiserFS problem was improved in kernel 2.4.22.
XFS, JFS and ext3 don't have this problem.
.hy
.SH AUTHOR
.SH AUTHORS
.B ntfsclone
was written by Szabolcs Szakacsits <szaka@sienet.hu>.
Special image format support was added by Per Olofsson <pelle@dsv.su.se>.
was written by Szabolcs Szakacsits and Anton Altaparmakov, with contributions
from Per Olofsson.
.SH AVAILABILITY
.B ntfsclone
is part of the ntfsprogs package and is available from
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://linux\-ntfs.sourceforge.net/downloads.html
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR ntfsresize (8)
@ -302,4 +310,3 @@ http://linux\-ntfs.sourceforge.net/downloads.html
.BR xfs_copy (8)
.BR debugreiserfs (8)
.BR e2image (8)

View File

@ -1,15 +1,12 @@
.\" Copyright (c) 2003 Richard Russon. All Rights Reserved.
.\" Copyright (c) 2003\-2005 Richard Russon.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH NTFSCLUSTER 8 "September 2003" "ntfsprogs version @VERSION@"
.TH NTFSCLUSTER 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfscluster \- identify files in a specified region of an NTFS volume.
.SH SYNOPSIS
.B ntfscluster
[
.I options
]
.B device
[\fIoptions\fR] \fIdevice\fR
.SH DESCRIPTION
.B ntfscluster
has three modes of operation:
@ -21,8 +18,8 @@ and
.PP
The default mode,
.I info
is currently not implemented. It will display general information about the NTFS
volume when it is working.
is currently not implemented. It will display general information about the
NTFS volume when it is working.
.SS Sector
.PP
The
@ -39,72 +36,51 @@ mode of operation.
.SH OPTIONS
Below is a summary of all the options that
.B ntfscluster
accepts. All options have two equivalent names. The short name is preceded by
.BR \-
accepts. Nearly all options have two equivalent names. The short name is
preceded by
.B \-
and the long name is preceded by
.BR \-\- .
Any single letter options, that don't take an argument, can be combined into a
single command, e.g.
.BR \-fv
.B \-fv
is equivalent to
.BR "\-f \-v" .
Long named options can be abbreviated to any unique prefix of their name.
.TP
.BI "\-c " range
.br
.ns
.TP
.BI "\-\-cluster " range
\fB\-c\fR, \fB\-\-cluster\fR RANGE
Any files whose data is in this range of clusters will be displayed.
.TP
.B \-f
.br
.ns
\fB\-F\fR, \fB\-\-filename\fR NAME
Show information about this file.
.TP
.B \-\-force
\fB\-f\fR, \fB\-\-force\fR
This will override some sensible defaults, such as not working with a mounted
volume. Use this option with caution.
.TP
.B \-\-help
\fB\-h\fR, \fB\-\-help\fR
Show a list of options with a brief description of each one.
.TP
.B \-i
.br
.ns
\fB\-I\fR, \fB\-\-inode\fR NUM
Show information about this inode.
.TP
.B \-\-info
\fB\-i\fR, \fB\-\-info\fR
This option is not yet implemented.
.TP
.BI \-q
.br
.ns
.TP
.BI \-\-quiet
\fB\-q\fR, \fB\-\-quiet\fR
Reduce the amount of output to a minimum. Naturally, it doesn't make sense to
combine this option with
.TP
.B \-s
.br
.ns
.TP
.B \-\-sector
\fB\-s\fR, \fB\-\-sector\fR RANGE
Any files whose data is in this range of sectors will be displayed.
.TP
.B \-v
.br
.ns
.TP
.B \-\-verbose
\fB\-v\fR, \fB\-\-verbose\fR
Increase the amount of output that
.B ntfscluster
prints.
.TP
.B \-V
.br
.ns
.TP
.B \-\-version
Show the version number, copyright and license
\fB\-V\fR, \fB\-\-version\fR
Show the version number, copyright and license for
.BR ntfscluster .
.SH EXAMPLES
Get some information about the volume /dev/hda1.
@ -116,27 +92,38 @@ Get some information about the volume /dev/hda1.
Look for files in the first 500 clusters of /dev/hda1.
.RS
.sp
.B ntfscluster -c 0-500 /dev/hda1
.B ntfscluster \-c 0\-500 /dev/hda1
.sp
.RE
.SH BUGS
The
.I info
mode isn't implemented yet. This program is quite limited, but it has no known
bugs. If you find one, please send an email to
.nh
<linux-ntfs-dev@lists.sourceforge.net>
.hy
.SH AUTHOR
mode isn't implemented yet.
.B ntfscluster
was written by Richard Russon (FlatCap)
.SH AVAILABILITY
.B ntfscluster
is part of the ntfsprogs package and is available from
is quite limited, but it has no known bugs. If you find a bug please send an
email describing the problem to the development team:
.br
.nh
http://linux\-ntfs.sourceforge.net/downloads.html
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.SH AUTHORS
.B ntfscluster
was written by Richard Russon, with contributions from Anton Altaparmakov.
.SH AVAILABILITY
.B ntfscluster
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR ntfsinfo (8),
.BR ntfsprogs (8)

View File

@ -80,19 +80,19 @@ static void version(void)
static void usage(void)
{
ntfs_log_info("\nUsage: %s [options] device\n"
" -i --info Print information about the volume (default)\n"
" -i, --info Print information about the volume (default)\n"
"\n"
" -c range --cluster range Look for objects in this range of clusters\n"
" -s range --sector range Look for objects in this range of sectors\n"
" -I num --inode num Show information about this inode\n"
" -F name --filename name Show information about this file\n"
/* " -l --last Find the last file on the volume\n" */
" -c, --cluster RANGE Look for objects in this range of clusters\n"
" -s, --sector RANGE Look for objects in this range of sectors\n"
" -I, --inode NUM Show information about this inode\n"
" -F, --filename NAME Show information about this file\n"
/* " -l, --last Find the last file on the volume\n" */
"\n"
" -f --force Use less caution\n"
" -q --quiet Less output\n"
" -v --verbose More output\n"
" -V --version Version information\n"
" -h --help Print this help\n\n",
" -f, --force Use less caution\n"
" -q, --quiet Less output\n"
" -v, --verbose More output\n"
" -V, --version Version information\n"
" -h, --help Print this help\n\n",
EXEC_NAME);
ntfs_log_info("%s%s\n", ntfs_bugs, ntfs_home);
}

View File

@ -1,12 +1,13 @@
.\" -*- nroff -*-
.\" Copyright (c) 2004-2005 Yura Pakhuchiy. All Rights Reserved.
.\" Copyright (c) 2004\-2005 Yura Pakhuchiy.
.\" Copyright (c) 2005 Richard Russon.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH NTFSCP 8 "October 2005" "ntfsprogs version @VERSION@"
.TH NTFSCP 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfscp \- overwrite file on an NTFS volume.
.SH SYNOPSIS
.BI "ntfscp [" options "] device source_file destination"
.B ntfscp
[\fIoptions\fR] \fIdevice source_file destination\fR
.SH DESCRIPTION
.B ntfscp
will overwrite file on an NTFS volume. At present
@ -19,89 +20,109 @@ is directory specified by name then
.B source_file
is copied into this directory, in case if
.B destination
is directory and specified by inode number then unnamed data attribute is created for this inode and
is directory and specified by inode number then unnamed data attribute is
created for this inode and
.B source_file
is copied into it (WARNING: it's unusual to have unnamed data streams in the directories, think twice before specifying directory by inode number).
is copied into it (WARNING: it's unusual to have unnamed data streams in the
directories, think twice before specifying directory by inode number).
.SH OPTIONS
Below is a summary of all the options that
.B ntfscp
accepts. All options have two equivalent names. The short name is preceded by
.BR \-
accepts. Nearly all options have two equivalent names. The short name is
preceded by
.B \-
and the long name is preceded by
.BR \-\- .
Any single letter options, that don't take an argument, can be combined into a
single command, e.g.
.BR \-fv
.B \-fv
is equivalent to
.BR "\-f \-v" .
Long named options can be abbreviated to any unique prefix of their name.
.TP
.BI "\-a, \-\-attribute " number
\fB\-a\fR, \fB\-\-attribute\fR NUM
Write to this attribute.
.TP
.B \-i, \-\-inode
\fB\-i\fR, \fB\-\-inode\fR
Treat
.I destination
as inode number.
.TP
.BI "\-N, \-\-attr-name " name
\fB\-N\fR, \fB\-\-attr\-name\fR NAME
Write to attribute with this name.
.TP
.B -n, --no-action
\fB\-n\fR, \fB\-\-no\-action\fR
Use this option to make a test run before doing the real copy operation.
Volume will be opened read-only and no write will be done.
Volume will be opened read\-only and no write will be done.
.TP
.B \-f, \-\-force
\fB\-f\fR, \fB\-\-force\fR
This will override some sensible defaults, such as not working with a mounted
volume. Use this option with caution.
.TP
.B \-h, \-\-help
\fB\-h\fR, \fB\-\-help\fR
Show a list of options with a brief description of each one.
.TP
.B \-q, \-\-quiet
\fB\-q\fR, \fB\-\-quiet\fR
Suppress some debug/warning/error messages.
.TP
.B \-V, \-\-version
\fB\-V\fR, \fB\-\-version\fR
Show the version number, copyright and license
.BR ntfscp .
.TP
.B \-v, \-\-verbose
\fB\-v\fR, \fB\-\-verbose\fR
Display more debug/warning/error messages.
.SH DATA STREAMS
All data on NTFS is stored in streams, which can have names. A file can have more than one data streams, but exactly one must have no name. The size of a file is the size of its unnamed data stream. Usually when you don't specify stream name you are access to unnamed data stream. If you want access to named data stream you need to add ":stream_name" to the filename. For example: by opening "some.mp3:artist" you will open stream "artist" in "some.mp3". But windows usually prevent you from accessing to named data streams, so you need to use some program like FAR or utils from cygwin to access named data streams.
All data on NTFS is stored in streams, which can have names. A file can have
more than one data streams, but exactly one must have no name. The size of a
file is the size of its unnamed data stream. Usually when you don't specify
stream name you are access to unnamed data stream. If you want access to named
data stream you need to add ":stream_name" to the filename. For example: by
opening "some.mp3:artist" you will open stream "artist" in "some.mp3". But
windows usually prevent you from accessing to named data streams, so you need
to use some program like FAR or utils from cygwin to access named data streams.
.SH EXAMPLES
Copy new_boot.ini from /home/user as boot.ini to the root of an /dev/hda1 NTFS volume:
Copy new_boot.ini from /home/user as boot.ini to the root of an /dev/hda1 NTFS
volume:
.RS
.sp
.B ntfscp /dev/hda1 /home/user/new_boot.ini boot.ini
.sp
.RE
Copy myfile to C:\\some\\path\\myfile:stream (assume that /dev/hda1 letter in windows is C):
Copy myfile to C:\\some\\path\\myfile:stream (assume that /dev/hda1 letter in
windows is C):
.RS
.sp
.B ntfscp -N stream /dev/hda1 myfile /some/path
.B ntfscp \-N stream /dev/hda1 myfile /some/path
.sp
.RE
.SH BUGS
No bugs are known at present. If you find any bugs, please send an email to
There are no known problems with
.BR ntfscp .
If you find a bug please send an email describing the problem to the
development team:
.br
.nh
<linux-ntfs-dev@lists.sourceforge.net>.
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.SH AUTHOR
.SH AUTHORS
.B ntfscp
was written by Yura Pakhuchiy.
.B ntfscp
and this manual page is based on
.B ntfscat
and its manual page by Richard Russon, so many thanks to him. Information about named data streams was partly taken from
.B ntfsdoc.
was written by Yura Pakhuchiy, with contributions from Anton Altaparmakov.
.SH DEDICATION
With love to Marina Sapego.
.SH AVAILABILITY
.B ntfscp
is part of the ntfsprogs package and is available from
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://linux\-ntfs.sourceforge.net/downloads.html.
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR ntfsprogs (8)

View File

@ -95,15 +95,15 @@ static void version(void)
static void usage(void)
{
ntfs_log_info("\nUsage: %s [options] device src_file dest_file\n\n"
" -a --attribute num Write to this attribute\n"
" -i --inode Treat dest_file as inode number\n"
" -f --force Use less caution\n"
" -h --help Print this help\n"
" -N --attr-name name Write to attribute with this name\n"
" -n --no-action Do not write to disk\n"
" -q --quiet Less output\n"
" -V --version Version information\n"
" -v --verbose More output\n\n",
" -a, --attribute NUM Write to this attribute\n"
" -i, --inode Treat dest_file as inode number\n"
" -f, --force Use less caution\n"
" -h, --help Print this help\n"
" -N, --attr-name NAME Write to attribute with this name\n"
" -n, --no-action Do not write to disk\n"
" -q, --quiet Less output\n"
" -V, --version Version information\n"
" -v, --verbose More output\n\n",
EXEC_NAME);
ntfs_log_info("%s%s\n", ntfs_bugs, ntfs_home);
}

View File

@ -1,44 +1,74 @@
.\" Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH NTFSFIX 8 "July 2005" "ntfsprogs version @VERSION@"
.\" Please adjust this date whenever revising the manpage.
.\" Copyright (c) 2004 Szabolcs Szakacsits.
.\" Copyright (c) 2005 Richard Russon.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.TH NTFSFIX 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfsfix \- fix common errors and force Windows to check NTFS
.SH SYNOPSIS
.B ntfsfix
.I device
[\fIoptions\fR] \fIdevice\fR
.SH DESCRIPTION
\fBntfsfix\fP is a utility that fixes some common NTFS problems.
\fBntfsfix\fP is \fBNOT\fP a Linux
version of chkdsk. It only repairs some fundamental NTFS inconsistencies,
resets the NTFS journal file and schedules an NTFS consistency check for
the first boot into Windows.
.B ntfsfix
is a utility that fixes some common NTFS problems.
.B ntfsfix
is
.B NOT
a Linux version of chkdsk. It only repairs some fundamental NTFS
inconsistencies, resets the NTFS journal file and schedules an NTFS consistency
check for the first boot into Windows.
.sp
You may run
.B ntfsfix
on an NTFS volume if you think it's damaged and it can't be mounted.
.SH AUTHOR
The original ntfsfix manual page was written by David Martínez Moreno
<ender@debian.org> and rewritten
by Szabolcs Szakacsits to reflect the current role of
.SH OPTIONS
Below is a summary of all the options that
.B ntfsfix
accepts. Nearly all options have two equivalent names. The short name is
preceded by
.B \-
and the long name is preceded by
.BR \-\- .
Any single letter options, that don't take an argument, can be combined into a
single command, e.g.
.B \-fv
is equivalent to
.BR "\-f \-v" .
Long named options can be abbreviated to any unique prefix of their name.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show a list of options with a brief description of each one.
.TP
\fB\-V\fR, \fB\-\-version\fR
Show the version number, copyright and license
.SH BUGS
There are no known problems with
.BR ntfsfix .
If you find a bug please send an email describing the problem to the
development team:
.br
.nh
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.SH AUTHORS
.B ntfsfix
was written by Anton Altaparmakov.
.B ntfsfix.
.SH AVAILABILITY
.B ntfsfix
is part of the ntfsprogs package and is available from
http://linux-ntfs.sourceforge.net/.
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR mkntfs (8),
.BR ntfsprogs (8)

View File

@ -1,35 +1,95 @@
.\" -*- nroff -*-
.\" Copyright (c) 2002-2004 Anton Altaparmakov. All Rights Reserved.
.\" Copyright (c) 2002\-2004 Anton Altaparmakov.
.\" Copyright (c) 2005 Richard Russon.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH NTFSINFO 8 "Feb 2004" "ntfsprogs version @VERSION@"
.TH NTFSINFO 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfsinfo \- dump a file's attributes
.SH SYNOPSIS
.B ntfsinfo
.I -i inode-number
.I -F path-filename
.I -m
.I device
[\fIoptions\fR] \fIdevice\fR
.SH DESCRIPTION
.B ntfsinfo
will dump the attributes of inode
.I inode-number
.I inode\-number
or the file
.I path-filename
.I path\-filename
and/or information about the mft (
.I -m
.I \-m
option).
Run ntfsinfo without arguments for a full list of options.
.PP
.SH AUTHOR
.SH OPTIONS
Below is a summary of all the options that
.B ntfsinfo
was written by Matthew J. Fanto (mattjf@uncompiled.com) and largely rewritten
by Yuval Fledel with a little help from Anton Altaparmakov.
accepts. Nearly all options have two equivalent names. The short name is
preceded by
.B \-
and the long name is preceded by
.BR \-\- .
Any single letter options, that don't take an argument, can be combined into a
single command, e.g.
.B \-fv
is equivalent to
.BR "\-f \-v" .
Long named options can be abbreviated to any unique prefix of their name.
.TP
\fB\-F\fR, \fB\-\-file\fR FILE
Show information about this file
.TP
\fB\-f\fR, \fB\-\-force\fR
This will override some sensible defaults, such as not overwriting an existing
file. Use this option with caution.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show a list of options with a brief description of each one.
.TP
\fB\-i\fR, \fB\-\-inode\fR NUM
Show information about this inode.
.TP
\fB\-m\fR, \fB\-\-mft\fR
Show information about the volume.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Produce less output.
.TP
\fB\-t\fR, \fB\-\-notime\fR
Do not display timestamps in the output.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Increase the amount of output that
.B ntfsinfo
prints.
.TP
\fB\-V\fR, \fB\-\-version\fR
Show the version number, copyright and license for
.BR ntfsundelete .
.SH BUGS
There are no known problems with
.BR ntfsinfo .
If you find a bug please send an email describing the problem to the
development team:
.br
.nh
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.SH AUTHORS
.B ntfsinfo
was written by Matthew J. Fanto, Anton Altaparmakov, Richard Russon, Szabolcs
Szakacsits, Yuval Fledel, Yura Pakhuchiy and Cristian Klein.
.SH AVAILABILITY
.B ntfsinfo
is part of the ntfsprogs package and is available from
http://linux-ntfs.sourceforge.net/.
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR ntfsprogs (8)

View File

@ -124,16 +124,16 @@ static void version(void)
static void usage(void)
{
printf("\nUsage: %s [options] device\n"
" -i num --inode num Display information about this inode\n"
" -F file --file file Display information about this file (absolute path)\n"
" -m --mft Dump information about the volume\n"
" -t --notime Don't report timestamps\n"
" -i, --inode NUM Display information about this inode\n"
" -F, --file FILE Display information about this file (absolute path)\n"
" -m, --mft Dump information about the volume\n"
" -t, --notime Don't report timestamps\n"
"\n"
" -f --force Use less caution\n"
" -q --quiet Less output\n"
" -v --verbose More output\n"
" -V --version Display version information\n"
" -h --help Display this help\n\n",
" -f, --force Use less caution\n"
" -q, --quiet Less output\n"
" -v, --verbose More output\n"
" -V, --version Display version information\n"
" -h, --help Display this help\n\n",
EXEC_NAME);
printf("%s%s\n", ntfs_bugs, ntfs_home);
}

View File

@ -1,36 +1,32 @@
.\" -*- nroff -*-
.\" Copyright (c) 2002-2004 Anton Altaparmakov. All Rights Reserved.
.\" Copyright (c) 2002\-2004 Anton Altaparmakov.
.\" Copyright (c) 2005 Richard Russon.
.\" This file may be copied under the terms of the GNU Public License.
.\" Adapted from e2fsprogs-1.26/misc/e2label.8.in by Theodore Ts'o.
.\"
.TH NTFSLABEL 8 "April 2002" "ntfsprogs version @VERSION@"
.TH NTFSLABEL 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfslabel \- display/change the label on an ntfs file system
.SH SYNOPSIS
.B ntfslabel
.I device
[
.I new-label
]
[\fIoptions\fR] \fIdevice \fR[\fInew\-label\fR]
.SH DESCRIPTION
.B ntfslabel
will display or change the file system label on the ntfs file system located on
.IR device .
.PP
If the optional argument
.I new-label
.I new\-label
is not present,
.B ntfslabel
will simply display the current file system label.
.PP
If the optional argument
.I new-label
.I new\-label
is present, then
.B ntfslabel
will set the file system label to be
.IR new-label .
.IR new\-label .
NTFS file system labels can be at most 128 Unicode characters long; if
.I new-label
.I new\-label
is longer than 128 Unicode characters,
.B ntfslabel
will truncate it and print a warning message.
@ -40,16 +36,70 @@ It is also possible to set the file system label using the
option of
.BR mkntfs (8)
during creation of the file system.
.PP
.SH AUTHOR
.SH OPTIONS
Below is a summary of all the options that
.B ntfslabel
was written by Matthew J. Fanto (mattjf@uncompiled.com). This man page was
written by Anton Altaparmakov (aia21@cantab.net).
accepts. Nearly all options have two equivalent names. The short name is
preceded by
.B \-
and the long name is preceded by
.BR \-\- .
Any single letter options, that don't take an argument, can be combined into a
single command, e.g.
.B \-fv
is equivalent to
.BR "\-f \-v" .
Long named options can be abbreviated to any unique prefix of their name.
.TP
\fB\-f\fR, \fB\-\-force\fR
This will override some sensible defaults, such as not working with a mounted
volume. Use this option with caution.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show a list of options with a brief description of each one.
.TP
\fB\-n\fR, \fB\-\-no\-action\fR
Don't actually write to disk.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Reduce the amount of output to a minimum.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Increase the amount of output that
.B ntfslabel
prints.
.TP
\fB\-V\fR, \fB\-\-version\fR
Show the version number, copyright and license for
.BR ntfslabel .
.SH BUGS
There are no known problems with
.BR ntfslabel .
If you find a bug please send an email describing the problem to the
development team:
.br
.nh
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.SH AUTHORS
.B ntfslabel
was written by Matthew J. Fanto, with contributions from Anton Altaparmakov and
Richard Russon.
.SH AVAILABILITY
.B ntfslabel
is part of the ntfsprogs package and is available from
http://linux-ntfs.sourceforge.net/.
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR mkntfs (8),
.BR ntfsprogs (8)

View File

@ -90,12 +90,12 @@ static void version(void)
static void usage(void)
{
ntfs_log_info("\nUsage: %s [options] device [label]\n"
" -n --no-action Do not write to disk\n"
" -f --force Use less caution\n"
" -q --quiet Less output\n"
" -v --verbose More output\n"
" -V --version Display version information\n"
" -h --help Display this help\n\n",
" -n, --no-action Do not write to disk\n"
" -f, --force Use less caution\n"
" -q, --quiet Less output\n"
" -v, --verbose More output\n"
" -V, --version Display version information\n"
" -h, --help Display this help\n\n",
EXEC_NAME);
ntfs_log_info("%s%s\n", ntfs_bugs, ntfs_home);
}

View File

@ -1,12 +1,15 @@
.\" -*- nroff -*-
.\" Copyright (c) 2003 Anton Altaparmakov. All Rights Reserved.
.\" Copyright (c) 2003 Anton Altaparmakov.
.\" Copyright (c) 2005 Richard Russon.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH NTFSLS 8 "October 2005" "ntfsprogs version @VERSION@"
.TH NTFSLS 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfsls \- list directory contents on an NTFS filesystem
.SH SYNOPSIS
.B ntfsls
[\fIoptions\fR] \fIdevice\fR
.sp
.B ntfsls
[
.B \-a
|
@ -25,8 +28,6 @@ ntfsls \- list directory contents on an NTFS filesystem
[
.B \-h
|
.B \-?
|
.B \-\-help
]
[
@ -70,7 +71,7 @@ ntfsls \- list directory contents on an NTFS filesystem
|
.B \-\-dos
]
.I DEVICE
.I device
.SH DESCRIPTION
.B ntfsls
is used to list information about the files specified by the
@ -81,66 +82,97 @@ is the special file corresponding to the device (e.g
.IR /dev/hdXX )
or an NTFS image file.
.SH OPTIONS
Below is a summary of all the options that
.B ntfsls
accepts. Nearly all options have two equivalent names. The short name is
preceded by
.B \-
and the long name is preceded by
.BR \-\- .
Any single letter options, that don't take an argument, can be combined into a
single command, e.g.
.B \-fv
is equivalent to
.BR "\-f \-v" .
Long named options can be abbreviated to any unique prefix of their name.
.TP
.B \-a, \-\-all
\fB\-a\fR, \fB\-\-all\fR
Display all files. If this option is not specified file names in the POSIX
namespace will not be displayed.
.TP
.B \-F, \-\-classify
\fB\-F\fR, \fB\-\-classify\fR
Append indicator (one of */=@|) to entries.
.TP
.B \-f, \-\-force
\fB\-f\fR, \fB\-\-force\fR
Force execution. For example necessary to run on an NTFS partition stored in
a normal file.
.TP
.B \-h, \-?, \-\-help
\fB\-h\fR, \fB\-\-help\fR
Print the usage information of
.B ntfsls
and exit.
.TP
.B \-i, \-\-inode
\fB\-i\fR, \fB\-\-inode\fR
Print inode number of each file. This is the MFT reference number in NTFS
terminology.
.TP
.B \-l, \-\-long
\fB\-l\fR, \fB\-\-long\fR
Use a long listing format.
.TP
.B \-p, \-\-path
\fB\-p\fR, \fB\-\-path\fR PATH
The directory whose contents to list or the file (including the path) about
which to display information.
.TP
.B \-q, \-\-quiet
\fB\-q\fR, \fB\-\-quiet\fR
Suppress some debug/warning/error messages.
.TP
.B \-s, \-\-system
\fB\-R\fR, \fB\-\-recursive\fR
Show the contents of all directories beneath the specified directory.
.TP
\fB\-s\fR, \fB\-\-system\fR
Unless this options is specified, all files beginning with a dollar sign
character will not be listed as these files are usually system files.
.TP
.B \-V, \-\-version
.B \-v, \-\-verbose
\fB\-v\fR, \fB\-\-verbose\fR
Display more debug/warning/error messages.
.TP
\fB\-V\fR, \fB\-\-version\fR
Print the version number of
.B ntfsls
and exit.
.TP
.B \-v, \-\-verbose
Display more debug/warning/error messages.
.TP
.B \-x, \-\-dos
\fB\-x\fR, \fB\-\-dos\fR
Display short file names, i.e. files in the DOS namespace, instead of long
file names, i.e. files in the WIN32 namespace.
.SH BUGS
We are not aware of any bugs. If you find a bug, please report it to
<linux-ntfs-dev@lists.sourceforge.net>. Thank you.
.SH AUTHOR
There are no known problems with
.BR ntfsls .
If you find a bug please send an email describing the problem to the
development team:
.br
.nh
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.SH AUTHORS
This version of
.B ntfsls
has been written by Lode Leroy <lode_leroy@hotmail.com> and enhanced by
Anton Altaparmakov <aia21@cantab.net>. This man page has been written by
Anton Altaparmakov.
was written by Lode Leroy, Anton Altaparmakov, Richard Russon, Carmelo Kintana
and Giang Nguyen.
.SH AVAILABILITY
.B ntfsls
is part of the ntfsprogs package and is available for download from
http://sourceforge.net/project/showfiles.php?group_id=13956 in source (tar ball
and rpm) and pre-compiled binary (i386 rpm and deb) form.
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR ntfsprogs (8)

View File

@ -160,19 +160,19 @@ static void usage(void)
{
printf("\nUsage: %s [options] device\n"
"\n"
" -a --all Display all files\n"
" -F --classify Display classification\n"
" -f --force Use less caution\n"
" -h -? --help Display this help\n"
" -i --inode Display inode numbers\n"
" -l --long Display long info\n"
" -p PATH --path PATH Directory whose contents to list\n"
" -q --quiet Less output\n"
" -R --recursive Recursively list subdirectories\n"
" -s --system Display system files\n"
" -V --version Display version information\n"
" -v --verbose More output\n"
" -x --dos Use short (DOS 8.3) names\n"
" -a, --all Display all files\n"
" -F, --classify Display classification\n"
" -f, --force Use less caution\n"
" -h, --help Display this help\n"
" -i, --inode Display inode numbers\n"
" -l, --long Display long info\n"
" -p, --path PATH Directory whose contents to list\n"
" -q, --quiet Less output\n"
" -R, --recursive Recursively list subdirectories\n"
" -s, --system Display system files\n"
" -V, --version Display version information\n"
" -v, --verbose More output\n"
" -x, --dos Use short (DOS 8.3) names\n"
"\n",
EXEC_NAME);

View File

@ -1,8 +1,8 @@
.\" -*- nroff -*-
.\" Copyright (c) 2005 Yura Pakhuchiy. All Rights Reserved.
.\" Copyright (c) 2005 Yura Pakhuchiy.
.\" Copyright (c) 2005 Richard Russon.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH NTFSMOUNT 8 "October 2005" "ntfsprogs version @VERSION@"
.TH NTFSMOUNT 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfsmount \- NTFS module for FUSE.
.SH SYNOPSIS
@ -18,30 +18,24 @@ You need
to compile it,
.B xattr
is recommended, but not mandatory.
.sp
.TP
.B Fully implemented ntfsmount features are:
* Read-write access to normal and sparse files.
* Read-only access to compressed files.
* Access to special Interix files (symlinks, devices, FIFOs).
* List/Read/Write/Add/Remove named data streams.
\(bu Read\-write access to normal and sparse files.
.br
\(bu Read\-only access to compressed files.
.br
\(bu Access to special Interix files (symlinks, devices, FIFOs).
.br
\(bu List/Read/Write/Add/Remove named data streams.
.TP
.B Partly implemented features:
* Create/Delete/Move files and directories.
* Hard link files.
\(bu Create/Delete/Move files and directories.
.br
\(bu Hard link files.
.SH OPTIONS
Below is a summary of all the options that
.B ntfsmount
accepts.
.TP
.B uid=, gid=, umask=
Provide default owner, group, and access mode mask.
@ -50,30 +44,27 @@ default, the files/directories are owned by user that mounted volume and
he/she has read and write permissions, as well as
browse permission for directories. No one else has any
access permissions. I.e. the mode on all files is by
default rw------- and for directories rwx------, a
default rw\-\-\-\-\-\-\- and for directories rwx\-\-\-\-\-\-, a
consequence of the default fmask=0177 and dmask=0077.
Using a umask of zero will grant all permissions to
everyone, i.e. all files and directories will have mode
rwxrwxrwx.
.TP
.B fmask=, dmask=
Instead of specifying umask which applies both to
files and directories, fmask applies only to files and
mask only to directories.
.TP
.B show_sys_files
If show_sys_files is specified, show the system files
in directory listings. Otherwise the default behaviour
is to hide the system files.
Note that even when show_sys_files is specified, "$MFT"
may will not be visible due to bugs/mis-features in glibc.
may will not be visible due to bugs/mis\-features in glibc.
Further, note that irrespective of show_sys_files, all
files are accessible by name, i.e. you can always do
"ls -l '$UpCase'" for example to specifically show the
"ls \-l '$UpCase'" for example to specifically show the
system file containing the Unicode upcase table.
.TP
.B default_permissions
By default FUSE doesn't check file access permissions, the
@ -82,14 +73,12 @@ the underlying file access mechanism (e.g. in case of network
filesystems). This option enables permission checking, restricting
access based on file mode. This is option is usually useful
together with the 'allow_other' mount option.
.TP
.B allow_other
This option overrides the security measure restricting file access
to the user mounting the filesystem. This option is by default only
allowed to root, but this restriction can be removed with a
configuration option described in the previous section.
.TP
.B kernel_cache
(NOTE: Only for FUSE 2.3.0, with FUSE >= 2.4.0 on by default)
@ -98,61 +87,65 @@ every open(). This should only be enabled on filesystems, where the
file data is never changed externally (not through the mounted FUSE
filesystem). Thus it is not suitable for network filesystems and
other "intermediate" filesystems.
NOTE: if this option is not specified (and neither 'direct_io') data
is still cached after the open(), so a read() system call will not
always initiate a read operation.
.TP
.B large_read
Issue large read requests. This can improve performance for some
filesystems, but can also degrade performance. This option is only
useful on 2.4.X kernels, as on 2.6 kernels requests size is
automatically determined for optimum performance.
.TP
.B direct_io
This option disables the use of page cache (file content cache) in
the kernel for this filesystem. This has several affects:
- Each read() or write() system call will initiate one or more
read or write operations, data will not be cached in the
kernel.
- The return value of the read() and write() system calls will
correspond to the return values of the read and write
operations. This is useful for example if the file size is not
known in advance (before reading it).
.TP
.B max_read=
With this option the maximum size of read operations can be set.
The default is infinite. Note that the size of read requests is
limited anyway to 32 pages (which is 128kbyte on i386).
.TP
.B force
Force mount even if errors occurred. Use this option only if you know what
are you doing and don't cry about data loss.
.TP
.B ro
Mount filesystem read-only.
Mount filesystem read\-only.
.TP
.B no_def_opts
By default ntfsmount acts as "default_permissions,allow_other" was passed to it,
this option cancel this behaviour.
.TP
.B succeed_chmod
Don't change any permissions and don't return error on chmod operation.
.TP
.B locale=
You can set locale with this option. It's useful if locale enviroment variables
are not set before partitions from /etc/fstab had been mounted.
.TP
.B streams_interface=
This option controls how the user can access named data streams. It can be set
to, one of
.BR none ", " windows " or " xattr .
If the option is set to
.BR "none" ,
the user will have no access to the named data streams. If it's set to
.BR "windows" ,
then the user can access them just like in Windows (eg. cat file:stream).
If it's set to
.BR "xattr" ,
then the named data streams are mapped to xattrs and user can manipulate them
using
.B {get,set}fattr
utilities.
.SH DATA STREAMS
All data on NTFS is stored in streams, which can have names.
A file can have more than one data streams, but exactly one must have no name.
@ -172,87 +165,88 @@ can use your preferred utils to access them. You can even delete them using
You can list all named data streams by getting "ntfs.streams.list" extended
attribute. NOTE: The last feature is unique for NTFS FUSE module and maybe
will be never supported by kernel driver.
.SH EXAMPLES
Mount /dev/hda1 to /mnt/ntfs-fuse using ntfsmount:
Mount /dev/hda1 to /mnt/ntfs\-fuse using ntfsmount:
.RS
.sp
.B ntfsmount /dev/hda1 /mnt/ntfs-fuse
.B ntfsmount /dev/hda1 /mnt/ntfs\-fuse
.sp
.RE
Read-only mount /dev/hda5 to /home/user/mnt and make user with uid 1000 to be
Read\-only mount /dev/hda5 to /home/user/mnt and make user with uid 1000 to be
owner of all files:
.RS
.sp
.B ntfsmount /dev/hda5 /home/user/mnt -o ro,uid=1000
.B ntfsmount /dev/hda5 /home/user/mnt \-o ro,uid=1000
.sp
.RE
/etc/fstab entry for above:
.RS
.sp
.B /dev/hda5 /home/user/mnt ntfs-fuse ro,uid=1000 0 0
.B /dev/hda5 /home/user/mnt ntfs\-fuse ro,uid=1000 0 0
.sp
.RE
Umount /mnt/ntfs-fuse:
Umount /mnt/ntfs\-fuse:
.RS
.sp
.B fusermount -u /mnt/ntfs-fuse
.B fusermount \-u /mnt/ntfs\-fuse
.sp
.RE
Cat "artist" named data stream of "some.mp3":
.RS
.sp
.B cat some.mp3:artist
.sp
.RE
Write "Sympho Black Metal" to "genre" named data stream of "some.mp3":
.RS
.sp
.B echo Sympho Black Metal > some.mp3:genre
.sp
.RE
Remove "album" named data stream from "some.mp3":
.RS
.sp
.B rm some.mp3:album
.sp
.RE
List all named data streams for "some.mp3":
.RS
.sp
.B getfattr -n ntfs.streams.list some.mp3
.B getfattr \-n ntfs.streams.list some.mp3
.sp
.RE
.SH BUGS
No bugs are known at present. If you find any bugs, please send an email to
.nh
<linux-ntfs-dev@lists.sourceforge.net>.
.hy
.SH AUTHOR
.B ntfsmount
was written by Yura Pakhuchiy. This manual page use information from Documentation/filesystems/ntfs.txt from linux kernel source, and from README from FUSE.
.SH DEDICATION
With love to Marina Sapego.
.SH THANKS
Many thanks to Miklos Szeredi for advice and answers about FUSE.
.SH AVAILABILITY
.B ntfsmount
is part of the ntfsprogs package and is available from
There are no known problems with
.BR ntfsmount .
If you find a bug please send an email describing the problem to the
development team:
.br
.nh
http://linux\-ntfs.sourceforge.net/downloads.html.
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.SH AUTHORS
.B ntfsmount
was written by Yura Pakhuchiy, with contributions from Anton Altaparmakov.
.SH DEDICATION
With love to Marina Sapego.
.SH THANKS
Many thanks to Miklos Szeredi for advice and answers about FUSE.
.SH AVAILABILITY
.B ntfsmount
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR "ntfsprogs" (8), " attr" (5), " getfattr" (1)
.BR ntfsprogs (8),
.BR attr (5),
.BR getfattr (1)

View File

@ -1587,6 +1587,7 @@ static void usage(void)
"succeed_chmod\n\tlocale\n\tstreams_interface\n"
"Also look into FUSE documentation about it options.\n\n");
ntfs_log_info("Default options are: \"%s\".\n", def_opts);
ntfs_log_info("%s%s\n", ntfs_bugs, ntfs_home);
}
#ifndef HAVE_REALPATH

View File

@ -1,16 +1,15 @@
.\" Copyright (c) 2002 Richard Russon. All Rights Reserved.
.\" Copyright (c) 2002-2003 Anton Altaparmakov. All Rights Reserved.
.\" Copyright (c) 2005 Szabolcs Szakacsits. All Rights Reserved.
.\" Copyright (c) 2002\-2005 Richard Russon.
.\" Copyright (c) 2002\-2003 Anton Altaparmakov.
.\" Copyright (c) 2005 Szabolcs Szakacsits.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH NTFSPROGS 8 "June 2005" "ntfsprogs version @VERSION@"
.TH NTFSPROGS 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfsprogs \- several tools for doing neat things with NTFS partitions
.SH OVERVIEW
.B ntfsprogs
is a suite of NTFS utilities based around a shared library. The tools are
available for free and come with full source code.
.SH TOOLS
.SS mkntfs
.PP
@ -20,7 +19,6 @@ available for free and come with full source code.
.PP
.BR ntfscat (8)
: Dump a file's contents to the standard output.
.PP
.SS ntfsclone
.PP
.BR ntfsclone (8)
@ -63,18 +61,25 @@ or directories within it.
.PP
.BR ntfsundelete (8)
: Recover deleted files from an NTFS partition.
.SH AUTHORS
.PP
The tools have been written by Anton Altaparmakov, Richard Russon, Matthew Fanto, Szabolcs Szakacsits, Lode Leroy, Yuval Fledel and Yura Pakhuchiy.
The tools were written by Anton Altaparmakov, Carmelo Kintana, Cristian Klein,
Erik Sornes, Giang Nguyen, Holger Ohmacht, Lode Leroy, Matthew J. Fanto, Per
Olofsson, Richard Russon, Szabolcs Szakacsits, Yura Pakhuchiy and Yuval Fledel.
.SH AVAILABILITY
The
.B ntfsprogs
can be downloaded from http://linux-ntfs.sourceforge.net/downloads.html
can be downloaded from:
.br
These manual pages can be viewed online at http://linux-ntfs.sourceforge.net/man/ntfsprogs.html
.nh
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
These manual pages can be viewed online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR libntfs-gnomevfs (8)
.BR libntfs\-gnomevfs (8)

View File

@ -1,13 +1,14 @@
.\" -*- nroff -*-
.\" Copyright 2002-2005 by Szabolcs Szakacsits All Rights Reserved.
.\" Copyright (c) 2002\-2005 Szabolcs Szakacsits.
.\" Copyright (c) 2005 Richard Russon.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH NTFSRESIZE 8 "Sep 2005" "ntfsprogs version @VERSION@"
.TH NTFSRESIZE 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfsresize \- resize an NTFS filesystem without data loss
.SH SYNOPSIS
.B ntfsresize
[\fIOPTIONS\fR]
.B --info
.B \-\-info
.I DEVICE
.br
.B ntfsresize
@ -19,7 +20,7 @@ The
.B ntfsresize
program safely resizes Windows XP, Windows Server 2003, Windows 2000, Windows
NT4 and Longhorn NTFS filesystems without data loss. All NTFS versions are
supported, used by 32-bit and 64-bit Windows.
supported, used by 32\-bit and 64\-bit Windows.
.B Defragmentation is NOT required prior to resizing
because the program can relocate any data if needed, without risking data
integrity.
@ -33,17 +34,19 @@ bytes.
The
.I SIZE
parameter may have one of the optional modifiers
\fBk\fR, \fBM\fR, \fBG\fR, which means the
.BR k ,
.BR M ,
.BR G ,
which means the
.I SIZE
parameter is given in kilo-, mega- or gigabytes respectively.
parameter is given in kilo\-, mega\- or gigabytes respectively.
.B Ntfsresize
conforms to the SI, ATA, IEEE standards and the disk manufacturers
by using k=10^3, M=10^6 and G=10^9.
If both
.B --info
.B \-\-info
and
.B --size
.B \-\-size
are omitted then the
NTFS filesystem will be enlarged to the underlying
.I DEVICE
@ -67,7 +70,7 @@ It's a good practice making REGULAR BACKUPS of your valuable data, especially
before using ANY partitioning tools. To do so for NTFS, you could use
.BR ntfsclone (8).
Don't forget to save the partition table as well!
.SH SHRINKAGE
.SS Shrinkage
If you wish to shrink an NTFS partition, first use
.B ntfsresize
to shrink the size of the filesystem. Then you could use
@ -77,7 +80,7 @@ partition and recreating it with the smaller size.
Do not make the partition smaller than the new size of
NTFS otherwise you won't be able to boot. If you did so notwithstanding
then just recreate the partition to be as large as NTFS.
.SH ENLARGEMENT
.SS Enlargement
To enlarge an NTFS filesystem, first you must enlarge the size of the
underlying partition. This can be done using
.BR fdisk (8)
@ -86,31 +89,32 @@ Make sure it will not overlap with an other existing partition.
Then you may use
.B ntfsresize
to enlarge the size of the filesystem.
.SH PARTITIONING
.SS Partitioning
When recreating the partition by a disk partitioning tool,
make sure you create it at the same
starting sector and with the same partition type as before.
Otherwise you won't be able to access your filesystem. Use the 'u'
fdisk command to switch to the reliable sector unit from the
default cylinder one.
Also make sure you set the bootable flag for the partition if it
existed before. Failing to do so you might not be able to boot your
computer from the disk.
.SH OPTIONS
Below is a summary of all the options that
.B ntfsresize
accepts. All options have two equivalent names. The short name is preceded by
.BR \-
accepts. Nearly all options have two equivalent names. The short name is
preceded by
.B \-
and the long name is preceded by
.BR \-\- .
Any single letter options, that don't take an argument, can be combined into a
single command, e.g.
.BR \-fi
.B \-fv
is equivalent to
.BR "\-f \-i".
.BR "\-f \-v" .
Long named options can be abbreviated to any unique prefix of their name.
.TP
.B -i, --info
\fB\-i\fR, \fB\-\-info\fR
By using this option ntfsresize will determine the theoretically smallest
shrunken filesystem size supported. Most of the time the result is the space
already used on the filesystem. Ntfsresize will refuse shrinking to a
@ -118,30 +122,31 @@ smaller size than what you got by this option and depending on several
factors it might be unable to shrink very close to this theoretical
size. Although the integrity of your data should be never in risk,
it's still strongly recommended to make a test run by using the
.B --no-action
\fB\-n\fR, \fB\-\-no\-action\fR
option before real resizing.
Practically the smallest shrunken size generally is
at around "used space" + (20-200 MB). Please also take into account
that Windows might need about 50-100 MB free space left to boot safely.
at around "used space" + (20\-200 MB). Please also take into account
that Windows might need about 50\-100 MB free space left to boot safely.
This option never causes any changes to the filesystem, the partition is
opened read-only.
opened read\-only.
.TP
.B -s, --size \fISIZE\fR[\fBk\fR|\fBM\fR|\fBG\fR]
Resize filesystem to \fIsize\fR[\fBk\fR|\fBM\fR|\fBG\fR] bytes.
The optional modifiers \fBk\fR, \fBM\fR, \fBG\fR mean the
\fB\-s\fR, \fB\-\-size\fR SIZE\fR[\fBk\fR|\fBM\fR|\fBG\fR]
Resize filesystem to \fISIZE\fR[\fBk\fR|\fBM\fR|\fBG\fR] bytes.
The optional modifiers
.BR k ,
.BR M ,
.B G
mean the
.I SIZE
parameter is given in kilo-, mega- or gigabytes respectively.
parameter is given in kilo\-, mega\- or gigabytes respectively.
Conforming to standards, k=10^3, M=10^6 and G=10^9. Use this option
with
.B --no-action
.B \-\-no\-action
first.
.TP
.B -f, --force
\fB\-f\fR, \fB\-\-force\fR
Forces ntfsresize to proceed with the resize operation even if the filesystem
is marked for consistency check.
Please note, ntfsresize always marks the filesystem
for consistency check before a real resize operation
and it leaves that way for extra
@ -150,45 +155,50 @@ use this option. If you need
to resize several times without booting into Windows between each
resizing steps then you must use this option.
.TP
.B -n, --no-action
.B \-n, \-\-no\-action
Use this option to make a test run before doing the real resize operation.
Volume will be opened read-only and
Volume will be opened read\-only and
.B ntfsresize
displays what it would do if it were to resize the filesystem.
Continue with the real resizing only if the test run passed.
.TP
.B -b, --bad-sectors
\fB\-b\fR, \fB\-\-bad\-sectors\fR
Support disks having hardware errors, bad sectors with those
.B ntfsresize
would refuse to work by default.
Prior using this option, it's strongly recommended to make a backup by
.BR ntfsclone (8)
using the --rescue option, then running 'chkdsk /f /r volume:' on Windows
using the \-\-rescue option, then running 'chkdsk /f /r volume:' on Windows
from the command line. If the disk guarantee is still valid then replace it.
It's defected. Please also note, that no software can repair these type of
hardware errors. The most what they can do is to work around the permanent
defects.
This option doesn't have any effect if the disk is flawless.
.TP
.B -P, --no-progress-bar
\fB\-P\fR, \fB\-\-no\-progress\-bar\fR
Don't show progress bars.
.TP
.B -v, --verbose
\fB\-v\fR, \fB\-\-verbose\fR
More output.
.TP
.B -h, --help
\fB\-V\fR, \fB\-\-version\fR
Print the version number of
.B ntfsresize
and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display help and exit.
.SH EXIT CODES
The exit code is 0 on success, non-zero otherwise.
.SH KNOWN ISSUES
The exit code is 0 on success, non\-zero otherwise.
.SH BUGS
No reliability problem is known. If you need
help please try the Ntfsresize FAQ first (see below) and if you
don't find your answer then send your question, comment or bug report to
<linux-ntfs-dev@lists.sourceforge.net>. No subscription is needed
but the mailing list is moderated and it can take a short time
to approve your post.
the development team:
.br
.nh
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.PP
There are a few very rarely met restrictions at present: filesystems having
unknown bad sectors, relocation
@ -219,10 +229,10 @@ ntfsresize never touches the partition table at all. By changing
the 'Disk Access Mode' to LBA in the BIOS makes booting work
again, most of the time. You can find more information about this issue
in the Troubleshooting section of the below referred Ntfsresize FAQ.
.SH AUTHOR
.B Ntfsresize
has been written by
Szabolcs Szakacsits <szaka@sienet.hu>.
.SH AUTHORS
.B ntfsresize
was written by Szabolcs Szakacsits, with contributions from Anton Altaparmakov
and Richard Russon.
.SH ACKNOWLEDGEMENT
Many thanks to Anton Altaparmakov and Richard Russon
for libntfs, the excellent documentation and comments,
@ -231,21 +241,34 @@ at the University of Granada for their continuous and highly valuable help,
furthermore to Erik Meade, Martin Fick, Sandro Hawke, Dave Croal,
Lorrin Nelson, Geert Hendrickx, Robert Bjorkman and Richard Burdick
for beta testing the relocation support, to Florian Eyben, Fritz Oppliger,
Richard Ebling, Sid-Ahmed Touati, Jan Kiszka, Benjamin Redelings, Christopher
Richard Ebling, Sid\-Ahmed Touati, Jan Kiszka, Benjamin Redelings, Christopher
Haney, Ryan Durk, Ralf Beyer for the valued
contributions and to Theodore Ts'o whose
.BR resize2fs (8)
man page originally formed the basis of this page.
.SH AVAILABILITY
.B Ntfsresize
is part of the
.BR ntfsprogs (8)
package and is available from
http://linux-ntfs.sourceforge.net/ as source and precompiled binary.
.B ntfsresize
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.sp
.B Ntfsresize
related news, example of usage, troubleshooting, statically linked binary and
FAQ (frequently asked questions) is maintained at
FAQ (frequently asked questions) are maintained at:
.br
.nh
http://mlf.linux.rulez.org/mlf/ezaz/ntfsresize.html
.hy
.SH SEE ALSO
.BR fdisk (8),
.BR cfdisk (8),
@ -255,4 +278,3 @@ http://mlf.linux.rulez.org/mlf/ezaz/ntfsresize.html
.BR ntfsclone (8),
.BR mkntfs (8),
.BR ntfsprogs (8)

View File

@ -1,15 +1,12 @@
.\" Copyright (c) 2002-2005 Richard Russon. All Rights Reserved.
.\" Copyright (c) 2002\-2005 Richard Russon.
.\" This file may be copied under the terms of the GNU Public License.
.\"
.TH NTFSUNDELETE 8 "June 2002" "ntfsprogs version @VERSION@"
.TH NTFSUNDELETE 8 "2005\-11\-21" "ntfsprogs version @VERSION@"
.SH NAME
ntfsundelete \- recover a deleted file from an NTFS volume.
.SH SYNOPSIS
.B ntfsundelete
[
.I options
]
.B device
[\fIoptions\fR] \fIdevice\fR
.SH DESCRIPTION
.B ntfsundelete
has three modes of operation:
@ -27,8 +24,8 @@ will print a list giving the inode number, name and size.
.PP
The
.I undelete
mode takes the files either matching the regular expression (option -m)
or specified by the inode-expressions and recovers as much of the data
mode takes the files either matching the regular expression (option \-m)
or specified by the inode\-expressions and recovers as much of the data
as possible. It saves the result to another location. Partly for
safety, but mostly because NTFS write support isn't finished.
.SS Copy
@ -90,39 +87,28 @@ correct last modified date, or something unexpected.
.SH OPTIONS
Below is a summary of all the options that
.B ntfsundelete
accepts. All options have two equivalent names. The short name is preceded by
.BR \-
accepts. Nearly all options have two equivalent names. The short name is
preceded by
.B \-
and the long name is preceded by
.BR \-\- .
Any single letter options, that don't take an argument, can be combined into a
single command, e.g.
.BR \-fv
.B \-fv
is equivalent to
.BR "\-f \-v" .
Long named options can be abbreviated to any unique prefix of their name.
.TP
.BI "\-b " NUM
.br
.ns
.TP
.BI "\-\-byte " NUM
\fB\-b\fR, \fB\-\-byte\fR NUM
If any clusters of the file cannot be recovered, the missing parts will be
filled with this byte. The default is zeros.
.TP
.B \-C
.br
.ns
.TP
.B \-\-case
\fB\-C\fR, \fB\-\-case\fR
When scanning an NTFS volume, any filename matching (using the
.B \-\-match
option) is case\-insensitive. This option makes the matching case\-sensitive.
.TP
.BI "\-c " RANGE
.br
.ns
.TP
.BI "\-\-copy " RANGE
\fB\-c\fR, \fB\-\-copy\fR RANGE
This wizard's option will write a block of MFT FILE records to a file. The
default file is
.I mft
@ -133,89 +119,59 @@ and
.B \-\-destination
options.
.TP
.BI "\-d " DIR
.br
.ns
.TP
.BI "\-\-destination " DIR
\fB\-d\fR, \fB\-\-destination\fR DIR
This option controls where to put the output file of the
.B \-\-undelete
and
.B \-\-copy
options.
.TP
.B \-f
.br
.ns
.TP
.B \-\-force
\fB\-f\fR, \fB\-\-force\fR
This will override some sensible defaults, such as not overwriting an existing
file. Use this option with caution.
.TP
.B \-h
.br
.ns
.TP
.B \-\-help
\fB\-h\fR, \fB\-\-help\fR
Show a list of options with a brief description of each one.
.TP
.BI "\-i " RANGE
.br
.ns
.TP
.BI "\-\-inodes " RANGE
\fB\-i\fR, \fB\-\-inodes\fR RANGE
Recover the files with these inode numbers.
.I RANGE
can be a single inode number, several numbers separated by commas "," or a
range separated by a dash "-".
range separated by a dash "\-".
.TP
.BI "\-m " PATTERN
.br
.ns
.TP
.BI "\-\-match " PATTERN
Filter the output by only looking for matching filenames. The pattern can include the
wildcards '?', match exactly one character or '*', match zero or more
characters. By default the matching is case\-insensitive. To make the search
case sensitive, use the
\fB\-m\fR, \fB\-\-match\fR PATTERN
Filter the output by only looking for matching filenames. The pattern can
include the wildcards '?', match exactly one character or '*', match zero or
more characters. By default the matching is case\-insensitive. To make the
search case sensitive, use the
.B \-\-case
option.
.TP
.BI "\-o " FILE
.br
.ns
\fB\-O\fR, \fB\-\-optimistic\fR
Recover parts of the file even if they are currently marked as in use.
.TP
.BI "\-\-output " FILE
\fB\-o\fR, \fB\-\-output\fR FILE
Use this option to set name of output file that
.B \-\-undelete
or
.B \-\-copy
will create.
.TP
.BI "\-p " NUM
.br
.ns
\fB\-P\fR, \fB\-\-parent\fR
Display the parent directory of a deleted file.
.TP
.BI "\-\-percentage " NUM
\fB\-p\fR, \fB\-\-percentage\fR NUM
Filter the output of the
.B \-\-scan
option, by only matching files with a certain amount of recoverable content.
.B Please read the caveats section for more details.
.TP
.BI \-q
.br
.ns
.TP
.BI \-\-quiet
\fB\-q\fR, \fB\-\-quiet\fR
Reduce the amount of output to a minimum. Naturally, it doesn't make sense to
combine this option with
.BR \-\-scan .
.TP
.B \-s
.br
.ns
.TP
.B \-\-scan
\fB\-s\fR, \fB\-\-scan\fR
Search through an NTFS volume and print a list of files that could be recovered.
This is the default action of
.BR ntfsundelete .
@ -232,29 +188,23 @@ The output of scan will be:
.sp
.nf
Inode Flags %age Date Size Filename
6038 FN.. 93% 2002-07-17 26629 thesis.doc
6038 FN.. 93% 2002\-07\-17 26629 thesis.doc
.fi
.TS
box;
lB lB
l l.
Flag Description
F/D File/Directory
N/R (Non-)Resident data stream
N/R (Non\-)Resident data stream
C/E Compressed/Encrypted data stream
! Missing attributes
.TE
.RS
.sp
.br
.sp
The percentage field shows how much of the file can potentially be recovered.
.sp
.br
.RE
.BI "\-S " RANGE
.br
.ns
.TP
.BI "\-\-size " RANGE
\fB\-S\fR, \fB\-\-size\fR RANGE
Filter the output of the
.B \-\-scan
option, by looking for a particular range of file sizes. The range may be
@ -262,39 +212,27 @@ specified as two numbers separated by a '\-'. The sizes may be abbreviated
using the suffixes k, m, g, t, for kilobytes, megabytes, gigabytes and terabytes
respectively.
.TP
.BI "\-t " SINCE
.br
.ns
.TP
.BI "\-\-time " SINCE
\fB\-t\fR, \fB\-\-time\fR SINCE
Filter the output of the
.B \-\-scan
option. Only match files that have been altered since this time. The time must
be given as number using a suffix of d, w, m, y for days, weeks, months or years
ago.
.TP
.BI \-T
.br
.ns
.TP
.BI \-\-truncate
\fB\-T\fR, \fB\-\-truncate\fR
If
.BR ntfsundelete
.B ntfsundelete
is confident about the size of a deleted file, then it will restore the file to
exactly that size. The default behaviour is to round up the size to the nearest
cluster (which will be a multiple of 512 bytes).
.TP
.BI "\-u "
.br
.ns
.TP
.BI "\-\-undelete "
\fB\-u\fR, \fB\-\-undelete\fR
Select
.B undelete
mode. You can specify the files to be recovered using by using
.B --match
.B \-\-match
or
.B --inodes
.B \-\-inodes
options. This option can be combined with
.BR \-\-output ,
.BR \-\-destination ,
@ -305,21 +243,13 @@ When the file is recovered it will be given its original name, unless the
.B "\-\-output"
option is used.
.TP
.B \-v
.br
.ns
.TP
.B \-\-verbose
\fB\-v\fR, \fB\-\-verbose\fR
Increase the amount of output that
.B ntfsundelete
prints.
.TP
.B \-V
.br
.ns
.TP
.B \-\-version
Show the version number, copyright and license
\fB\-V\fR, \fB\-\-version\fR
Show the version number, copyright and license for
.BR ntfsundelete .
.SH EXAMPLES
Look for deleted files on /dev/hda1.
@ -331,7 +261,7 @@ Look for deleted files on /dev/hda1.
Look for deleted documents on /dev/hda1.
.RS
.sp
.B ntfsundelete /dev/hda1 -s \-m '*.doc'
.B ntfsundelete /dev/hda1 \-s \-m '*.doc'
.sp
.RE
Look for deleted files between 5000 and 6000000 bytes, with at least 90% of the
@ -350,38 +280,50 @@ Look for deleted files altered in the last two days
Undelete inodes 2, 5 and 100 to 131 of device /dev/sda1
.RS
.sp
.B ntfsundelete /dev/sda1 -u -i 2,5,100-131
.B ntfsundelete /dev/sda1 \-u \-i 2,5,100\-131
.sp
.RE
Undelete inode number 3689, call the file 'work.doc' and put it in the user's
home directory.
.RS
.sp
.B ntfsundelete /dev/hda1 \-u -i 3689 \-o work.doc \-d ~
.B ntfsundelete /dev/hda1 \-u \-i 3689 \-o work.doc \-d ~
.sp
.RE
Save MFT Records 3689 to 3690 to a file 'debug'
.RS
.sp
.B ntfsundelete /dev/hda1 \-c 3689\-3690 \-o debug
.sp
.RE
.SH BUGS
There are some small limitations to this program, but currently no known bugs.
If you find one, please send an email to
There are some small limitations to
.BR ntfsundelete ,
but currently no known bugs. If you find a bug please send an email describing
the problem to the development team:
.br
.nh
<linux-ntfs-dev@lists.sourceforge.net>
linux\-ntfs\-dev@lists.sourceforge.net
.hy
.SH AUTHORS
.B ntfsundelete
was written by Richard Russon (FlatCap) and Holger Ohmacht.
was written by Richard Russon and Holger Ohmacht, with contributions from Anton
Altaparmakov.
.SH AVAILABILITY
.B ntfsundelete
is part of the ntfsprogs package and is available from
is part of the
.B ntfsprogs
package and is available from:
.br
.nh
http://linux\-ntfs.sourceforge.net/downloads.html
http://www.linux\-ntfs.org/content/view/19/37
.hy
.sp
The manual pages are available online at:
.br
.nh
http://wiki.linux\-ntfs.org/doku.php?id=man
.hy
.SH SEE ALSO
.BR ntfsinfo (8),
.BR ntfsprogs (8)