Simplified usecases description for 'captive-static' packaging.
authorshort <>
Thu, 27 Nov 2003 01:19:15 +0000 (01:19 +0000)
committershort <>
Thu, 27 Nov 2003 01:19:15 +0000 (01:19 +0000)
README

diff --git a/README b/README
index 6fb26d3..e19daad 100644 (file)
--- a/README
+++ b/README
@@ -24,10 +24,6 @@ http://www.jankratochvil.net/
 Overview
 --------
 
-'captive' is the base package. It contains debugging 'captive-cmdline' client.
-'captive-lufs' permits mounting NTFS as regular filesystem. It needs 'lufs'.
-'lufs' is a daemon to enable userland process to provide filesystem functions.
-
 Any errors from 'captive-lufs' are written to '/var/log/messages'.
 
 Needed drivers (at least ntoskrnl.exe+ntfs.sys) must be in '/var/lib/captive'.
@@ -53,68 +49,57 @@ Run captive-install-acquire(1) installer for proper guided steps.
 Packaged Installations
 ----------------------
 
-Case #1 - All packages installed:
-    captive-install - Acquire needed MS-Windows drivers and setup /etc/fstab.
-    captive-lufs - Linux Userland File System module to be native filesystem.
-    captive - Base package of this project.
-    lufs >=0.9.6-1captive - Linux Userland File System engine for captive-lufs.
-    gnome-vfs-httpcaptive - Gnome-VFS httpcaptive:// method for captive-install.
-    ntfsprogs >=200309071734 - Readonly NTFS to get drivers by captive-install.
-    ntfsprogs-gnomevfs - Gnome-VFS readonly NTFS access used by captive-install.
-
-  Required W32 drivers were automatically found if Microsoft Windows XP is
-  installed on any (mounted or unmounted) NTFS or (mounted) FAT partition.
-  You may want to run captive-install-acquire(1) to check the drivers state
-  and possibly update them. Installer uses X Windows or console automatically.
-
-  Any NTFS disk partitions were automatically added to /etc/fstab.
-  These partitions are now available for mount by
-    mount /mnt/captive-DISK_LABEL
-  such as (if the label is empty)
-    mount /mnt/captive-
+Required W32 drivers were automatically found if Microsoft Windows XP is
+installed on any NTFS or FAT partitions. FAT partitions must be already
+mounted. You may want to run captive-install-acquire(1) to check the drivers
+state and possibly update them. Installer uses X Windows or console
+automatically.
+
+Any NTFS disk partitions were automatically added to /etc/fstab.
+These partitions are now available for mount by
+  mount /mnt/captive-DISK_LABEL
+
+NTFS disk drives can be also mounted by
+  mkdir /mnt/drive-c
+  mount -t captive-ntfs /dev/hda1 /mnt/drive-c
+
+
+If you do not use the captive-install-acquire(1) installer you may also
+copy the drivers yourself - at least "ntoskrnl.exe" and "ntfs.sys".
+They should be stored in '/var/lib/captive' directory (lowercased filenames).
+These driver must be from Microsoft Windows XP while
+Service Pack 1 Check Build U.S. is their preferred version:
+  http://www.microsoft.com/WindowsXP/pro/downloads/servicepacks/sp1/checkedbuild.asp
+
+
+Command-line client access only:
+
+NTFS disk drives can be also accessed without Linux kernel support by:
+  captive-cmdline \
+          --load-module=/var/lib/captive/ntoskrnl.exe \
+          --filesystem=/var/lib/captive/ntfs.sys \
+          --sandbox-server=/usr/sbin/captive-sandbox-server \
+          --bug-pathname=/tmp/captive-bug-%FT%T.captivebug.xml.gz \
+          --disk --rw /dev/hda1
+  (Backslash end-of-line characters '\' to be omitted for line continuation.)
+
+In the case of 'sandbox' invocation error it can be also run directly but
+read/write (--rw) mode is definitely discouraged in such case:
+  captive-cmdline \
+          --load-module=/var/lib/captive/ntoskrnl.exe \
+          --filesystem=/var/lib/captive/ntfs.sys \
+          --disk --rw /dev/hda1
+  (Backslash end-of-line characters '\' to be omitted for line continuation.)
+
+
+Gnome-VFS aware applications can access NTFS disk drives by:
+  gnomevfs-info file:///dev/hda1#captive-ntfs:/config.sys
+  gnomevfs-copy file:///dev/hda1#captive-ntfs:/config.sys /tmp/
+You can replace 'captive-ntfs' by other supported methods, see:
+  /etc/gnome-vfs-2.0/modules/captive.conf
+
+(Gnome-VFS client is not contained in 'captive-static' package.)
 
-Case #2 - Packages without installer:
-    captive-lufs - Linux Userland File System module to be native filesystem.
-    captive - Base package of this project.
-    lufs >=0.9.6-1captive - Linux Userland File System engine for captive-lufs.
-
-  You must obtain W32 drivers - at least "ntoskrnl.exe" and "ntfs.sys".
-  They should be stored in '/var/lib/captive' directory (lowercased filenames).
-  These driver must be from Microsoft Windows XP;
-  Service Pack 1 Check Build U.S. preferred:
-    http://www.microsoft.com/WindowsXP/pro/downloads/servicepacks/sp1/checkedbuild.asp
-
-  NTFS disk drives can be mounted by
-    mkdir /mnt/drive-c
-    mount -t captive-ntfs /dev/hda1 /mnt/drive-c
-  
-Case #3 - Command-line client (or Gnome-VFS) access only:
-    captive - Base package of this project.
-
-  You must obtain W32 drivers - at least "ntoskrnl.exe" and "ntfs.sys".
-  They should be stored in '/var/lib/captive' directory (lowercased filenames).
-  These driver must be from Microsoft Windows XP;
-  Service Pack 1 Check Build U.S. preferred.
-    http://www.microsoft.com/WindowsXP/pro/downloads/servicepacks/sp1/checkedbuild.asp
-
-  NTFS disk drives can be accessed by:
-    captive-cmdline --load-module=/tmp/ntoskrnl.exe --filesystem=/tmp/ntfs.sys \
-            --sandbox-server=/usr/sbin/captive-sandbox-server \
-            --bug-pathname=/tmp/captive-bug-%FT%T.captivebug.xml.gz \
-            --disk --rw /dev/hda1
-    (Backslash end-of-line characters '\' to be omitted for line continuation.)
-
-  In the case of 'sandbox' invocation error you can also run directly but
-  read/write (--rw) mode is definitely discouraged in such case:
-    captive-cmdline --load-module=/tmp/ntoskrnl.exe --filesystem=/tmp/ntfs.sys \
-            --disk --rw /dev/hda1
-    (Backslash end-of-line characters '\' to be omitted for line continuation.)
-
-  Gnome-VFS aware applications can access NTFS disk drives by:
-    gnomevfs-info file:///dev/hda1#captive-ntfs:/config.sys
-    gnomevfs-copy file:///dev/hda1#captive-ntfs:/config.sys /tmp/
-  You can replace 'captive-ntfs' by other supported methods, see:
-    /etc/gnome-vfs-2.0/modules/captive.conf
 
 
 Source Installations
@@ -139,6 +124,7 @@ Later you may invoke standard:
   make install
 
 Manual addition of user and group 'captive' is required for '--sandbox-server':
+  groupadd captive
   useradd captive
 
 Both these steps will be suggested during 'make install' if appropriate:
@@ -220,10 +206,10 @@ drivers requirements. It should be now fully reliable for read/only operations.
 Read/write operations are supported only for rewriting existing data blocks of
 existing files - no file/directory create/delete operations possible.
 
-'captive-install' package of this project 'ntfsprogs' package of Linux-NTFS
-Project. This driver is very useful to obtain the original drivers from
-Microsoft Windows XP already installed on existing NTFS disk partition by
-'ntfsprogs' NTFS read/only access. 'ntfsprogs' are no longer used afterwards.
+'captive-install' package of this project uses 'Linux-NTFS' driver to obtain
+the original drivers from Microsoft Windows XP already installed on existing
+NTFS disk partition by 'ntfsprogs' NTFS read/only access. 'ntfsprogs' are no
+longer used afterwards.
 
 Although Linux-NTFS Project contains a lot of valuable reverse-engineering work
 it is completely separated effort from Captive project, no knowledge can be