source: postlfs/filesystems/ntfs-3g.xml@ f827289

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since f827289 was a0e08b2, checked in by David Bryant <david@…>, 17 months ago

Standardized the spelling of "userspace".

Also corrected the capitalization of titles and cleaned up some
grammatical errors. Note that a few modules quote the "config"
menu for the Linux kernel, whch says "user-space". Those
modules were not altered; directly quoted material should be
reproduced verbatim.
  • Property mode set to 100644
File size: 17.0 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY ntfs-3g-download-http
8 "https://tuxera.com/opensource/ntfs-3g_ntfsprogs-&ntfs-3g-version;.tgz">
9 <!ENTITY ntfs-3g-download-ftp " ">
10 <!ENTITY ntfs-3g-md5sum "a038af61be7584b79f8922ff11244090">
11 <!ENTITY ntfs-3g-size "1.3 MB">
12 <!ENTITY ntfs-3g-buildsize "22 MB">
13 <!ENTITY ntfs-3g-time "0.2 SBU">
14]>
15
16<sect1 id="ntfs-3g" xreflabel="ntfs-3g-&ntfs-3g-version;">
17 <?dbhtml filename="ntfs-3g.html"?>
18
19
20 <title>ntfs-3g-&ntfs-3g-version;</title>
21
22 <indexterm zone="ntfs-3g">
23 <primary sortas="a-ntfs-3g">ntfs-3g</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to Ntfs-3g</title>
28
29 <note>
30 <para id='ntfs3-kernel'>
31 A new read-write driver for NTFS, called NTFS3, has been added
32 into the Linux kernel since the 5.15 release. The performance of NTFS3
33 is much better than ntfs-3g. To enable NTFS3, enable the following
34 options in the kernel configuration and recompile the kernel if
35 necessary:
36 </para>
37
38<screen><literal>File systems ---&gt;
39 &lt;*/M&gt; NTFS Read-Write file system support [CONFIG_NTFS3_FS]</literal></screen>
40
41 <indexterm zone="ntfs-3g ntfs3-kernel">
42 <primary sortas="d-ntfs3">NTFS read-write support in kernel</primary>
43 </indexterm>
44
45 <para>
46 To ensure the <command>mount</command> command uses NTFS3 for
47 ntfs partitions, create a wrapper script:
48 </para>
49
50<screen role="nodump"><userinput>cat &gt; /usr/sbin/mount.ntfs &lt;&lt; "EOF" &amp;&amp;
51<literal>#!/bin/sh
52exec mount -t ntfs3 "$@"</literal>
53EOF
54chmod -v 755 /usr/sbin/mount.ntfs</userinput></screen>
55
56 <para>
57 With the kernel support available, ntfs-3g is only needed if you
58 need the utilities from it (for example, to create NTFS
59 filesystems).
60 </para>
61 </note>
62
63 <para>
64 The <application>Ntfs-3g</application> package contains a stable,
65 read-write open source driver for NTFS partitions. NTFS partitions are
66 used by most Microsoft operating systems. Ntfs-3g allows you to mount
67 NTFS partitions in read-write mode from your Linux system. It uses the
68 FUSE kernel module to be able to implement NTFS support in userspace.
69 The package also contains various utilities useful for manipulating NTFS
70 partitions.
71 </para>
72
73 &lfs112_checked;
74
75 <bridgehead renderas="sect3">Package Information</bridgehead>
76 <itemizedlist spacing="compact">
77 <listitem>
78 <para>
79 Download (HTTP): <ulink url="&ntfs-3g-download-http;"/>
80 </para>
81 </listitem>
82 <listitem>
83 <para>
84 Download (FTP): <ulink url="&ntfs-3g-download-ftp;"/>
85 </para>
86 </listitem>
87 <listitem>
88 <para>
89 Download MD5 sum: &ntfs-3g-md5sum;
90 </para>
91 </listitem>
92 <listitem>
93 <para>
94 Download size: &ntfs-3g-size;
95 </para>
96 </listitem>
97 <listitem>
98 <para>
99 Estimated disk space required: &ntfs-3g-buildsize;
100 </para>
101 </listitem>
102 <listitem>
103 <para>
104 Estimated build time: &ntfs-3g-time;
105 </para>
106 </listitem>
107 </itemizedlist>
108
109 <bridgehead renderas="sect3">Ntfs-3g Dependencies</bridgehead>
110
111 <bridgehead renderas="sect4">Optional</bridgehead>
112 <para role="optional">
113 <ulink url="https://github.com/libfuse/libfuse">fuse 2.x</ulink>
114 (this disables user mounts)
115 </para>
116
117 <para condition="html" role="usernotes">
118 User Notes: <ulink url="&blfs-wiki;/ntfs-3g"/>
119 </para>
120 </sect2>
121
122 <sect2 role="kernel" id="ntfs-3g-kernel">
123 <title>Kernel Configuration</title>
124
125 <para>
126 Enable the following options in the kernel configuration and recompile the
127 kernel if necessary:
128 </para>
129
130<screen><literal>File systems ---&gt;
131 &lt;*/M&gt; FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]</literal></screen>
132
133 <indexterm zone="ntfs-3g ntfs-3g-kernel">
134 <primary sortas="d-ntfs-3g">ntfs-3g</primary>
135 </indexterm>
136 </sect2>
137
138 <sect2 role="installation">
139 <title>Installation of Ntfs-3g</title>
140
141<!--
142 <para>
143 First, adapt <application>Ntfs-3g</application> to the merged-/usr
144 changes:
145 </para>
146
147<screen><userinput remap="pre">sed -i 's|/sbin|$(rootsbindir)|' {ntfsprogs,src}/Makefile.in</userinput></screen>
148-->
149
150 <para>
151 Install <application>Ntfs-3g</application> by running the following
152 commands:
153 </para>
154
155<screen><userinput>./configure --prefix=/usr \
156 --disable-static \
157 --with-fuse=internal \
158 --docdir=/usr/share/doc/ntfs-3g-&ntfs-3g-version; &amp;&amp;
159make</userinput></screen>
160
161 <para>
162 This package does not come with a test suite.
163 </para>
164
165 <para>
166 Now, as the <systemitem class="username">root</systemitem> user:
167 </para>
168
169<screen role="root"><userinput>make install &amp;&amp;</userinput></screen>
170
171 <para>
172 It's recommended to use the in-kernel NTFS3 driver for mounting
173 NTFS filesystems, instead of ntfs-3g (see the note at the start of
174 this page). However, if you want to use ntfs-3g to mount the NTFS
175 filesystems anyway, create a symlink for the <command>mount</command>
176 command:
177 </para>
178
179<screen role="nodump"><userinput>ln -sv ../bin/ntfs-3g /usr/sbin/mount.ntfs &amp;&amp;
180ln -sv ntfs-3g.8 /usr/share/man/man8/mount.ntfs.8</userinput></screen>
181
182 </sect2>
183
184 <sect2 role="commands">
185 <title>Command Explanations</title>
186
187 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
188 href="../../xincludes/static-libraries.xml"/>
189<!--
190 <para>
191 <command>patch -Np1 -i ...</command>: This command applies a security
192 patch from upstream to fix ntfs-3g on systems that use setuid for the
193 executable.
194 </para>
195-->
196
197 <para>
198 <parameter>--with-fuse=internal</parameter>: This switch dynamically
199 forces <application>ntfs-3g</application> to use an internal copy of the
200 <application>fuse-2.x</application> library. This is required if you wish
201 to allow users to mount NTFS partitions.
202 </para>
203
204 <para>
205 <option>--disable-ntfsprogs</option>: Disables installation of various
206 utilities used to manipulate NTFS partitions.
207 </para>
208
209 <para>
210 <command>chmod -v 4755 /usr/bin/ntfs-3g</command>: Making mount.ntfs setuid
211 root allows non root users to mount NTFS partitions.
212 </para>
213
214 </sect2>
215
216 <sect2 role="configuration">
217 <title>Using Ntfs-3g</title>
218
219 <para>
220 To mount a Windows partition at boot time, put a line like this in
221 /etc/fstab:
222 </para>
223
224 <screen>/dev/sda1 /mnt/windows auto defaults 0 0</screen>
225
226 <para>
227 To allow users to mount a usb stick with an NTFS filesystem on it, put a
228 line similar to this (change sdc1 to whatever a usb stick would be on your
229 system) in /etc/fstab:
230 </para>
231
232 <screen>/dev/sdc1 /mnt/usb auto user,noauto,umask=0,utf8 0 0</screen>
233
234 <para>
235 In order for a user to be able to mount the usb stick, they will need
236 to be able to write to <filename class="directory">/mnt/usb</filename>,
237 so as the <systemitem class="username">root</systemitem> user:
238 </para>
239
240<screen role="nodump"><userinput>chmod -v 777 /mnt/usb</userinput></screen>
241
242 </sect2>
243
244 <sect2 role="content">
245 <title>Contents</title>
246
247 <segmentedlist>
248 <segtitle>Installed Programs</segtitle>
249 <segtitle>Installed Library</segtitle>
250 <segtitle>Installed Directories</segtitle>
251
252 <seglistitem>
253 <seg>
254 lowntfs-3g, mkfs.ntfs, mkntfs, mount.lowntfs-3g,
255 mount.ntfs, mount.ntfs-3g, ntfs-3g, ntfs-3g.probe,
256 ntfscat, ntfsclone, ntfscluster, ntfscmp, ntfscp, ntfsfix,
257 ntfsinfo, ntfslabel, ntfsls, ntfsresize and
258 ntfsundelete
259 </seg>
260 <seg>
261 libntfs-3g.so
262 </seg>
263 <seg>
264 /usr/include/ntfs-3g and
265 /usr/share/doc/ntfs-3g
266 </seg>
267 </seglistitem>
268 </segmentedlist>
269
270 <variablelist>
271 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
272 <?dbfo list-presentation="list"?>
273 <?dbhtml list-presentation="table"?>
274
275 <varlistentry id="lowntfs-3g">
276 <term><command>lowntfs-3g</command></term>
277 <listitem>
278 <para>
279 is similar to ntfs-3g but uses the Fuse low-level interface
280 </para>
281 <indexterm zone="ntfs-3g lowntfs-3g">
282 <primary sortas="b-lowntfs-3g">lowntfs-3g</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="mkfs.ntfs">
288 <term><command>mkfs.ntfs</command></term>
289 <listitem>
290 <para>
291 is a symlink to mkntfs
292 </para>
293 <indexterm zone="ntfs-3g mkfs.ntfs">
294 <primary sortas="b-mkfs.ntfs">mkfs.ntfs</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="mkntfs">
300 <term><command>mkntfs</command></term>
301 <listitem>
302 <para>
303 creates an NTFS file system
304 </para>
305 <indexterm zone="ntfs-3g mkntfs">
306 <primary sortas="b-mkntfs">mkntfs</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="mount.lowntfs-3g">
312 <term><command>mount.lowntfs-3g</command></term>
313 <listitem>
314 <para>
315 is a symlink to lowntfs-3g
316 </para>
317 <indexterm zone="ntfs-3g mount.lowntfs-3g">
318 <primary sortas="b-mount.lowntfs-3g">mount.lowntfs-3g</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="mount.ntfs">
324 <term><command>mount.ntfs</command></term>
325 <listitem>
326 <para>
327 mounts an NTFS filesystem
328 </para>
329 <indexterm zone="ntfs-3g mount.ntfs">
330 <primary sortas="b-mount.ntfs">mount.ntfs</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 <varlistentry id="mount.ntfs-3g">
336 <term><command>mount.ntfs-3g</command></term>
337 <listitem>
338 <para>
339 is a symbolic link to ntfs-3g
340 </para>
341 <indexterm zone="ntfs-3g mount.ntfs-3g">
342 <primary sortas="b-mount.ntfs-3g">mount.ntfs-3g</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="ntfs-3g-prog">
348 <term><command>ntfs-3g</command></term>
349 <listitem>
350 <para>
351 is an NTFS driver, which can create, remove, rename, move
352 files, directories, hard links, and streams. It can also read and write
353 files, including streams, sparse files and transparently compressed
354 files. It can also handle special files like symbolic links, devices, and
355 FIFOs; moreover it provides standard management of file ownership
356 and permissions, including POSIX ACLs
357 </para>
358 <indexterm zone="ntfs-3g ntfs-3g-prog">
359 <primary sortas="b-ntfs-3g">ntfs-3g</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="ntfs-3g.probe">
365 <term><command>ntfs-3g.probe</command></term>
366 <listitem>
367 <para>
368 tests if an NTFS volume is mountable read only or read-write, and
369 exits with a status value accordingly. The volume can be a block
370 device or image file
371 </para>
372 <indexterm zone="ntfs-3g ntfs-3g.probe">
373 <primary sortas="b-ntfs-3g.probe">ntfs-3g.probe</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378<!-- Not present in 2021.8.22
379 <varlistentry id="ntfs-3g.secaudit">
380 <term><command>ntfs-3g.secaudit</command></term>
381 <listitem>
382 <para>
383 audits NTFS Security Data
384 </para>
385 <indexterm zone="ntfs-3g ntfs-3g.secaudit">
386 <primary sortas="b-ntfs-3g.secaudit">ntfs-3g.secaudit</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="ntfs-3g.usermap">
392 <term><command>ntfs-3g.usermap</command></term>
393 <listitem>
394 <para>
395 creates the file defining the mapping of Windows accounts to Linux
396 logins for users who owns files which should be visible from both
397 Windows and Linux
398 </para>
399 <indexterm zone="ntfs-3g ntfs-3g.usermap">
400 <primary sortas="b-ntfs-3g.usermap">ntfs-3g.usermap</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404-->
405
406 <varlistentry id="ntfscluster">
407 <term><command>ntfscluster</command></term>
408 <listitem>
409 <para>
410 identifies files in a specified region of an NTFS volume
411 </para>
412 <indexterm zone="ntfs-3g ntfscluster">
413 <primary sortas="b-ntfscluster">ntfscluster</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="ntfscp">
419 <term><command>ntfscp</command></term>
420 <listitem>
421 <para>
422 copies a file to an NTFS volume
423 </para>
424 <indexterm zone="ntfs-3g ntfscp">
425 <primary sortas="b-ntfscp">ntfscp</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 <varlistentry id="ntfsfix">
431 <term><command>ntfsfix</command></term>
432 <listitem>
433 <para>
434 fixes common errors and forces Windows to check an NTFS partition
435 </para>
436 <indexterm zone="ntfs-3g ntfsfix">
437 <primary sortas="b-ntfsfix">ntfsfix</primary>
438 </indexterm>
439 </listitem>
440 </varlistentry>
441
442 <varlistentry id="ntfsls">
443 <term><command>ntfsls</command></term>
444 <listitem>
445 <para>
446 lists directory contents on an NTFS filesystem
447 </para>
448 <indexterm zone="ntfs-3g ntfsls">
449 <primary sortas="b-ntfsls">ntfsls</primary>
450 </indexterm>
451 </listitem>
452 </varlistentry>
453
454 <varlistentry id="ntfscat">
455 <term><command>ntfscat</command></term>
456 <listitem>
457 <para>
458 prints NTFS files and streams on the standard output
459 </para>
460 <indexterm zone="ntfs-3g ntfscat">
461 <primary sortas="b-ntfscat">ntfscat</primary>
462 </indexterm>
463 </listitem>
464 </varlistentry>
465
466 <varlistentry id="ntfsclone">
467 <term><command>ntfsclone</command></term>
468 <listitem>
469 <para>
470 clones an NTFS filesystem
471 </para>
472 <indexterm zone="ntfs-3g ntfsclone">
473 <primary sortas="b-ntfsclone">ntfsclone</primary>
474 </indexterm>
475 </listitem>
476 </varlistentry>
477
478 <varlistentry id="ntfscmp">
479 <term><command>ntfscmp</command></term>
480 <listitem>
481 <para>
482 compares two NTFS filesystems and shows the differences
483 </para>
484 <indexterm zone="ntfs-3g ntfscmp">
485 <primary sortas="b-ntfscmp">ntfscmp</primary>
486 </indexterm>
487 </listitem>
488 </varlistentry>
489
490 <varlistentry id="ntfsinfo">
491 <term><command>ntfsinfo</command></term>
492 <listitem>
493 <para>
494 dumps a file's attributes
495 </para>
496 <indexterm zone="ntfs-3g ntfsinfo">
497 <primary sortas="b-ntfsinfo">ntfsinfo</primary>
498 </indexterm>
499 </listitem>
500 </varlistentry>
501
502 <varlistentry id="ntfslabel">
503 <term><command>ntfslabel</command></term>
504 <listitem>
505 <para>
506 displays or changes the label on an ntfs file system
507 </para>
508 <indexterm zone="ntfs-3g ntfslabel">
509 <primary sortas="b-ntfslabel">ntfslabel</primary>
510 </indexterm>
511 </listitem>
512 </varlistentry>
513
514 <varlistentry id="ntfsresize">
515 <term><command>ntfsresize</command></term>
516 <listitem>
517 <para>
518 resizes an NTFS filesystem without data loss
519 </para>
520 <indexterm zone="ntfs-3g ntfsresize">
521 <primary sortas="b-ntfsresize">ntfsresize</primary>
522 </indexterm>
523 </listitem>
524 </varlistentry>
525
526 <varlistentry id="ntfsundelete">
527 <term><command>ntfsundelete</command></term>
528 <listitem>
529 <para>
530 recovers a deleted file from an NTFS volume
531 </para>
532 <indexterm zone="ntfs-3g ntfsundelete">
533 <primary sortas="b-ntfsundelete">ntfsundelete</primary>
534 </indexterm>
535 </listitem>
536 </varlistentry>
537
538 <varlistentry id="libntfs-3g">
539 <term><filename class="libraryfile">libntfs-3g.so</filename></term>
540 <listitem>
541 <para>
542 contains the Ntfs-3g API functions
543 </para>
544 <indexterm zone="ntfs-3g libntfs-3g">
545 <primary sortas="c-libntfs-3g">libntfs-3g.so</primary>
546 </indexterm>
547 </listitem>
548 </varlistentry>
549 </variablelist>
550 </sect2>
551
552</sect1>
Note: See TracBrowser for help on using the repository browser.