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

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 c8293ea was c8293ea, checked in by Douglas R. Reno <renodr@…>, 17 months ago

Several tags

  • 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 "d97474ae1954f772c6d2fa386a6f462c">
11 <!ENTITY ntfs-3g-size "1.2 MB">
12 <!ENTITY ntfs-3g-buildsize "20 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 <para>
111 First, adapt <application>Ntfs-3g</application> to the merged-/usr
112 changes:
113 </para>
114
115<screen><userinput remap="pre">sed -i 's|/sbin|$(rootsbindir)|' {ntfsprogs,src}/Makefile.in</userinput></screen>
116
117 <para>
118 Install <application>Ntfs-3g</application> by running the following
119 commands:
120 </para>
121
122<screen><userinput>./configure --prefix=/usr \
123 --disable-static \
124 --with-fuse=internal \
125 --docdir=/usr/share/doc/ntfs-3g-&ntfs-3g-version; &amp;&amp;
126make</userinput></screen>
127
128 <para>
129 This package does not come with a test suite.
130 </para>
131
132 <para>
133 Now, as the <systemitem class="username">root</systemitem> user:
134 </para>
135
136<screen role="root"><userinput>make install &amp;&amp;
137ln -sv ../bin/ntfs-3g /usr/sbin/mount.ntfs &amp;&amp;
138ln -sv ntfs-3g.8 /usr/share/man/man8/mount.ntfs.8</userinput></screen>
139
140 <para>
141 If you want ordinary users to be able to mount NTFS partitions you'll need
142 to set mount.ntfs with the root user ID. Note: it is probably unsafe to do
143 this on a computer that needs to be secure (like a server). As the
144 <systemitem class="username">root</systemitem> user:
145 </para>
146
147<screen role="root"><userinput>chmod -v 4755 /usr/bin/ntfs-3g</userinput></screen>
148
149 </sect2>
150
151 <sect2 role="commands">
152 <title>Command Explanations</title>
153
154 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
155 href="../../xincludes/static-libraries.xml"/>
156<!--
157 <para>
158 <command>patch -Np1 -i ...</command>: This command applies a security
159 patch from upstream to fix ntfs-3g on systems that use setuid for the
160 executable.
161 </para>
162-->
163
164 <para>
165 <parameter>--with-fuse=internal</parameter>: This switch dynamically
166 forces <application>ntfs-3g</application> to use an internal copy of the
167 <application>fuse-2.x</application> library. This is required if you wish
168 to allow users to mount NTFS partitions.
169 </para>
170
171 <para>
172 <option>--disable-ntfsprogs</option>: Disables installation of various
173 utilities used to manipulate NTFS partitions.
174 </para>
175
176 <para>
177 <command>ln -sv ../bin/ntfs-3g /usr/sbin/mount.ntfs</command>: Creating
178 /sbin/mount.ntfs makes <command>mount</command> default to using Ntfs-3g
179 to mount NTFS partitions.
180 </para>
181
182 <para>
183 <command>chmod -v 4755 /usr/bin/ntfs-3g</command>: Making mount.ntfs setuid
184 root allows non root users to mount NTFS partitions.
185 </para>
186
187 </sect2>
188
189 <sect2 role="configuration">
190 <title>Using Ntfs-3g</title>
191
192 <para>
193 To mount a Windows partition at boot time, put a line like this in
194 /etc/fstab:
195 </para>
196
197 <screen>/dev/sda1 /mnt/windows auto defaults 0 0</screen>
198
199 <para>
200 To allow users to mount a usb stick with an NTFS filesystem on it, put a
201 line similar to this (change sdc1 to whatever a usb stick would be on your
202 system) in /etc/fstab:
203 </para>
204
205 <screen>/dev/sdc1 /mnt/usb auto user,noauto,umask=0,utf8 0 0</screen>
206
207 <para>
208 In order for a user to be able to mount the usb stick, they will need
209 to be able to write to <filename class="directory">/mnt/usb</filename>,
210 so as the <systemitem class="username">root</systemitem> user:
211 </para>
212
213<screen role="nodump"><userinput>chmod -v 777 /mnt/usb</userinput></screen>
214
215 </sect2>
216
217 <sect2 role="content">
218 <title>Contents</title>
219
220 <segmentedlist>
221 <segtitle>Installed Programs</segtitle>
222 <segtitle>Installed Library</segtitle>
223 <segtitle>Installed Directories</segtitle>
224
225 <seglistitem>
226 <seg>
227 lowntfs-3g, mkfs.ntfs, mkntfs, mount.lowntfs-3g,
228 mount.ntfs, mount.ntfs-3g, ntfs-3g, ntfs-3g.probe,
229 ntfs-3g.secaudit, ntfs-3g.usermap, ntfscat,
230 ntfsclone, ntfscluster, ntfscmp, ntfscp, ntfsfix,
231 ntfsinfo, ntfslabel, ntfsls, ntfsresize and
232 ntfsundelete
233 </seg>
234 <seg>
235 libntfs-3g.so
236 </seg>
237 <seg>
238 /usr/include/ntfs-3g and
239 /usr/share/doc/ntfs-3g
240 </seg>
241 </seglistitem>
242 </segmentedlist>
243
244 <variablelist>
245 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
246 <?dbfo list-presentation="list"?>
247 <?dbhtml list-presentation="table"?>
248
249 <varlistentry id="lowntfs-3g">
250 <term><command>lowntfs-3g</command></term>
251 <listitem>
252 <para>
253 is similar to ntfs-3g but uses the Fuse low-level interface
254 </para>
255 <indexterm zone="ntfs-3g lowntfs-3g">
256 <primary sortas="b-lowntfs-3g">lowntfs-3g</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="mkfs.ntfs">
262 <term><command>mkfs.ntfs</command></term>
263 <listitem>
264 <para>
265 is a symlink to mkntfs
266 </para>
267 <indexterm zone="ntfs-3g mkfs.ntfs">
268 <primary sortas="b-mkfs.ntfs">mkfs.ntfs</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="mkntfs">
274 <term><command>mkntfs</command></term>
275 <listitem>
276 <para>
277 creates an NTFS file system
278 </para>
279 <indexterm zone="ntfs-3g mkntfs">
280 <primary sortas="b-mkntfs">mkntfs</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="mount.lowntfs-3g">
286 <term><command>mount.lowntfs-3g</command></term>
287 <listitem>
288 <para>
289 is a symlink to lowntfs-3g
290 </para>
291 <indexterm zone="ntfs-3g mount.lowntfs-3g">
292 <primary sortas="b-mount.lowntfs-3g">mount.lowntfs-3g</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="mount.ntfs">
298 <term><command>mount.ntfs</command></term>
299 <listitem>
300 <para>
301 mounts an NTFS filesystem
302 </para>
303 <indexterm zone="ntfs-3g mount.ntfs">
304 <primary sortas="b-mount.ntfs">mount.ntfs</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="mount.ntfs-3g">
310 <term><command>mount.ntfs-3g</command></term>
311 <listitem>
312 <para>
313 is a symbolic link to ntfs-3g
314 </para>
315 <indexterm zone="ntfs-3g mount.ntfs-3g">
316 <primary sortas="b-mount.ntfs-3g">mount.ntfs-3g</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="ntfs-3g-prog">
322 <term><command>ntfs-3g</command></term>
323 <listitem>
324 <para>
325 is an NTFS driver, which can create, remove, rename, move
326 files, directories, hard links, and streams. It can also read and write
327 files, including streams, sparse files and transparently compressed
328 files. It can also handle special files like symbolic links, devices, and
329 FIFOs; moreover it provides standard management of file ownership
330 and permissions, including POSIX ACLs
331 </para>
332 <indexterm zone="ntfs-3g ntfs-3g-prog">
333 <primary sortas="b-ntfs-3g">ntfs-3g</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="ntfs-3g.probe">
339 <term><command>ntfs-3g.probe</command></term>
340 <listitem>
341 <para>
342 tests if an NTFS volume is mountable read only or read-write, and
343 exits with a status value accordingly. The volume can be a block
344 device or image file
345 </para>
346 <indexterm zone="ntfs-3g ntfs-3g.probe">
347 <primary sortas="b-ntfs-3g.probe">ntfs-3g.probe</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="ntfs-3g.secaudit">
353 <term><command>ntfs-3g.secaudit</command></term>
354 <listitem>
355 <para>
356 audits NTFS Security Data
357 </para>
358 <indexterm zone="ntfs-3g ntfs-3g.secaudit">
359 <primary sortas="b-ntfs-3g.secaudit">ntfs-3g.secaudit</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="ntfs-3g.usermap">
365 <term><command>ntfs-3g.usermap</command></term>
366 <listitem>
367 <para>
368 creates the file defining the mapping of Windows accounts to Linux
369 logins for users who owns files which should be visible from both
370 Windows and Linux
371 </para>
372 <indexterm zone="ntfs-3g ntfs-3g.usermap">
373 <primary sortas="b-ntfs-3g.usermap">ntfs-3g.usermap</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="ntfscluster">
379 <term><command>ntfscluster</command></term>
380 <listitem>
381 <para>
382 identifies files in a specified region of an NTFS volume
383 </para>
384 <indexterm zone="ntfs-3g ntfscluster">
385 <primary sortas="b-ntfscluster">ntfscluster</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="ntfscp">
391 <term><command>ntfscp</command></term>
392 <listitem>
393 <para>
394 copies a file to an NTFS volume
395 </para>
396 <indexterm zone="ntfs-3g ntfscp">
397 <primary sortas="b-ntfscp">ntfscp</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="ntfsfix">
403 <term><command>ntfsfix</command></term>
404 <listitem>
405 <para>
406 fixes common errors and forces Windows to check an NTFS partition
407 </para>
408 <indexterm zone="ntfs-3g ntfsfix">
409 <primary sortas="b-ntfsfix">ntfsfix</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="ntfsls">
415 <term><command>ntfsls</command></term>
416 <listitem>
417 <para>
418 lists directory contents on an NTFS filesystem
419 </para>
420 <indexterm zone="ntfs-3g ntfsls">
421 <primary sortas="b-ntfsls">ntfsls</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="ntfscat">
427 <term><command>ntfscat</command></term>
428 <listitem>
429 <para>
430 prints NTFS files and streams on the standard output
431 </para>
432 <indexterm zone="ntfs-3g ntfscat">
433 <primary sortas="b-ntfscat">ntfscat</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437
438 <varlistentry id="ntfsclone">
439 <term><command>ntfsclone</command></term>
440 <listitem>
441 <para>
442 clones an NTFS filesystem
443 </para>
444 <indexterm zone="ntfs-3g ntfsclone">
445 <primary sortas="b-ntfsclone">ntfsclone</primary>
446 </indexterm>
447 </listitem>
448 </varlistentry>
449
450 <varlistentry id="ntfscmp">
451 <term><command>ntfscmp</command></term>
452 <listitem>
453 <para>
454 compares two NTFS filesystems and tells the differences
455 </para>
456 <indexterm zone="ntfs-3g ntfscmp">
457 <primary sortas="b-ntfscmp">ntfscmp</primary>
458 </indexterm>
459 </listitem>
460 </varlistentry>
461
462 <varlistentry id="ntfsinfo">
463 <term><command>ntfsinfo</command></term>
464 <listitem>
465 <para>
466 dumps a file's attributes
467 </para>
468 <indexterm zone="ntfs-3g ntfsinfo">
469 <primary sortas="b-ntfsinfo">ntfsinfo</primary>
470 </indexterm>
471 </listitem>
472 </varlistentry>
473
474 <varlistentry id="ntfslabel">
475 <term><command>ntfslabel</command></term>
476 <listitem>
477 <para>
478 displays or changes the label on an ntfs file system
479 </para>
480 <indexterm zone="ntfs-3g ntfslabel">
481 <primary sortas="b-ntfslabel">ntfslabel</primary>
482 </indexterm>
483 </listitem>
484 </varlistentry>
485
486 <varlistentry id="ntfsresize">
487 <term><command>ntfsresize</command></term>
488 <listitem>
489 <para>
490 resizes an NTFS filesystem without data loss
491 </para>
492 <indexterm zone="ntfs-3g ntfsresize">
493 <primary sortas="b-ntfsresize">ntfsresize</primary>
494 </indexterm>
495 </listitem>
496 </varlistentry>
497
498 <varlistentry id="ntfsundelete">
499 <term><command>ntfsundelete</command></term>
500 <listitem>
501 <para>
502 recovers a deleted file from an NTFS volume
503 </para>
504 <indexterm zone="ntfs-3g ntfsundelete">
505 <primary sortas="b-ntfsundelete">ntfsundelete</primary>
506 </indexterm>
507 </listitem>
508 </varlistentry>
509
510 <varlistentry id="libntfs-3g">
511 <term><filename class="libraryfile">libntfs-3g.so</filename></term>
512 <listitem>
513 <para>
514 contains the Ntfs-3g API functions
515 </para>
516 <indexterm zone="ntfs-3g libntfs-3g">
517 <primary sortas="c-libntfs-3g">libntfs-3g.so</primary>
518 </indexterm>
519 </listitem>
520 </varlistentry>
521 </variablelist>
522 </sect2>
523
524</sect1>
Note: See TracBrowser for help on using the repository browser.