1.. SPDX-License-Identifier: GPL-2.0
2
3=====
4NTFS3
5=====
6
7
8Summary and Features
9====================
10
11NTFS3 is fully functional NTFS Read-Write driver. The driver works with
12NTFS versions up to 3.1, normal/compressed/sparse files
13and journal replaying. File system type to use on mount is 'ntfs3'.
14
15- This driver implements NTFS read/write support for normal, sparse and
16  compressed files.
17- Supports native journal replaying;
18- Supports extended attributes
19	Predefined extended attributes:
20	- 'system.ntfs_security' gets/sets security
21			descriptor (SECURITY_DESCRIPTOR_RELATIVE)
22	- 'system.ntfs_attrib' gets/sets ntfs file/dir attributes.
23		Note: applied to empty files, this allows to switch type between
24		sparse(0x200), compressed(0x800) and normal;
25- Supports NFS export of mounted NTFS volumes.
26
27Mount Options
28=============
29
30The list below describes mount options supported by NTFS3 driver in addition to
31generic ones.
32
33===============================================================================
34
35nls=name		This option informs the driver how to interpret path
36			strings and translate them to Unicode and back. If
37			this option is not set, the default codepage will be
38			used (CONFIG_NLS_DEFAULT).
39			Examples:
40				'nls=utf8'
41
42uid=
43gid=
44umask=			Controls the default permissions for files/directories created
45			after the NTFS volume is mounted.
46
47fmask=
48dmask=			Instead of specifying umask which applies both to
49			files and directories, fmask applies only to files and
50			dmask only to directories.
51
52nohidden		Files with the Windows-specific HIDDEN (FILE_ATTRIBUTE_HIDDEN)
53			attribute will not be shown under Linux.
54
55sys_immutable		Files with the Windows-specific SYSTEM
56			(FILE_ATTRIBUTE_SYSTEM) attribute will be marked as system
57			immutable files.
58
59discard			Enable support of the TRIM command for improved performance
60			on delete operations, which is recommended for use with the
61			solid-state drives (SSD).
62
63force			Forces the driver to mount partitions even if 'dirty' flag
64			(volume dirty) is set. Not recommended for use.
65
66sparse			Create new files as "sparse".
67
68showmeta		Use this parameter to show all meta-files (System Files) on
69			a mounted NTFS partition.
70			By default, all meta-files are hidden.
71
72prealloc		Preallocate space for files excessively when file size is
73			increasing on writes. Decreases fragmentation in case of
74			parallel write operations to different files.
75
76no_acs_rules		"No access rules" mount option sets access rights for
77			files/folders to 777 and owner/group to root. This mount
78			option absorbs all other permissions:
79			- permissions change for files/folders will be reported
80				as successful, but they will remain 777;
81			- owner/group change will be reported as successful, but
82				they will stay as root
83
84acl			Support POSIX ACLs (Access Control Lists). Effective if
85			supported by Kernel. Not to be confused with NTFS ACLs.
86			The option specified as acl enables support for POSIX ACLs.
87
88noatime			All files and directories will not update their last access
89			time attribute if a partition is mounted with this parameter.
90			This option can speed up file system operation.
91
92===============================================================================
93
94ToDo list
95=========
96
97- Full journaling support (currently journal replaying is supported) over JBD.
98
99
100References
101==========
102https://www.paragon-software.com/home/ntfs-linux-professional/
103	- Commercial version of the NTFS driver for Linux.
104
105almaz.alexandrovich@paragon-software.com
106	- Direct e-mail address for feedback and requests on the NTFS3 implementation.
107