• Home
Name Date Size #Lines LOC

..--

include/12-May-2024-10,8143,938

libfuse-lite/12-May-2024-7,6826,443

libntfs-3g/12-May-2024-46,43431,585

m4/12-May-2024-

ntfsprogs/12-May-2024-56,13043,910

src/12-May-2024-11,4909,551

AUTHORSD12-May-2024327 2417

BUILD.gnD12-May-2024970 2724

COPYINGD12-May-202417.6 KiB341281

COPYING.LIBD12-May-202424.7 KiB

CREDITSD12-May-20241,011 6258

ChangeLogD12-May-202476 42

Makefile.amD12-May-20241.2 KiB6146

NEWSD12-May-202482 42

OAT.xmlD12-May-20246.3 KiB11286

README.OpenSourceD12-May-2024898 1211

README.mdD12-May-20245.8 KiB167113

TODO.ntfsprogsD12-May-20243.9 KiB12796

autogen.shD12-May-2024866 2318

bundle.jsonD12-May-20241.1 KiB3434

config.hD12-May-202413.1 KiB469131

configure.acD12-May-202420.2 KiB709648

README.OpenSource

1[
2    {
3        "Name"                  : "ntfs-3g",
4        "License"               : "GPL-2.0-or-later",
5        "License File"          : "COPYING",
6        "Version Number"        : "2022.10.03",
7        "Owner"                 : "Jean-Pierre Andre, Alon Bar-Lev, Martin Bene, Dominique L Bouix, Csaba Henk, Bernhard Kaindl, Erik Larsson, Alejandro Pulver, Szabolcs Szakacsits, Miklos Szeredi",
8        "Upstream URL"          : "https://github.com/tuxera/ntfs-3g",
9        "Description"           : "The NTFS-3G driver is an open source, freely available read/write NTFS driver for Linux, FreeBSD, macOS, NetBSD, OpenIndiana, QNX and Haiku. It provides safe and fast handling of the Windows XP, Windows Server 2003, Windows 2000, Windows Vista, Windows Server 2008, Windows 7, Windows 8, Windows Server 2012, Windows Server 2016, Windows 10 and Windows Server 2019 NTFS file systems."
10    }
11]
12

README.md

1
2INTRODUCTION
3============
4
5The NTFS-3G driver is an open source, freely available read/write NTFS driver
6for Linux, FreeBSD, macOS, NetBSD, OpenIndiana, QNX and Haiku. It provides
7safe and fast handling of the Windows XP, Windows Server 2003, Windows 2000,
8Windows Vista, Windows Server 2008, Windows 7, Windows 8, Windows Server 2012,
9Windows Server 2016, Windows 10 and Windows Server 2019 NTFS file systems.
10
11The purpose of the project is to develop, quality assurance and support a
12trustable, featureful and high performance solution for hardware platforms
13and operating systems whose users need to reliably interoperate with NTFS.
14Besides this practical goal, the project also aims to explore the limits
15of the hybrid, kernel/user space filesystem driver approach, performance,
16reliability and feature richness per invested effort wise.
17
18Besides the common file system features, NTFS-3G has support for file
19ownership and permissions, POSIX ACLs, junction points, extended attributes
20and creating internally compressed files (parameter files in the directory
21.NTFS-3G may be required to enable them). The new compressed file formats
22available in Windows 10 can also be read through a plugin.
23
24News, support answers, problem submission instructions, support and discussion
25forums, and other information are available on the project web site at
26
27	https://github.com/tuxera/ntfs-3g/wiki
28
29The project has been funded, supported and maintained since 2008 by Tuxera:
30
31	https://tuxera.com
32
33
34LICENSES
35========
36
37All the NTFS related components: the file system drivers, the ntfsprogs
38utilities and the shared library libntfs-3g are distributed under the terms
39of the GNU General Public License as published by the Free Software
40Foundation; either version 2 of the License, or (at your option) any later
41version. See the included file COPYING.
42
43The fuse-lite library is distributed under the terms of the GNU LGPLv2.
44See the included file COPYING.LIB.
45
46
47QUICK INSTALLATION
48==================
49
50Most distributions have an up-to-date NTFS-3G package ready for use, and
51the recommended way is to install it.
52
53If you need some specific customization, you can compile and install from
54the released source code. Make sure you have the basic development tools
55and the kernel includes the FUSE kernel module. Then unpack the source
56tarball and type:
57
58	./configure
59	make
60	make install      # or 'sudo make install' if you aren't root.
61
62Please note that NTFS-3G doesn't require the FUSE user space package any
63more.
64
65The list of options for building specific configurations is displayed by
66typing :
67
68	./configure --help
69
70Below are a few specific options to ./configure :
71	--disable-ntfsprogs : do not build the ntfsprogs tools,
72	--enable-extras : build more ntfsprogs tools,
73	--disable-plugins : disable support for plugins
74	--enable-posix-acls : enable support for Posix ACLs
75	--enable-xattr-mappings : enable system extended attributes mappings
76	--with-fuse=external : use external fuse (overriding Linux default)
77
78There are also a few make targets for building parts :
79	make libntfs : only build the libntfs-3g library
80	make libs : only build libntfs-3g (and libfuse-lite, if relevant)
81	make drivers : only build drivers and libraries, without ntfsprogs
82	make ntfsprogs : only build ntfsprogs and libntfs-3g, without drivers
83
84
85USAGE
86=====
87
88If there was no error during installation then the NTFS volume can be
89read-write mounted for everybody the following way as the root user
90(unmount the volume if it was already mounted, and replace /dev/sda1
91and /mnt/windows, if needed):
92
93	mount -t ntfs-3g /dev/sda1 /mnt/windows
94or
95	ntfs-3g /dev/sda1 /mnt/windows
96
97Please see the ntfs-3g manual page for more options and examples.
98
99You can also make NTFS to be mounted during boot by putting the below
100line at the END(!) of the /etc/fstab file:
101
102	/dev/sda1 /mnt/windows ntfs-3g defaults 0 0
103
104
105TESTING WITHOUT INSTALLING
106=========================
107
108Newer versions of ntfs-3g can be tested without installing anything and
109without disturbing an existing installation. Just configure and make as
110shown previously. This will create the scripts ntfs-3g and lowntfs-3g
111in the src directory, which you may activate for testing:
112
113	./configure
114	make
115
116then, as root:
117	src/ntfs-3g [-o mount-options] /dev/sda1 /mnt/windows
118
119And, to end the test, unmount the usual way:
120	umount /dev/sda1
121
122
123NTFS UTILITIES
124==============
125
126The ntfsprogs directory includes utilities for doing all required tasks to
127NTFS partitions. In general, just run a utility without any command line
128options to display the version number and usage syntax.
129
130The following utilities are so far implemented:
131
132ntfsfix - Attempt to fix an NTFS partition and force Windows to check NTFS.
133
134mkntfs - Format a partition with the NTFS filesystem.  See man 8 mkntfs for
135command line options.
136
137ntfslabel - Display/change the label of an NTFS partition.  See man 8 ntfslabel
138for details.
139
140ntfsundelete - Recover deleted files from an NTFS volume.  See man 8
141ntfsundelete for more details.
142
143ntfsresize - Resize NTFS volumes.  See man 8 ntfsresize for details.
144
145ntfsclone - Efficiently create/restore an image of an NTFS partition.  See
146man 8 ntfsclone for details.
147
148ntfscluster - Locate the owner of any given sector or cluster on an NTFS
149partition.  See man 8 ntfscluster for details.
150
151ntfsinfo - Show some information about an NTFS partition or one of the files
152or directories within it.  See man 8 ntfsinfo for details.
153
154ntfsrecover - Recover updates committed by Windows but interrupted before
155being synced.
156
157ntfsls - List information about files in a directory residing on an NTFS
158partition.  See man 8 ntfsls for details.
159
160ntfscat - Concatenate files and print their contents on the standard output.
161
162ntfscp - Overwrite files on an NTFS partition.
163
164ntfssecaudit - Audit the security metadata.
165
166ntfsusermap - Assistance for building a user mapping file.
167