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

11.1 11.2 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 upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 8558044 was 8558044, checked in by Pierre Labastie <pierre.labastie@…>, 3 years ago

Remove spaces at the end of lines

I know it is somewhat useless, but I don't like them for
two reasons: first they cannot be seen, and I do not like things I
cannot see. Second, git highlights them, and this is disturbing...

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