(C) Paragon Software 2003

The NTFS for Linux Module provides full access to the NTFS File System.

I. System Requirements:

- Linux kernel version 2.2.x or 2.4.x
- Installed development tools (including binutils, GNU make, gcc, libraries)
- Headers of the run or executed kernel
- If directories "/usr/include/linux" and "/usr/include/asm" exist and they are
  not a symlinks, please, rename or delete they. Then create symlinks to directories in
  your kernel source:
  "ln -s /usr/src/linux/include/linux /usr/include/linux"
  "ln -s /usr/src/linux/include/asm /usr/include/asm"
  
  "/usr/src/linux/" in this commands is a directory with your kernel source or
  symlink to directory, containing your kernel.
  
ATTENTION: With the directories listed above (by default) you can't compile
           kernel module.

Restrictions:

- Unstable Kernels (2.3.x & 2.5.x) are not supported
- Module functionality is not guaranteed for modified kernels

II. Building and Installation

- Go to module directory containing sources and libraries for module building.
- Run "./install.sh." installation program. Use "--interactive" option to skip
  some installation steps or to get more info during the installation.

REMARK: It is possible to use unassisted mode (without installation program)
        for experienced users. You need to perform the following steps: 
     
        - Go to module directory containing sources and libraries for module
          building
        - Go to subdirectory "ifslinux"
        - Execute commands "make clean" and "make" (no error/undefined symbols
          messages should occur). As the result, ufsd.o file will be located in
          ./objfre and it does not need to be installed to the special location
        - Execute commands "make remove" and "make install" (no error/undefined
          symbols messages should occur)

III. Loading

If NTFS module is installed via installation program for RedHat and SuSE
compatible Linux it is not required to perform any steps for Module Loading as
it will be started automatically.

In other cases you need to perform the following steps:

  - Login as root
  - Go to module directory containing sources and libraries for module building
  - Go to subdirectory ifslinux
  - Execute commands "make load" (no error/undefined symbols messages should
    occur)
  - To check whether the loading copleted successfully, please, execute "lsmod"
    command.

IV. Unloading

- Unmount all NTFS partitions.
- Execute "rmmod ufsd" command . If module is used by the system (there are
  mounted NTFS drives), the message "Device or resource busy" will be displayed.

V. Uninstallation

- Go to module directory containing sources and libraries for module building.
- Run "./uninstall.sh." uninstallation script. Use "--interactive" option to
  skip some uninstallation steps or to get more info during uninstallation.

REMARK: It is possible to use unassisted mode (without uninstallation script)
        for experienced users. You need to perform the following steps:
     
        - Go to module directory containing sources and libraries for module
          building
        - Go to subdirectory "ifslinux"
        - Execute "make remove" and "make clean" commands  (no error/undefined
          symbols messages should occur)

VI. Usage and examples

- To provide the access of the NTFS partition use "mount" command with 
  filesystem type set to "ufsd".

Examples:

- Mounting of the NTFS partition:
   mount -t ufsd /dev/hda6 /mnt/test

- Change access mode to "readonly" for already mounted partition:
   mount -t ufsd /dev/hda6 /mnt/test -o remount,ro

- Unmount the partition of the mounted path:
   "umount /mnt/test"  

