Use markdown in README.
parent
92b9fbc6fe
commit
f927e43cee
61
README
61
README
|
@ -1,6 +1,5 @@
|
|||
|
||||
INTRODUCTION
|
||||
============
|
||||
## INTRODUCTION
|
||||
---------------
|
||||
|
||||
The NTFS-3G driver is an open source, freely available read/write NTFS driver
|
||||
for Linux, FreeBSD, macOS, NetBSD, OpenIndiana, QNX and Haiku. It provides
|
||||
|
@ -31,8 +30,8 @@ The project has been funded, supported and maintained since 2008 by Tuxera:
|
|||
https://tuxera.com
|
||||
|
||||
|
||||
LICENSES
|
||||
========
|
||||
## LICENSES
|
||||
-----------
|
||||
|
||||
All the NTFS related components: the file system drivers, the ntfsprogs
|
||||
utilities and the shared library libntfs-3g are distributed under the terms
|
||||
|
@ -44,8 +43,8 @@ The fuse-lite library is distributed under the terms of the GNU LGPLv2.
|
|||
See the included file COPYING.LIB.
|
||||
|
||||
|
||||
QUICK INSTALLATION
|
||||
==================
|
||||
## QUICK INSTALLATION
|
||||
---------------------
|
||||
|
||||
Most distributions have an up-to-date NTFS-3G package ready for use, and
|
||||
the recommended way is to install it.
|
||||
|
@ -53,11 +52,11 @@ the recommended way is to install it.
|
|||
If you need some specific customization, you can compile and install from
|
||||
the released source code. Make sure you have the basic development tools
|
||||
and the kernel includes the FUSE kernel module. Then unpack the source
|
||||
tarball and type:
|
||||
tarball and type:
|
||||
|
||||
./configure
|
||||
make
|
||||
make install # or 'sudo make install' if you aren't root.
|
||||
make install # or 'sudo make install' if you aren't root.
|
||||
|
||||
Please note that NTFS-3G doesn't require the FUSE user space package any
|
||||
more.
|
||||
|
@ -68,6 +67,7 @@ typing :
|
|||
./configure --help
|
||||
|
||||
Below are a few specific options to ./configure :
|
||||
|
||||
--disable-ntfsprogs : do not build the ntfsprogs tools,
|
||||
--enable-extras : build more ntfsprogs tools,
|
||||
--disable-plugins : disable support for plugins
|
||||
|
@ -76,14 +76,15 @@ Below are a few specific options to ./configure :
|
|||
--with-fuse=external : use external fuse (overriding Linux default)
|
||||
|
||||
There are also a few make targets for building parts :
|
||||
|
||||
make libntfs : only build the libntfs-3g library
|
||||
make libs : only build libntfs-3g (and libfuse-lite, if relevant)
|
||||
make drivers : only build drivers and libraries, without ntfsprogs
|
||||
make ntfsprogs : only build ntfsprogs and libntfs-3g, without drivers
|
||||
|
||||
|
||||
USAGE
|
||||
=====
|
||||
## USAGE
|
||||
--------
|
||||
|
||||
If there was no error during installation then the NTFS volume can be
|
||||
read-write mounted for everybody the following way as the root user
|
||||
|
@ -91,7 +92,9 @@ read-write mounted for everybody the following way as the root user
|
|||
and /mnt/windows, if needed):
|
||||
|
||||
mount -t ntfs-3g /dev/sda1 /mnt/windows
|
||||
|
||||
or
|
||||
|
||||
ntfs-3g /dev/sda1 /mnt/windows
|
||||
|
||||
Please see the ntfs-3g manual page for more options and examples.
|
||||
|
@ -102,8 +105,8 @@ line at the END(!) of the /etc/fstab file:
|
|||
/dev/sda1 /mnt/windows ntfs-3g defaults 0 0
|
||||
|
||||
|
||||
TESTING WITHOUT INSTALLING
|
||||
=========================
|
||||
## TESTING WITHOUT INSTALLING
|
||||
-----------------------------
|
||||
|
||||
Newer versions of ntfs-3g can be tested without installing anything and
|
||||
without disturbing an existing installation. Just configure and make as
|
||||
|
@ -114,14 +117,16 @@ in the src directory, which you may activate for testing:
|
|||
make
|
||||
|
||||
then, as root:
|
||||
|
||||
src/ntfs-3g [-o mount-options] /dev/sda1 /mnt/windows
|
||||
|
||||
And, to end the test, unmount the usual way:
|
||||
|
||||
umount /dev/sda1
|
||||
|
||||
|
||||
NTFS UTILITIES
|
||||
==============
|
||||
## NTFS UTILITIES
|
||||
-----------------
|
||||
|
||||
The ntfsprogs directory includes utilities for doing all required tasks to
|
||||
NTFS partitions. In general, just run a utility without any command line
|
||||
|
@ -131,31 +136,23 @@ The following utilities are so far implemented:
|
|||
|
||||
ntfsfix - Attempt to fix an NTFS partition and force Windows to check NTFS.
|
||||
|
||||
mkntfs - Format a partition with the NTFS filesystem. See man 8 mkntfs for
|
||||
command line options.
|
||||
mkntfs - Format a partition with the NTFS filesystem. See man 8 mkntfs for command line options.
|
||||
|
||||
ntfslabel - Display/change the label of an NTFS partition. See man 8 ntfslabel
|
||||
for details.
|
||||
ntfslabel - Display/change the label of an NTFS partition. See man 8 ntfslabel for details.
|
||||
|
||||
ntfsundelete - Recover deleted files from an NTFS volume. See man 8
|
||||
ntfsundelete for more details.
|
||||
ntfsundelete - Recover deleted files from an NTFS volume. See man 8 ntfsundelete for more details.
|
||||
|
||||
ntfsresize - Resize NTFS volumes. See man 8 ntfsresize for details.
|
||||
ntfsresize - Resize NTFS volumes. See man 8 ntfsresize for details.
|
||||
|
||||
ntfsclone - Efficiently create/restore an image of an NTFS partition. See
|
||||
man 8 ntfsclone for details.
|
||||
ntfsclone - Efficiently create/restore an image of an NTFS partition. See man 8 ntfsclone for details.
|
||||
|
||||
ntfscluster - Locate the owner of any given sector or cluster on an NTFS
|
||||
partition. See man 8 ntfscluster for details.
|
||||
ntfscluster - Locate the owner of any given sector or cluster on an NTFS partition. See man 8 ntfscluster for details.
|
||||
|
||||
ntfsinfo - Show some information about an NTFS partition or one of the files
|
||||
or directories within it. See man 8 ntfsinfo for details.
|
||||
ntfsinfo - Show some information about an NTFS partition or one of the files or directories within it. See man 8 ntfsinfo for details.
|
||||
|
||||
ntfsrecover - Recover updates committed by Windows but interrupted before
|
||||
being synced.
|
||||
ntfsrecover - Recover updates committed by Windows but interrupted before being synced.
|
||||
|
||||
ntfsls - List information about files in a directory residing on an NTFS
|
||||
partition. See man 8 ntfsls for details.
|
||||
ntfsls - List information about files in a directory residing on an NTFS partition. See man 8 ntfsls for details.
|
||||
|
||||
ntfscat - Concatenate files and print their contents on the standard output.
|
||||
|
||||
|
|
Loading…
Reference in New Issue