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

11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since abf26df was abf26df, checked in by Douglas R. Reno <renodr@…>, 17 months ago

Update to ntfs-3g-2021.8.22 (security update) as well as reverify
affected packages (gparted/udisks)

  • Property mode set to 100644
File size: 16.2 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 "90da343e78877d388eb34cefae6799ae">
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 <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>
33 The <application>Ntfs-3g</application> package contains a stable,
34 read-write open source driver for NTFS partitions. NTFS partitions are
35 used by most Microsoft operating systems. Ntfs-3g allows you to mount
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.
38 The package also contains various utilities useful for manipulating NTFS
39 partitions.
40 </para>
41
42 &lfs110a_checked;
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
80 <bridgehead renderas="sect4">Optional</bridgehead>
81 <para role="optional">
82 <ulink url="https://github.com/libfuse/libfuse">fuse 2.x</ulink>
83 (this disables user mounts)
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;
100 &lt;*/M&gt; FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]</literal></screen>
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
110<!--
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>
117-->
118
119 <para>
120 Install <application>Ntfs-3g</application> by running the following
121 commands:
122 </para>
123
124<screen><userinput>./configure --prefix=/usr \
125 --disable-static \
126 --with-fuse=internal \
127 --docdir=/usr/share/doc/ntfs-3g-&ntfs-3g-version; &amp;&amp;
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;
139ln -sv ../bin/ntfs-3g /usr/sbin/mount.ntfs &amp;&amp;
140ln -sv ntfs-3g.8 /usr/share/man/man8/mount.ntfs.8</userinput></screen>
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
149<screen role="root"><userinput>chmod -v 4755 /usr/bin/ntfs-3g</userinput></screen>
150
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"/>
158<!--
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>
164-->
165
166 <para>
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.
171 </para>
172
173 <para>
174 <option>--disable-ntfsprogs</option>: Disables installation of various
175 utilities used to manipulate NTFS partitions.
176 </para>
177
178 <para>
179 <command>ln -sv ../bin/ntfs-3g /usr/sbin/mount.ntfs</command>: Creating
180 /sbin/mount.ntfs makes <command>mount</command> default to using Ntfs-3g
181 to mount NTFS partitions.
182 </para>
183
184 <para>
185 <command>chmod -v 4755 /usr/bin/ntfs-3g</command>: Making mount.ntfs setuid
186 root allows non root users to mount NTFS partitions.
187 </para>
188
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
203 line similar to this (change sdc1 to whatever a usb stick would be on your
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>
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>,
212 so as the <systemitem class="username">root</systemitem> user:
213 </para>
214
215<screen role="nodump"><userinput>chmod -v 777 /mnt/usb</userinput></screen>
216
217 </sect2>
218
219 <sect2 role="content">
220 <title>Contents</title>
221
222 <segmentedlist>
223 <segtitle>Installed Programs</segtitle>
224 <segtitle>Installed Library</segtitle>
225 <segtitle>Installed Directories</segtitle>
226
227 <seglistitem>
228 <seg>
229 lowntfs-3g, mkfs.ntfs, mkntfs, mount.lowntfs-3g,
230 mount.ntfs, mount.ntfs-3g, ntfs-3g, ntfs-3g.probe,
231 ntfscat, ntfsclone, ntfscluster, ntfscmp, ntfscp, ntfsfix,
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
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>
254 is similar to ntfs-3g but uses the Fuse low-level interface
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>
266 is a symlink to mkntfs
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>
278 creates an NTFS file system
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>
290 is a symlink to lowntfs-3g
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>
302 mounts an NTFS filesystem
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>
314 is a symbolic link to ntfs-3g
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
327 files, directories, hard links, and streams. It can also read and write
328 files, including streams, sparse files and transparently compressed
329 files. It can also handle special files like symbolic links, devices, and
330 FIFOs; moreover it provides standard management of file ownership
331 and permissions, including POSIX ACLs
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
345 device or image file
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
353<!-- Not present in 2021.8.22
354 <varlistentry id="ntfs-3g.secaudit">
355 <term><command>ntfs-3g.secaudit</command></term>
356 <listitem>
357 <para>
358 audits NTFS Security Data
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
372 Windows and Linux
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>
379-->
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>
397 copies a file to an NTFS volume
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>
409 fixes common errors and forces Windows to check an NTFS partition
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>
421 lists directory contents on an NTFS filesystem
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>
433 prints NTFS files and streams on the standard output
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>
445 clones an NTFS filesystem
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>
457 compares two NTFS filesystems and shows the differences
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>
469 dumps a file's attributes
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>
481 displays or changes the label on an ntfs file system
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>
493 resizes an NTFS filesystem without data loss
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>
505 recovers a deleted file from an NTFS volume
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>
517 contains the Ntfs-3g API functions
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>
526
527</sect1>
Note: See TracBrowser for help on using the repository browser.