tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
Doc/fs/ntfs3: Fix rst format and make it cleaner
Current ntfs3 rst documentation is broken. I turn table to list table as
this is current Linux documentation quide line. Simple table also did
not quite work in our situation as we need to span rows together.
It still look quite good as text so we did not loss anything. This will
also make diffing quite bit more pleasure.
Signed-off-by: Kari Argillander <kari.argillander@gmail.com>
Signed-off-by: Konstantin Komarov <almaz.alexandrovich@paragon-software.com>
authored by
Kari Argillander
and committed by
Konstantin Komarov
a0fc05a3
28861e3b
+77
-64
+77
-64
Documentation/filesystems/ntfs3.rst
+77
-64
Documentation/filesystems/ntfs3.rst
···
4
4
NTFS3
5
5
=====
6
6
7
-
8
7
Summary and Features
9
8
====================
10
9
11
-
NTFS3 is fully functional NTFS Read-Write driver. The driver works with
12
-
NTFS versions up to 3.1, normal/compressed/sparse files
13
-
and journal replaying. File system type to use on mount is 'ntfs3'.
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 mount is *ntfs3*.
14
12
15
13
- This driver implements NTFS read/write support for normal, sparse and
16
14
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;
15
+
- Supports native journal replaying.
25
16
- Supports NFS export of mounted NTFS volumes.
17
+
- Supports extended attributes. Predefined extended attributes:
18
+
19
+
- *system.ntfs_security* gets/sets security
20
+
21
+
Descriptor: SECURITY_DESCRIPTOR_RELATIVE
22
+
23
+
- *system.ntfs_attrib* gets/sets ntfs file/dir attributes.
24
+
25
+
Note: Applied to empty files, this allows to switch type between
26
+
sparse(0x200), compressed(0x800) and normal.
26
27
27
28
Mount Options
28
29
=============
29
30
30
31
The list below describes mount options supported by NTFS3 driver in addition to
31
-
generic ones.
32
+
generic ones. You can use every mount option with **no** option. If it is in
33
+
this table marked with no it means default is without **no**.
32
34
33
-
===============================================================================
35
+
.. flat-table::
36
+
:widths: 1 5
37
+
:fill-cells:
34
38
35
-
iocharset=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
-
'iocharset=utf8'
39
+
* - iocharset=name
40
+
- This option informs the driver how to interpret path strings and
41
+
translate them to Unicode and back. If this option is not set, the
42
+
default codepage will be used (CONFIG_NLS_DEFAULT).
41
43
42
-
uid=
43
-
gid=
44
-
umask= Controls the default permissions for files/directories created
45
-
after the NTFS volume is mounted.
44
+
Example: iocharset=utf8
46
45
47
-
fmask=
48
-
dmask= Instead of specifying umask which applies both to
49
-
files and directories, fmask applies only to files and
50
-
dmask only to directories.
46
+
* - uid=
47
+
- :rspan:`1`
48
+
* - gid=
51
49
52
-
nohidden Files with the Windows-specific HIDDEN (FILE_ATTRIBUTE_HIDDEN)
53
-
attribute will not be shown under Linux.
50
+
* - umask=
51
+
- Controls the default permissions for files/directories created after
52
+
the NTFS volume is mounted.
54
53
55
-
sys_immutable Files with the Windows-specific SYSTEM
56
-
(FILE_ATTRIBUTE_SYSTEM) attribute will be marked as system
57
-
immutable files.
54
+
* - dmask=
55
+
- :rspan:`1` Instead of specifying umask which applies both to files and
56
+
directories, fmask applies only to files and dmask only to directories.
57
+
* - fmask=
58
58
59
-
discard 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).
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.
62
63
63
-
force Forces the driver to mount partitions even if 'dirty' flag
64
-
(volume dirty) is set. Not recommended for use.
64
+
- Permissions change for files/folders will be reported as successful,
65
+
but they will remain 777.
65
66
66
-
sparse Create new files as "sparse".
67
+
- Owner/group change will be reported as successful, butthey will stay
68
+
as root.
67
69
68
-
showmeta Use this parameter to show all meta-files (System Files) on
69
-
a mounted NTFS partition.
70
-
By default, all meta-files are hidden.
70
+
* - nohidden
71
+
- Files with the Windows-specific HIDDEN (FILE_ATTRIBUTE_HIDDEN) attribute
72
+
will not be shown under Linux.
71
73
72
-
prealloc 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.
74
+
* - sys_immutable
75
+
- Files with the Windows-specific SYSTEM (FILE_ATTRIBUTE_SYSTEM) attribute
76
+
will be marked as system immutable files.
75
77
76
-
noacsrules "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
78
+
* - discard
79
+
- Enable support of the TRIM command for improved performance on delete
80
+
operations, which is recommended for use with the solid-state drives
81
+
(SSD).
83
82
84
-
acl 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.
83
+
* - force
84
+
- Forces the driver to mount partitions even if volume is marked dirty.
85
+
Not recommended for use.
87
86
88
-
===============================================================================
87
+
* - sparse
88
+
- Create new files as sparse.
89
89
90
-
ToDo list
90
+
* - showmeta
91
+
- Use this parameter to show all meta-files (System Files) on a mounted
92
+
NTFS partition. By default, all meta-files are hidden.
93
+
94
+
* - prealloc
95
+
- Preallocate space for files excessively when file size is increasing on
96
+
writes. Decreases fragmentation in case of parallel write operations to
97
+
different files.
98
+
99
+
* - acl
100
+
- Support POSIX ACLs (Access Control Lists). Effective if supported by
101
+
Kernel. Not to be confused with NTFS ACLs. The option specified as acl
102
+
enables support for POSIX ACLs.
103
+
104
+
Todo list
91
105
=========
92
-
93
-
- Full journaling support (currently journal replaying is supported) over JBD.
94
-
106
+
- Full journaling support over JBD. Currently journal replaying is supported
107
+
which is not necessarily as effectice as JBD would be.
95
108
96
109
References
97
110
==========
98
-
https://www.paragon-software.com/home/ntfs-linux-professional/
99
-
- Commercial version of the NTFS driver for Linux.
111
+
- Commercial version of the NTFS driver for Linux.
112
+
https://www.paragon-software.com/home/ntfs-linux-professional/
100
113
101
-
almaz.alexandrovich@paragon-software.com
102
-
- Direct e-mail address for feedback and requests on the NTFS3 implementation.
114
+
- Direct e-mail address for feedback and requests on the NTFS3 implementation.
115
+
almaz.alexandrovich@paragon-software.com