README

   1
   2 INTRODUCTION
   3 ============
   4
   5 The NTFS-3G driver is an open source, freely available read/write NTFS driver
   6 for Linux, FreeBSD, Mac OS X, NetBSD, OpenSolaris, QNX and Haiku. It provides
   7 safe and fast handling of the Windows XP, Windows Server 2003, Windows 2000,
   8 Windows Vista, Windows Server 2008 and Windows 7 file systems.
   9
  10 The purpose of the project is to develop, quality assurance and support a
  11 trustable, featureful and high performance solution for hardware platforms
  12 and operating systems whose users need to reliably interoperate with NTFS.
  13 Besides this practical goal, the project also aims to explore the limits
  14 of the hybrid, kernel/user space filesystem driver approach, performance,
  15 reliability and feature richness per invested effort wise.
  16
  17 Besides the common file system features, NTFS-3G has support for file
  18 ownership and permissions, POSIX ACLs, junction points, extended attributes
  19 and creating internally compressed files (parameter files in the directory
  20 .NTFS-3G may be required to enable them). The new compressed file formats
  21 available in Windows 10 can also be read through a plugin. For using
  22 advanced features, please get the instructions from
  23
  24         http://www.tuxera.com/community/ntfs-3g-advanced/
  25
  26 News, support answers, problem submission instructions, support and discussion
  27 forums, performance numbers and other information are available on the project
  28 web site at
  29
  30         http://www.tuxera.com/community/
  31
  32 LICENSES
  33 ========
  34
  35 All the NTFS related components : the file system drivers, the ntfsprogs
  36 utilities and the shared library libntfs-3g are distributed under the terms
  37 of the GNU General Public License as published by the Free Software
  38 Foundation; either version 2 of the License, or (at your option) any later
  39 version. See the included file COPYING.
  40
  41 The fuse-lite library is distributed under the terms of the GNU LGPLv2.
  42 See the included file COPYING.LIB.
  43
  44 QUICK INSTALLATION
  45 ==================
  46
  47 Linux: Make sure you have the basic development tools and the kernel includes
  48 the FUSE kernel module. Then unpack the source tarball and type:
  49
  50         ./configure
  51         make
  52         make install      # or 'sudo make install' if you aren't root.
  53
  54 Please note that NTFS-3G doesn't require the FUSE user space package any
  55 more.
  56
  57 The list of options for building specific configurations is displayed by
  58 typing :
  59
  60         ./configure --help
  61
  62 Below are a few specific options to ./configure :
  63         --disable-ntfsprogs : do not build the ntfsprogs tools,
  64         --enable-extras : build more ntfsprogs tools,
  65         --disable-plugins : disable support for plugins
  66         --enable-posix-acls : enable support for Posix ACLs
  67         --enable-xattr-mappings : enable system extended attributes mappings
  68         --with-fuse=external : use external fuse (overriding Linux default)
  69
  70 There are also a few make targets for building parts :
  71         make libntfs : only build the libntfs-3g library
  72         make libs : only build libntfs-3g (and libfuse-lite, if relevant)
  73         make drivers : only build drivers and libraries, without ntfsprogs
  74         make ntfsprogs : only build ntfsprogs and libntfs-3g, without drivers
  75
  76 Non-Linux: Please see
  77
  78         http://www.tuxera.com/community/ntfs-3g-download/
  79
  80 for known OS specific installation and source packages, but generally
  81 the same procedures apply.
  82
  83 USAGE
  84 =====
  85
  86 If there was no error during installation then the NTFS volume can be
  87 read-write mounted for everybody the following way as the root user
  88 (unmount the volume if it was already mounted, and replace /dev/sda1
  89 and /mnt/windows, if needed):
  90
  91         mount -t ntfs-3g /dev/sda1 /mnt/windows
  92 or
  93         ntfs-3g /dev/sda1 /mnt/windows
  94
  95 Please see the ntfs-3g manual page for more options and examples.
  96
  97 You can also make NTFS to be mounted during boot by putting the below
  98 line at the END(!) of the /etc/fstab file:
  99
 100         /dev/sda1 /mnt/windows ntfs-3g defaults 0 0
 101
 102
 103 TESTING WITHOUT INSTALLING
 104 =========================
 105
 106 Newer versions of ntfs-3g can be tested without installing anything and
 107 without disturbing an existing installation. Just configure and make as
 108 shown previously. This will create the scripts ntfs-3g and lowntfs-3g
 109 in the src directory, which you may activate for testing :
 110
 111         ./configure
 112         make
 113
 114 then, as root :
 115         src/ntfs-3g [-o mount-options] /dev/sda1 /mnt/windows
 116
 117 And, to end the test, unmount the usual way :
 118         umount /dev/sda1
 119
 120
 121 NTFS UTILITIES
 122 ==============
 123
 124 The ntfsprogs includes utilities for doing all required tasks to NTFS
 125 partitions.  In general, just run a utility without any command line
 126 options to display the version number and usage syntax.
 127
 128 The following utilities are so far implemented:
 129
 130 ntfsfix - Attempt to fix an NTFS partition and force Windows to check NTFS.
 131
 132 mkntfs - Format a partition with the NTFS filesystem.  See man 8 mkntfs for
 133 command line options.
 134
 135 ntfslabel - Display/change the label of an NTFS partition.  See man 8 ntfslabel
 136 for details.
 137
 138 ntfsundelete - Recover deleted files from an NTFS volume.  See man 8
 139 ntfsundelete for more details.
 140
 141 ntfsresize - Resize NTFS volumes.  See man 8 ntfsresize for details.
 142
 143 ntfsclone - Efficiently create/restore an image of an NTFS partition.  See
 144 man 8 ntfsclone for details.
 145
 146 ntfscluster - Locate the owner of any given sector or cluster on an NTFS
 147 partition.  See man 8 ntfscluster for details.
 148
 149 ntfsinfo - Show some information about an NTFS partition or one of the files
 150 or directories within it.  See man 8 ntfsinfo for details.
 151
 152 ntfsrecover - Recover updates committed by Windows but interrupted before
 153 being synced.
 154
 155 ntfsls - List information about files in a directory residing on an NTFS
 156 partition.  See man 8 ntfsls for details.
 157
 158 ntfscat - Concatenate files and print their contents on the standard output.
 159
 160 ntfscp - Overwrite files on an NTFS partition.
 161
 162 ntfssecaudit : audit the security metadata.
 163
 164 ntfsusermap : assistance for building a user mapping file.