Debian Codegraph @

README

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