193 files changed, 80411 insertions, 44563 deletions
diff --git a/src/ntfs-3g.8.in b/src/ntfs-3g.8.in index 3134d21..42f2e2b 100755 --- a/src/ntfs-3g.8.in +++ b/src/ntfs-3g.8.in @@ -1,10 +1,10 @@ .\" Copyright (c) 2005-2006 Yura Pakhuchiy. .\" Copyright (c) 2005 Richard Russon. .\" Copyright (c) 2006-2009 Szabolcs Szakacsits. -.\" Copyright (c) 2009 Jean-Pierre Andre +.\" Copyright (c) 2009-2012 Jean-Pierre Andre .\" This file may be copied under the terms of the GNU Public License. .\" -.TH NTFS-3G 8 "February 2010" "ntfs-3g @VERSION@" +.TH NTFS-3G 8 "May 2012" "ntfs-3g @VERSION@" .SH NAME ntfs-3g \- Third Generation Read/Write NTFS Driver .SH SYNOPSIS @@ -36,9 +36,25 @@ a few differences mentioned below in relevant options descriptions. .PP The \fIvolume\fR to be mounted can be either a block device or an image file. +.SS Windows hibernation and fast restarting +On computers which can be dual-booted into Windows or Linux, Windows has +to be fully shut down before booting into Linux, otherwise the NTFS file +systems on internal disks may be left in an inconsistent state and changes +made by Linux may be ignored by Windows. +.P +So, Windows may not be left in hibernation when starting Linux, in order +to avoid inconsistencies. Moreover, the fast restart feature available on +recent Windows systems has to be disabled. This can be achieved by issuing +as an Administrator the Windows command which disables both +hibernation and fast restarting : +.RS +.sp +powercfg /h off +.sp +.RE .SS Access Handling and Security By default, files and directories are owned by the effective -user and group of the mounting process and everybody has +user and group of the mounting process, and everybody has full read, write, execution and directory browsing permissions. You can also assign permissions to a single user by using the .B uid @@ -55,10 +71,10 @@ options. Doing so, Windows users have full access to the files created by .B ntfs-3g. .PP -But, by defining a Windows-to-Linux user mapping in the file -\fB.NTFS-3G/UserMapping\fP, you can benefit from the full ownership and -permissions features as defined by Posix and those ownership and -permissions will be applied to Windows users and conversely. +But, by setting the \fBpermissions\fR option, you can benefit from the full +ownership and permissions features as defined by POSIX. Moreover, by defining +a Windows-to-Linux user mapping, the ownerships and permissions are even +applied to Windows users and conversely. .PP If .B ntfs-3g @@ -70,8 +86,8 @@ NTFS supports several filename namespaces: DOS, Win32 and POSIX. While the POSIX namespace for maximum portability and interoperability reasons. This means that filenames are case sensitive and all characters are allowed except '/' and '\\0'. This is perfectly legal on Windows, though -some application may get confused. If you find so then please report it -to the developer of the relevant Windows software. +some application may get confused. The option \fBwindows_names\fP may be +used to apply Windows restrictions to new file names. .SS Alternate Data Streams (ADS) NTFS stores all data in streams. Every file has exactly one unnamed data stream and can have many named data streams. The size of a file is the @@ -121,21 +137,26 @@ being mounted. .P .RS When a user mapping file is defined, the options \fBuid=\fP, \fBgid=\fP, -\fBumask=\fP, \fBfmask=\fP, \fBdmask=\fP and \fBdsilent=\fP are ignored. +\fBumask=\fP, \fBfmask=\fP, \fBdmask=\fP and \fBsilent\fP are ignored. .RE .TP -.B default_permissions -Use standard access control. This option requires either a user mapping -file to be present, or the options \fIuid=\fP and \fIgid=\fP of a user -to be defined. This option is set by default when a user mapping file -or an ownership related option is present. +.B permissions +Set standard permissions on created files and use standard access control. +This option is set by default when a user mapping file is present. +.TP +.B acl +Enable setting Posix ACLs on created files and use them for access control. +This option is only available on specific builds. It is set by default +when a user mapping file is present and the +.B permissions +mount option is not set. .TP .B inherit -When creating a new file, set its initial ownership and protections +When creating a new file, set its initial protections according to inheritance rules defined in parent directory. These rules deviate from Posix specifications, but yield a better Windows -compatibility. A valid user mapping file is required for this option -to be effective. +compatibility. The \fBcompression\fR option or a valid user mapping file +is required for this option to be effective. .TP .B ro Mount filesystem read\-only. Useful if Windows is hibernated or the @@ -144,20 +165,31 @@ NTFS journal file is unclean. .BI locale= value This option can be useful when wanting a language specific locale environment. It is however discouraged as it leads to files with untranslatable chars -to not be visible. Please see more information about this topic at -http://ntfs-3g.org/support.html#locale +to not be visible. .TP .B force -Force the mounting even if the NTFS logfile is unclean. The logfile -will be unconditionally cleared. Use this option with caution and for -your own responsibility. +This option is obsolete. It has been superseded by the \fBrecover\fR and +\fBnorecover\fR options. +.TP +.B recover +Recover and try to mount a partition which was not unmounted properly by +Windows. The Windows logfile is cleared, which may cause inconsistencies. +Currently this is the default option. +.TP +.B norecover +Do not try to mount a partition which was not unmounted properly by Windows. +.TP +.B ignore_case \fP(only with lowntfs-3g) +Ignore character case when accessing a file (\fBFOO\fR, \fBFoo\fR, \fBfoo\fR, +etc. designate the same file). All files are displayed with lower case in +directory listings. .TP .B remove_hiberfile Unlike in case of read-only mount, the read-write mount is denied if the NTFS volume is hibernated. One needs either to resume Windows and shutdown it properly, or use this option which will remove the Windows hibernation file. Please note, this means that the saved Windows -session will be completely lost. Use this option for your own +session will be completely lost. Use this option under your own responsibility. .TP .B atime, noatime, relatime @@ -183,15 +215,46 @@ this option doesn't break applications that need to know if a file has been read since the last time it was modified. This is the default behaviour. .TP +.B delay_mtime[= value] +Only update the file modification time and the file change time of a file +when it is closed or when the indicated delay since the previous update has +elapsed. The argument is a number of seconds, with a default value of 60. +This is mainly useful for big files which are kept open for a long +time and written to without changing their size, such as databases or file +system images mounted as loop. +.TP .B show_sys_files -Show the system files in directory listings. -Otherwise the default behaviour is to hide the system files. -Please note that even when this option is specified, "$MFT" -may not be visible due to a glibc bug. -Furthermore, irrespectively of show_sys_files, all -files are accessible by name, for example you can always do +Show the metafiles in directory listings. Otherwise the default behaviour is +to hide the metafiles, which are special files used to store the NTFS +structure. Please note that even when this option is specified, "$MFT" may +not be visible due to a glibc bug. Furthermore, irrespectively of +show_sys_files, all files are accessible by name, for example you can always +do "ls \-l '$UpCase'". .TP +.B hide_hid_files +Hide the hidden files and directories in directory listings, the hidden files +and directories being the ones whose NTFS attribute have the hidden flag set. +The hidden files will not be selected when using wildcards in commands, +but all files and directories remain accessible by full name, for example you +can always display the Windows trash bin directory by : +"ls \-ld '$RECYCLE.BIN'". +.TP +.B hide_dot_files +Set the hidden flag in the NTFS attribute for created files and directories +whose first character of the name is a dot. Such files and directories +normally do not appear in directory listings, and when the flag is set +they do not appear in Windows directory displays either. +When a file is renamed or linked with a new name, the hidden flag is +adjusted to the latest name. +.TP +.B windows_names +This option prevents files, directories and extended attributes to be +created with a name not allowed by windows, either because it contains +some not allowed character (which are the nine characters " * / : < > ? \\ | and +those whose code is less than 0x20) or because the last character is a space +or a dot. Existing such files can still be read (and renamed). +.TP .B allow_other This option overrides the security measure restricting file access to the user mounting the filesystem. This option is only @@ -204,23 +267,25 @@ The default is infinite. Note that the size of read requests is limited anyway to 32 pages (which is 128kbyte on i386). .TP .B silent -Do nothing on chmod and chown operations, but do not return error -when the user mapping file required by these operations is not defined. -This option is on by default. +Do nothing, without returning any error, on chmod and chown operations, +when the \fBpermissions\fR option is not set and no user mapping file +is defined. This option is on by default. .TP .B no_def_opts -By default ntfs-3g acts as if "silent" were set, and -this option cancel this default behavior. +By default ntfs-3g acts as if "silent" (ignore errors on chmod and chown), +"allow_other" (allow any user to access files) and "nonempty" +(allow mounting on non-empty directories) were set, and "no_def_opts" +cancels these default options. .TP .BI streams_interface= value -This option controls how the user can access Alternate Data Streams (ADS) -or in other words, named data streams. It can be set -to, one of \fBnone\fR, \fBwindows\fR or \fBxattr\fR. If the option is set to -\fBnone\fR, the user will have no access to the named data streams. If it's set -to \fBwindows\fR, then the user can access them just like in Windows (eg. cat -file:stream). If it's set to \fBxattr\fR, then the named data streams are -mapped to xattrs and user can manipulate them using \fB{get,set}fattr\fR -utilities. The default is \fBxattr\fR. +This option controls how the user can access Alternate Data Streams (ADS) or +in other words, named data streams. It can be set to, one of \fBnone\fR, +\fBwindows\fR or \fBxattr\fR. If the option is set to \fBnone\fR, the user +will have no access to the named data streams. If it is set to \fBwindows\fR +(not possible with lowntfs-3g), then the user can access them just like in +Windows (eg. cat file:stream). If it's set to \fBxattr\fR, then the named +data streams are mapped to xattrs and user can manipulate them using +\fB{get,set}fattr\fR utilities. The default is \fBxattr\fR. .TP .B user_xattr Same as \fBstreams_interface=\fP\fIxattr\fP. @@ -232,21 +297,39 @@ write operation so that encrypted files can be saved and restored without being decrypted. The \fBuser.ntfs.efsinfo\fP extended attribute has also to be saved and restored for the file to be decrypted. .TP +.B compression +This option enables creating new transparently compressed files in +directories marked for compression. A directory is marked for compression by +setting the bit 11 (value 0x00000800) in its Windows attribute. In such a +directory, new files are created compressed and new subdirectories are +themselves marked for compression. The option and the flag have no effect +on existing files. +.TP +.B nocompression +This option disables creating new transparently compressed files in directories +marked for compression. Existing compressed files can still be read and +updated. Currently this is the default option. +.TP +.B big_writes +This option prevents fuse from splitting write buffers into 4K chunks, +enabling big write buffers to be transferred from the application in a +single step (up to some system limit, generally 128K bytes). +.TP .B debug -Makes ntfs-3g to not detach from terminal and print a lot of debug output from -libntfs-3g and FUSE. +Makes ntfs-3g to print a lot of debug output from libntfs-3g and FUSE. .TP .B no_detach -Same as above but with less debug output. +Makes ntfs-3g to not detach from terminal and print some debug output. .SH USER MAPPING NTFS uses specific ids to record the ownership of files instead of the \fBuid\fP and \fBgid\fP used by Linux. As a consequence a mapping between the ids has to be defined for ownerships to be recorded into NTFS and recognized. .P -By default this mapping is fetched from the file \fB.NTFS-3G/UserMapping\fP +By default, this mapping is fetched from the file \fB.NTFS-3G/UserMapping\fP located in the NTFS partition. The option \fBusermapping=\fP may be used -to define another location. +to define another location. When the option permissions is set and +no mapping file is found, a default mapping is used. .P Each line in the user mapping file defines a mapping. It is organized in three fields separated by colons. The first field identifies a \fBuid\fP, @@ -255,18 +338,23 @@ corresponding NTFS id, known as a \fBSID\fP. The \fBuid\fP and the \fBgid\fP are optional and defining both of them for the same \fBSID\fP is not recommended. .P -If no interoperation with Windows is needed, a single default mapping -with no uid and gid can be used. Just copy the example below and replace -the 9 and 10-digit numbers by any number not greater than 4294967295. +If no interoperation with Windows is needed, you can use the option +\fBpermissions\fP to define a standard mapping. Alternately, you may define +your own mapping by setting a single default mapping with no uid and gid. In +both cases, files created on Linux will appear to Windows as owned by a +foreign user, and files created on Windows will appear to Linux as owned by +root. Just copy the example below and replace the 9 and 10-digit numbers by +any number not greater than 4294967295. The resulting behavior is the same as +the one with the option permission set with no ownership option and no user +mapping file available. .RS .sp .B ::S-1-5-21-3141592653-589793238-462643383-10000 .sp .RE -If interoperation with Windows is needed, the mapping has to be defined -for each user and group known in both system, and the \fBSID\fPs used -by Windows has to be collected. This will lead to a user mapping file -like : +If a strong interoperation with Windows is needed, the mapping has to be +defined for each user and group known in both system, and the \fBSID\fPs used +by Windows has to be collected. This will lead to a user mapping file like : .RS .sp .B john::S-1-5-21-3141592653-589793238-462643383-1008 @@ -276,20 +364,30 @@ like : .sp .RE .P -The utility \fBntfs-3g.usermap\fP may be used to create the user mapping file. +The utility \fBntfs-3g.usermap\fP may be used to create such a user +mapping file. .SH EXAMPLES Mount /dev/sda1 to /mnt/windows: .RS .sp .B ntfs-3g /dev/sda1 /mnt/windows -.sp .RE or .RS -.sp .B mount -t ntfs-3g /dev/sda1 /mnt/windows .sp .RE +Mount the ntfs data partition /dev/sda3 to /mnt/data with standard Linux +permissions applied : +.RS +.sp +.B ntfs-3g -o permissions /dev/sda3 /mnt/data +.RE +or +.RS +.B mount -t ntfs-3g -o permissions /dev/sda3 /mnt/data +.sp +.RE Read\-only mount /dev/sda5 to /home/user/mnt and make user with uid 1000 to be the owner of all files: .RS @@ -297,7 +395,8 @@ to be the owner of all files: .B ntfs-3g /dev/sda5 /home/user/mnt \-o ro,uid=1000 .sp .RE -/etc/fstab entry for the above: +/etc/fstab entry for the above (the sixth and last field has to be zero to +avoid a file system check at boot time) : .RS .sp .B /dev/sda5 /home/user/mnt ntfs\-3g ro,uid=1000 0 0 |