Release: captive1 -> captive2cvs
[ntfsprogs.git] / README
1
2 Linux-NTFS
3 ==========
4
5 The Linux-NTFS project aims to bring full support for the NTFS filesystem to
6 the Linux operating system.
7
8 Linux-NTFS is copyright (c) 2000-2003 Anton Altaparmakov.
9
10 All of the contents of the Linux-NTFS project are free software, released under
11 the GNU General Public License and you are welcome to redistribute them under
12 certain conditions.
13 All the libraries and utilities come with ABSOLUTELY NO WARRANTY; for details
14 read the GNU General Public License to be found in the file COPYING in the main
15 Linux-NTFS distribution directory.
16  
17 Linux-NTFS currently consists of the NTFS library (libntfs) and utilities
18 (ntfsprogs). In the future it will also contain a new NTFS driver for the
19 Linux kernel.
20
21 The Linux-NTFS project is registered on Sourceforge.net. The home page for
22 Linux-NTFS is http://linux-ntfs.sf.net/ and the project page is:
23 http://sf.net/projects/linux-ntfs/
24
25 If you would like to take part in the development of Linux-NTFS, you are
26 invited to subscribe to the development mailing list,
27 linux-ntfs-dev@lists.sourceforge.net. The easiest way to do this is to visit
28 the list page on sourceforge at:
29         http://lists.sourceforge.net/lists/listinfo/linux-ntfs-dev
30
31 If you would like to be kept up to date about new releases and other Linux-NTFS
32 announcements, subscribe to the linux-ntfs-announce mailing list (very low
33 volume). The easiest way to do this is to visit the list page on sourceforge at:
34         http://lists.sourceforge.net/lists/listinfo/linux-ntfs-announce
35
36 NTFS library
37 ============
38
39 Provides common NTFS access functions to the ntfsprogs and other foreign
40 open source applications. Note, that the library is still under development and
41 a lot of functionality is not yet included.
42
43 NTFS utilities
44 ==============
45
46 The ntfsprogs will eventually include utilities for doing all required tasks
47 to NTFS partitions. In general, just run a utility without any command line
48 options to display the version number and usage syntax.
49
50 The following utilities are so far implemented:
51
52 NtfsFix - Attempt to fix an NTFS partition that has been damaged by the Linux
53 NTFS driver. Note that you should run it every time after you have used the old
54 Linux NTFS driver to write to an NTFS partition to prevent massive data
55 corruption from happening when Windows mounts the partition.
56 IMPORTANT: Run this only *after* unmounting the partition in Linux but *before*
57 rebooting into Windows NT/2000 or you *will* suffer! - You have been warned!
58 See man 8 ntfsfix for details.
59
60 mkntfs - Format a partition with the NTFS filesystem. See man 8 mkntfs for
61 command line options.
62
63 ntfslabel - Display/change the label of an NTFS partition. See man 8 ntfslabel
64 for details.
65
66 ntfsundelete - Recover deleted files from an NTFS volume. See man 8
67 ntfsundelete for more details.
68
69 ntfsresize - Resize NTFS volumes. See man 8 ntfsresize for details.
70