0001 .. SPDX-License-Identifier: GPL-2.0
0002
0003 =====
0004 NTFS3
0005 =====
0006
0007 Summary and Features
0008 ====================
0009
0010 NTFS3 is fully functional NTFS Read-Write driver. The driver works with NTFS
0011 versions up to 3.1. File system type to use on mount is *ntfs3*.
0012
0013 - This driver implements NTFS read/write support for normal, sparse and
0014 compressed files.
0015 - Supports native journal replaying.
0016 - Supports NFS export of mounted NTFS volumes.
0017 - Supports extended attributes. Predefined extended attributes:
0018
0019 - *system.ntfs_security* gets/sets security
0020
0021 Descriptor: SECURITY_DESCRIPTOR_RELATIVE
0022
0023 - *system.ntfs_attrib* gets/sets ntfs file/dir attributes.
0024
0025 Note: Applied to empty files, this allows to switch type between
0026 sparse(0x200), compressed(0x800) and normal.
0027
0028 Mount Options
0029 =============
0030
0031 The list below describes mount options supported by NTFS3 driver in addition to
0032 generic ones. You can use every mount option with **no** option. If it is in
0033 this table marked with no it means default is without **no**.
0034
0035 .. flat-table::
0036 :widths: 1 5
0037 :fill-cells:
0038
0039 * - iocharset=name
0040 - This option informs the driver how to interpret path strings and
0041 translate them to Unicode and back. If this option is not set, the
0042 default codepage will be used (CONFIG_NLS_DEFAULT).
0043
0044 Example: iocharset=utf8
0045
0046 * - uid=
0047 - :rspan:`1`
0048 * - gid=
0049
0050 * - umask=
0051 - Controls the default permissions for files/directories created after
0052 the NTFS volume is mounted.
0053
0054 * - dmask=
0055 - :rspan:`1` Instead of specifying umask which applies both to files and
0056 directories, fmask applies only to files and dmask only to directories.
0057 * - fmask=
0058
0059 * - noacsrules
0060 - "No access rules" mount option sets access rights for files/folders to
0061 777 and owner/group to root. This mount option absorbs all other
0062 permissions.
0063
0064 - Permissions change for files/folders will be reported as successful,
0065 but they will remain 777.
0066
0067 - Owner/group change will be reported as successful, butthey will stay
0068 as root.
0069
0070 * - nohidden
0071 - Files with the Windows-specific HIDDEN (FILE_ATTRIBUTE_HIDDEN) attribute
0072 will not be shown under Linux.
0073
0074 * - sys_immutable
0075 - Files with the Windows-specific SYSTEM (FILE_ATTRIBUTE_SYSTEM) attribute
0076 will be marked as system immutable files.
0077
0078 * - discard
0079 - Enable support of the TRIM command for improved performance on delete
0080 operations, which is recommended for use with the solid-state drives
0081 (SSD).
0082
0083 * - force
0084 - Forces the driver to mount partitions even if volume is marked dirty.
0085 Not recommended for use.
0086
0087 * - sparse
0088 - Create new files as sparse.
0089
0090 * - showmeta
0091 - Use this parameter to show all meta-files (System Files) on a mounted
0092 NTFS partition. By default, all meta-files are hidden.
0093
0094 * - prealloc
0095 - Preallocate space for files excessively when file size is increasing on
0096 writes. Decreases fragmentation in case of parallel write operations to
0097 different files.
0098
0099 * - acl
0100 - Support POSIX ACLs (Access Control Lists). Effective if supported by
0101 Kernel. Not to be confused with NTFS ACLs. The option specified as acl
0102 enables support for POSIX ACLs.
0103
0104 Todo list
0105 =========
0106 - Full journaling support over JBD. Currently journal replaying is supported
0107 which is not necessarily as effectice as JBD would be.
0108
0109 References
0110 ==========
0111 - Commercial version of the NTFS driver for Linux.
0112 https://www.paragon-software.com/home/ntfs-linux-professional/
0113
0114 - Direct e-mail address for feedback and requests on the NTFS3 implementation.
0115 almaz.alexandrovich@paragon-software.com
