release/src/router/ntfs-3g/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 compressed files. Parameter files in the directory .NTFS-3G may
  20 be required to enable them, please get the instructions from
  21
  22         http://www.tuxera.com/community/ntfs-3g-advanced/
  23
  24 News, support answers, problem submission instructions, support and discussion
  25 forums, performance numbers and other information are available on the project
  26 web site at
  27
  28         http://www.tuxera.com/community/
  29
  30 LICENSES
  31 ========
  32
  33 All the NTFS related components : the file system drivers, the ntfsprogs
  34 utilities and the shared library libntfs-3g are distributed under the terms
  35 of the GNU General Public License as published by the Free Software
  36 Foundation; either version 2 of the License, or (at your option) any later
  37 version. See the included file COPYING.
  38
  39 The fuse-lite library is distributed under the terms of the GNU LGPLv2.
  40 See the included file COPYING.LIB.
  41
  42 QUICK INSTALLATION
  43 ==================
  44
  45 Linux: Make sure you have the basic development tools and the kernel includes
  46 the FUSE kernel module. Then unpack the source tarball and type:
  47
  48         ./configure
  49         make
  50         make install      # or 'sudo make install' if you aren't root.
  51
  52 Please note that NTFS-3G doesn't require the FUSE user space package any
  53 more.
  54
  55 The list of options for building specific configurations is displayed by
  56 typing :
  57
  58         ./configure --help
  59
  60 Below are a few specific options to ./configure :
  61         --disable-ntfsprogs : do not build the ntfsprogs tools,
  62         --enable-posix-acls : enable support for Posix ACLs
  63         --enable-xattr-mappings : enable system extended attributes mappings
  64         --with-fuse=external : use external fuse (overriding Linux default)
  65
  66 There are also a few make targets for building parts :
  67         make libntfs : only build the libntfs-3g library
  68         make libs : only build libntfs-3g (and libfuse-lite, if relevant)
  69         make drivers : only build drivers and libraries, without ntfsprogs
  70         make ntfsprogs : only build ntfsprogs and libntfs-3g, without drivers
  71
  72 Non-Linux: Please see
  73
  74         http://www.tuxera.com/community/ntfs-3g-download/
  75
  76 for known OS specific installation and source packages, but generally
  77 the same procedures apply.
  78
  79 USAGE
  80 =====
  81
  82 If there was no error during installation then the NTFS volume can be
  83 read-write mounted for everybody the following way as the root user
  84 (unmount the volume if it was already mounted, and replace /dev/sda1
  85 and /mnt/windows, if needed):
  86
  87         mount -t ntfs-3g /dev/sda1 /mnt/windows
  88 or
  89         ntfs-3g /dev/sda1 /mnt/windows
  90
  91 Please see the ntfs-3g manual page for more options and examples.
  92
  93 You can also make NTFS to be mounted during boot by putting the below
  94 line at the END(!) of the /etc/fstab file:
  95
  96         /dev/sda1 /mnt/windows ntfs-3g defaults 0 0
  97
  98
  99 TESTING WITHOUT INSTALLING
 100 =========================
 101
 102 Newer versions of ntfs-3g can be tested without installing anything and
 103 without disturbing an existing installation. Just configure and make as
 104 shown previously. This will create the scripts ntfs-3g and lowntfs-3g
 105 in the src directory, which you may activate for testing :
 106
 107         ./configure
 108         make
 109
 110 then, as root :
 111         src/ntfs-3g [-o mount-options] /dev/sda1 /mnt/windows
 112
 113 And, to end the test, unmount the usual way :
 114         umount /dev/sda1
 115
 116
 117 NTFS UTILITIES
 118 ==============
 119
 120 The ntfsprogs includes utilities for doing all required tasks to NTFS
 121 partitions.  In general, just run a utility without any command line
 122 options to display the version number and usage syntax.
 123
 124 The following utilities are so far implemented:
 125
 126 ntfsfix - Attempt to fix an NTFS partition and force Windows to check NTFS.
 127
 128 mkntfs - Format a partition with the NTFS filesystem.  See man 8 mkntfs for
 129 command line options.
 130
 131 ntfslabel - Display/change the label of an NTFS partition.  See man 8 ntfslabel
 132 for details.
 133
 134 ntfsundelete - Recover deleted files from an NTFS volume.  See man 8
 135 ntfsundelete for more details.
 136
 137 ntfsresize - Resize NTFS volumes.  See man 8 ntfsresize for details.
 138
 139 ntfsclone - Efficiently create/restore an image of an NTFS partition.  See
 140 man 8 ntfsclone for details.
 141
 142 ntfscluster - Locate the owner of any given sector or cluster on an NTFS
 143 partition.  See man 8 ntfscluster for details.
 144
 145 ntfsinfo - Show some information about an NTFS partition or one of the files
 146 or directories within it.  See man 8 ntfsinfo for details.
 147
 148 ntfsls - List information about files in a directory residing on an NTFS
 149 partition.  See man 8 ntfsls for details.
 150
 151 ntfscat - Concatenate files and print their contents on the standard output.
 152
 153 ntfscp - Overwrite files on an NTFS partition.