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

trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 3 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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