1 .. SPDX-License-Identifier: GPL-2.0 1 .. SPDX-License-Identifier: GPL-2.0
2 2
3 ===== 3 =====
4 NTFS3 4 NTFS3
5 ===== 5 =====
6 6
7 Summary and Features 7 Summary and Features
8 ==================== 8 ====================
9 9
10 NTFS3 is fully functional NTFS Read-Write driv 10 NTFS3 is fully functional NTFS Read-Write driver. The driver works with NTFS
11 versions up to 3.1. File system type to use on 11 versions up to 3.1. File system type to use on mount is *ntfs3*.
12 12
13 - This driver implements NTFS read/write suppo 13 - This driver implements NTFS read/write support for normal, sparse and
14 compressed files. 14 compressed files.
15 - Supports native journal replaying. 15 - Supports native journal replaying.
16 - Supports NFS export of mounted NTFS volumes. 16 - Supports NFS export of mounted NTFS volumes.
17 - Supports extended attributes. Predefined ext 17 - Supports extended attributes. Predefined extended attributes:
18 18
19 - *system.ntfs_security* gets/sets sec 19 - *system.ntfs_security* gets/sets security
20 20
21 Descriptor: SECURITY_DESCRIPTO 21 Descriptor: SECURITY_DESCRIPTOR_RELATIVE
22 22
23 - *system.ntfs_attrib* gets/sets ntfs 23 - *system.ntfs_attrib* gets/sets ntfs file/dir attributes.
24 24
25 Note: Applied to empty files, this a 25 Note: Applied to empty files, this allows to switch type between
26 sparse(0x200), compressed(0x800) and 26 sparse(0x200), compressed(0x800) and normal.
27 27
28 - *system.ntfs_attrib_be* gets/sets nt <<
29 <<
30 Same value as system.ntfs_attrib but <<
31 (endianness of system.ntfs_attrib is <<
32 <<
33 Mount Options 28 Mount Options
34 ============= 29 =============
35 30
36 The list below describes mount options support 31 The list below describes mount options supported by NTFS3 driver in addition to
37 generic ones. You can use every mount option w 32 generic ones. You can use every mount option with **no** option. If it is in
38 this table marked with no it means default is 33 this table marked with no it means default is without **no**.
39 34
40 .. flat-table:: 35 .. flat-table::
41 :widths: 1 5 36 :widths: 1 5
42 :fill-cells: 37 :fill-cells:
43 38
44 * - iocharset=name 39 * - iocharset=name
45 - This option informs the driver how to i 40 - This option informs the driver how to interpret path strings and
46 translate them to Unicode and back. If 41 translate them to Unicode and back. If this option is not set, the
47 default codepage will be used (CONFIG_N 42 default codepage will be used (CONFIG_NLS_DEFAULT).
48 43
49 Example: iocharset=utf8 44 Example: iocharset=utf8
50 45
51 * - uid= 46 * - uid=
52 - :rspan:`1` 47 - :rspan:`1`
53 * - gid= 48 * - gid=
54 49
55 * - umask= 50 * - umask=
56 - Controls the default permissions for fi 51 - Controls the default permissions for files/directories created after
57 the NTFS volume is mounted. 52 the NTFS volume is mounted.
58 53
59 * - dmask= 54 * - dmask=
60 - :rspan:`1` Instead of specifying umask 55 - :rspan:`1` Instead of specifying umask which applies both to files and
61 directories, fmask applies only to file 56 directories, fmask applies only to files and dmask only to directories.
62 * - fmask= 57 * - fmask=
63 58
>> 59 * - noacsrules
>> 60 - "No access rules" mount option sets access rights for files/folders to
>> 61 777 and owner/group to root. This mount option absorbs all other
>> 62 permissions.
>> 63
>> 64 - Permissions change for files/folders will be reported as successful,
>> 65 but they will remain 777.
>> 66
>> 67 - Owner/group change will be reported as successful, butthey will stay
>> 68 as root.
>> 69
64 * - nohidden 70 * - nohidden
65 - Files with the Windows-specific HIDDEN 71 - Files with the Windows-specific HIDDEN (FILE_ATTRIBUTE_HIDDEN) attribute
66 will not be shown under Linux. 72 will not be shown under Linux.
67 73
68 * - sys_immutable 74 * - sys_immutable
69 - Files with the Windows-specific SYSTEM 75 - Files with the Windows-specific SYSTEM (FILE_ATTRIBUTE_SYSTEM) attribute
70 will be marked as system immutable file 76 will be marked as system immutable files.
71 77
72 * - hide_dot_files <<
73 - Updates the Windows-specific HIDDEN (FI <<
74 when creating and moving or renaming fi <<
75 with a dot will have the HIDDEN attribu <<
76 do not start with a dot will have it un <<
77 <<
78 * - windows_names <<
79 - Prevents the creation of files and dire <<
80 by Windows, either because it contains <<
81 are the characters " * / : < > ? \\ | a <<
82 0x20), because the name (with or withou <<
83 name (CON, AUX, NUL, PRN, LPT1-9, COM1- <<
84 is a space or a dot. Existing such file <<
85 <<
86 * - discard 78 * - discard
87 - Enable support of the TRIM command for 79 - Enable support of the TRIM command for improved performance on delete
88 operations, which is recommended for us 80 operations, which is recommended for use with the solid-state drives
89 (SSD). 81 (SSD).
90 82
91 * - force 83 * - force
92 - Forces the driver to mount partitions e 84 - Forces the driver to mount partitions even if volume is marked dirty.
93 Not recommended for use. 85 Not recommended for use.
94 86
95 * - sparse 87 * - sparse
96 - Create new files as sparse. 88 - Create new files as sparse.
97 89
98 * - showmeta 90 * - showmeta
99 - Use this parameter to show all meta-fil 91 - Use this parameter to show all meta-files (System Files) on a mounted
100 NTFS partition. By default, all meta-fi 92 NTFS partition. By default, all meta-files are hidden.
101 93
102 * - prealloc 94 * - prealloc
103 - Preallocate space for files excessively 95 - Preallocate space for files excessively when file size is increasing on
104 writes. Decreases fragmentation in case 96 writes. Decreases fragmentation in case of parallel write operations to
105 different files. 97 different files.
106 98
107 * - acl 99 * - acl
108 - Support POSIX ACLs (Access Control List 100 - Support POSIX ACLs (Access Control Lists). Effective if supported by
109 Kernel. Not to be confused with NTFS AC 101 Kernel. Not to be confused with NTFS ACLs. The option specified as acl
110 enables support for POSIX ACLs. 102 enables support for POSIX ACLs.
111 103
112 Todo list 104 Todo list
113 ========= 105 =========
114 - Full journaling support over JBD. Currently 106 - Full journaling support over JBD. Currently journal replaying is supported
115 which is not necessarily as effective as JBD !! 107 which is not necessarily as effectice as JBD would be.
116 108
117 References 109 References
118 ========== 110 ==========
119 - Commercial version of the NTFS driver for Li 111 - Commercial version of the NTFS driver for Linux.
120 https://www.paragon-software.com/home/ 112 https://www.paragon-software.com/home/ntfs-linux-professional/
121 113
122 - Direct e-mail address for feedback and reque 114 - Direct e-mail address for feedback and requests on the NTFS3 implementation.
123 almaz.alexandrovich@paragon-software.c 115 almaz.alexandrovich@paragon-software.com
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.