diff --git a/ntfsprogs/mkntfs.8.in b/ntfsprogs/mkntfs.8.in index 633f9b75..faf86720 100644 --- a/ntfsprogs/mkntfs.8.in +++ b/ntfsprogs/mkntfs.8.in @@ -8,7 +8,7 @@ mkntfs \- create an NTFS 1.2 (Windows NT/2000/XP) file system .SH SYNOPSIS .B mkntfs [\fIoptions\fR] \fIdevice \fR[\fInumber\-of\-sectors\fR] -.P +.PP .B mkntfs [ .B \-C diff --git a/ntfsprogs/ntfsclone.8.in b/ntfsprogs/ntfsclone.8.in index 8c161173..6a46f51b 100644 --- a/ntfsprogs/ntfsclone.8.in +++ b/ntfsprogs/ntfsclone.8.in @@ -24,12 +24,12 @@ ntfsclone \- Efficiently clone, image, restore or rescue an NTFS .I SOURCE .SH DESCRIPTION .B ntfsclone -will efficiently clone (copy, save, backup, restore) or rescue an NTFS -filesystem to a sparse file, image, device (partition) or standard output. +will efficiently clone (copy, save, backup, restore) or rescue an NTFS +filesystem to a sparse file, image, device (partition) or standard output. It works at disk sector level and -copies only the used data. Unused disk space becomes zero (cloning to +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 +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 @@ -55,31 +55,31 @@ 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. .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. +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 +having support for efficient sparse file handling is XFS by the +XFS_IOC_GETBMAPX .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 -but it does so +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. +.B bzip2 +compresses large sparse files much better than +.B gzip +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. +files efficiently during uncompression from disk space usage point +of view. 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 -with the options -.B \-S +compress and uncompress large sparse files by common tools +is using +.B tar +with the options +.B \-S (handle sparse files "efficiently") and -.B \-j +.B \-j (filter the archive through bzip2). Although .B tar still reads and analyses the entire file, it doesn't pass on the @@ -87,12 +87,12 @@ large data blocks having only zeros to filters and it also avoids writing large amount of zeros to the disk needlessly. But since .B tar can't create an archive from the standard input, you can't do this -in\-place by just reading +in\-place by just reading .B ntfsclone standard output. .SS The Special Image Format -It's also possible, actually it's recommended, to save an NTFS filesystem -to a 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 encoded using control codes. Thus, the image saves space without requiring sparse file support. The image format is ideal for streaming @@ -109,7 +109,7 @@ option. To restore an image, use the or the .B \-\-restore\-image option. Note that you can restore images from standard input by -using '\-' as the +using '\-' as the .I SOURCE file. .SS Metadata\-only Cloning @@ -126,7 +126,7 @@ 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 +.B NONE of the user's data is saved, including the resident user's data embedded into metadata. All is filled with zeros. Moreover all the file timestamps, deleted and unused spaces inside @@ -151,21 +151,21 @@ is equivalent to Long named options can be abbreviated to any unique prefix of their name. .TP \fB\-o\fR, \fB\-\-output\fR FILE -Clone NTFS to the non\-existent +Clone NTFS to the non\-existent .IR FILE . -If -.I FILE -is '\-' then clone to the +If +.I FILE +is '\-' then clone to the standard output. .TP \fB\-O\fR, \fB\-\-overwrite\fR FILE -Clone NTFS to +Clone NTFS to .IR FILE , overwriting if exists. .TP \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 \fB\-r\fR, \fB\-\-restore\-image\fR @@ -178,31 +178,31 @@ is '\-' then the image is read from the standard input. \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. -The contents of the unreadable sectors are filled by character '?' and the +at the lowest, sector level in this mode too thus more data can be rescued. +The contents of the unreadable sectors are filled by character '?' and the beginning of such sectors are marked by "BadSectoR\\0". .TP -.B \-m, \-\-metadata -Clone +\fB\-m\fR, \fB\-\-metadata\fR +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. .TP \fB\-\-ignore\-fs\-check\fR Ignore the result of the filesystem consistency check. This option is allowed -to be used only with the -\fB\-m\fR, \fB\-\-metadata\fR -option, for the safety of user's data. The clusters which cause the +to be used only with the +.B \-\-metadata +option, for the safety of user's data. The clusters which cause the inconsistency are saved too. .TP \fB\-f\fR, \fB\-\-force\fR -Forces ntfsclone to proceed if the filesystem is marked +Forces ntfsclone to proceed if the filesystem is marked "dirty" for consistency check. .TP \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 @@ -213,7 +213,7 @@ 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. @@ -278,9 +278,9 @@ development team: linux\-ntfs\-dev@lists.sourceforge.net .hy .sp -Sometimes it might appear ntfsclone froze if the clone is on ReiserFS +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 -it's due to ReiserFS being extremely inefficient creating large +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. diff --git a/ntfsprogs/ntfscp.8.in b/ntfsprogs/ntfscp.8.in index 7ae6230a..a9af11f8 100644 --- a/ntfsprogs/ntfscp.8.in +++ b/ntfsprogs/ntfscp.8.in @@ -24,7 +24,7 @@ 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). +directories, think twice before specifying directory by inode number). .SH OPTIONS Below is a summary of all the options that .B ntfscp diff --git a/ntfsprogs/ntfsfix.8.in b/ntfsprogs/ntfsfix.8.in index d95a1fb9..0585dbf6 100644 --- a/ntfsprogs/ntfsfix.8.in +++ b/ntfsprogs/ntfsfix.8.in @@ -10,7 +10,7 @@ ntfsfix \- fix common errors and force Windows to check NTFS [\fIoptions\fR] \fIdevice\fR .SH DESCRIPTION .B ntfsfix -is a utility that fixes some common NTFS problems. +is a utility that fixes some common NTFS problems. .B ntfsfix is .B NOT @@ -18,8 +18,8 @@ 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 +You may run +.B ntfsfix on an NTFS volume if you think it's damaged and it can't be mounted. .SH OPTIONS Below is a summary of all the options that diff --git a/ntfsprogs/ntfsls.8.in b/ntfsprogs/ntfsls.8.in index 74c07e62..17ef59f9 100644 --- a/ntfsprogs/ntfsls.8.in +++ b/ntfsprogs/ntfsls.8.in @@ -79,7 +79,7 @@ is used to list information about the files specified by the option (the root directory by default). .I DEVICE is the special file corresponding to the device (e.g -.IR /dev/hdXX ) +.IR /dev/hdXX ) or an NTFS image file. .SH OPTIONS Below is a summary of all the options that @@ -108,7 +108,7 @@ Force execution. For example necessary to run on an NTFS partition stored in a normal file. .TP \fB\-h\fR, \fB\-\-help\fR -Print the usage information of +Print the usage information of .B ntfsls and exit. .TP @@ -133,7 +133,6 @@ Show the contents of all directories beneath the specified directory. 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, \-\-verbose \fB\-v\fR, \fB\-\-verbose\fR Display more debug/warning/error messages. .TP diff --git a/ntfsprogs/ntfsmount.8.in b/ntfsprogs/ntfsmount.8.in index d84d899a..37888398 100644 --- a/ntfsprogs/ntfsmount.8.in +++ b/ntfsprogs/ntfsmount.8.in @@ -6,7 +6,11 @@ .SH NAME ntfsmount \- NTFS module for FUSE. .SH SYNOPSIS -.BI "ntfsmount " device " " mount_point " [\-o " options "]" +.B ntfsmount +.I device mount_point +[ +.B \-o options +] .SH DESCRIPTION .B ntfsmount is a @@ -134,14 +138,17 @@ are not set before partitions from /etc/fstab had been mounted. .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 . +.BR none , +.B windows +or +.BR xattr . If the option is set to -.BR "none" , +.BR none , the user will have no access to the named data streams. If it's set to -.BR "windows" , +.BR windows , then the user can access them just like in Windows (eg. cat file:stream). If it's set to -.BR "xattr" , +.BR xattr , then the named data streams are mapped to xattrs and user can manipulate them using .B {get,set}fattr diff --git a/ntfsprogs/ntfsprogs.8.in b/ntfsprogs/ntfsprogs.8.in index 8fc797b6..d349fcba 100644 --- a/ntfsprogs/ntfsprogs.8.in +++ b/ntfsprogs/ntfsprogs.8.in @@ -34,7 +34,7 @@ available for free and come with full source code. .SS ntfsfix .PP .BR ntfsfix (8) -: Check and fix some common errors, clear the LogFile and make Windows +: Check and fix some common errors, clear the LogFile and make Windows perform a thorough check next time it boots. .SS ntfsinfo .PP diff --git a/ntfsprogs/ntfsresize.8.in b/ntfsprogs/ntfsresize.8.in index 196896b5..3cfc7f8b 100644 --- a/ntfsprogs/ntfsresize.8.in +++ b/ntfsprogs/ntfsresize.8.in @@ -8,7 +8,7 @@ ntfsresize \- resize an NTFS filesystem without data loss .SH SYNOPSIS .B ntfsresize [\fIOPTIONS\fR] -.B \-\-info +.B \-\-info .I DEVICE .br .B ntfsresize @@ -18,11 +18,11 @@ ntfsresize \- resize an NTFS filesystem without data loss .SH DESCRIPTION The .B ntfsresize -program safely resizes Windows XP, Windows Server 2003, Windows 2000, Windows +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. -.B Defragmentation is NOT required prior to resizing -because the program can relocate any data if needed, without risking data +.B Defragmentation is NOT required prior to resizing +because the program can relocate any data if needed, without risking data integrity. .PP Ntfsresize can be used to shrink or enlarge any NTFS filesystem located @@ -43,13 +43,13 @@ 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 +If both .B \-\-info and .B \-\-size -are omitted then the -NTFS filesystem will be enlarged to the underlying -.I DEVICE +are omitted then the +NTFS filesystem will be enlarged to the underlying +.I DEVICE size. .PP To resize a filesystem on a partition, you must resize BOTH the filesystem @@ -60,15 +60,15 @@ doesn't manipulate the size of the partitions, hence to do that you must use a disk partitioning tool as well, for example .BR fdisk (8). Alternatively you could use one of the many user friendly partitioners that -uses +uses .B ntfsresize internally, like Mandriva's DiskDrake, QTParted, SUSE/Novell's YaST Partitioner, IBM's EVMS, GParted or Debian/Ubuntu's Partman. .PP .B IMPORTANT! -It's a good practice making REGULAR BACKUPS of your valuable data, especially +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). +.BR ntfsclone (8). Don't forget to save the partition table as well! .SS Shrinkage If you wish to shrink an NTFS partition, first use @@ -77,12 +77,12 @@ to shrink the size of the filesystem. Then you could use .BR fdisk (8) to shrink the size of the partition by deleting the 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 +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. .SS Enlargement To enlarge an NTFS filesystem, first you must enlarge the size of the -underlying partition. This can be done using +underlying partition. This can be done using .BR fdisk (8) by deleting the partition and recreating it with a larger size. Make sure it will not overlap with an other existing partition. @@ -91,10 +91,10 @@ Then you may use to enlarge the size of the filesystem. .SS Partitioning When recreating the partition by a disk partitioning tool, -make sure you create it at the same +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 +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 @@ -115,17 +115,18 @@ is equivalent to Long named options can be abbreviated to any unique prefix of their name. .TP \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 -smaller size than what you got by this option and depending on several +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 +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 +.TP \fB\-n\fR, \fB\-\-no\-action\fR -option before real resizing. +option before real resizing. Practically the smallest shrunken size generally is -at around "used space" + (20\-200 MB). Please also take into account +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. @@ -146,11 +147,11 @@ first. .TP \fB\-f\fR, \fB\-\-force\fR Forces ntfsresize to proceed with the resize operation even if the filesystem -is marked for consistency check. +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 -safety. Thus if NTFS was marked by ntfsresize then it's safe to +for consistency check before a real resize operation +and it leaves that way for extra +safety. Thus if NTFS was marked by ntfsresize then it's safe to use this option. If you need to resize several times without booting into Windows between each resizing steps then you must use this option. @@ -159,19 +160,19 @@ resizing steps then you must use this option. Use this option to make a test run before doing the real resize operation. Volume will be opened read\-only and .B ntfsresize -displays what it would do if it were to resize the filesystem. +displays what it would do if it were to resize the filesystem. Continue with the real resizing only if the test run passed. .TP \fB\-b\fR, \fB\-\-bad\-sectors\fR Support disks having hardware errors, bad sectors with those .B ntfsresize -would refuse to work by default. +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 +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 @@ -189,44 +190,44 @@ and exit. \fB\-h\fR, \fB\-\-help\fR Display help and exit. .SH EXIT CODES -The exit code is 0 on success, non\-zero otherwise. +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 +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 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 +There are a few very rarely met restrictions at present: filesystems having unknown bad sectors, relocation of the first MFT extent and resizing into the middle of a $MFTMirr extent -aren't supported yet. These cases are detected and -resizing is restricted to a safe size or the closest safe +aren't supported yet. These cases are detected and +resizing is restricted to a safe size or the closest safe size is displayed. .PP .B Ntfsresize schedules an NTFS consistency check and after the first boot into Windows you must see -.B chkdsk +.B chkdsk running on a blue background. This is intentional and no need to worry about it. Windows may force a quick reboot after the consistency check. -Moreover after repartitioning your disk and depending on the +Moreover after repartitioning your disk and depending on the hardware configuration, the Windows message .B System Settings Change may also appear. Just acknowledge it and reboot again. .PP -The disk geometry handling semantic (HDIO_GETGEO ioctl) has changed -in an incompatible way in Linux 2.6 kernels and this triggered multitudinous +The disk geometry handling semantic (HDIO_GETGEO ioctl) has changed +in an incompatible way in Linux 2.6 kernels and this triggered multitudinous partition table corruptions resulting in unbootable Windows systems, even if -NTFS was consistent, if +NTFS was consistent, if .BR parted (8) -was involved in some way. This problem was often attributed to ntfsresize -but in fact it's completely independent of NTFS thus ntfsresize. Moreover +was involved in some way. This problem was often attributed to ntfsresize +but in fact it's completely independent of NTFS thus ntfsresize. Moreover ntfsresize never touches the partition table at all. By changing -the 'Disk Access Mode' to LBA in the BIOS makes booting work +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 AUTHORS @@ -235,15 +236,15 @@ 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, -to Gergely Madarasz, Dewey M. Sasser and Miguel Lastra and his colleagues -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 libntfs, the excellent documentation and comments, +to Gergely Madarasz, Dewey M. Sasser and Miguel Lastra and his colleagues +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 Haney, Ryan Durk, Ralf Beyer for the valued -contributions and to Theodore Ts'o whose +contributions and to Theodore Ts'o whose .BR resize2fs (8) man page originally formed the basis of this page. .SH AVAILABILITY @@ -263,7 +264,7 @@ http://wiki.linux\-ntfs.org/doku.php?id=man .hy .sp .B Ntfsresize -related news, example of usage, troubleshooting, statically linked binary and +related news, example of usage, troubleshooting, statically linked binary and FAQ (frequently asked questions) are maintained at: .br .nh diff --git a/ntfsprogs/ntfsundelete.8.in b/ntfsprogs/ntfsundelete.8.in index 852d4c5c..2cee5a70 100644 --- a/ntfsprogs/ntfsundelete.8.in +++ b/ntfsprogs/ntfsundelete.8.in @@ -231,7 +231,7 @@ Select .B undelete mode. You can specify the files to be recovered using by using .B \-\-match -or +or .B \-\-inodes options. This option can be combined with .BR \-\-output , @@ -240,7 +240,7 @@ and .BR \-\-byte . .sp When the file is recovered it will be given its original name, unless the -.B "\-\-output" +.B \-\-output option is used. .TP \fB\-v\fR, \fB\-\-verbose\fR