+command "open": Open as[1] file[2] in mode; see 'open --help'.

[captive.git] / README

diff --git a/README b/README
index 055597d..6fb26d3 100644 (file)
--- a/README
+++ b/README
@@ -15,6 +15,26 @@ system to access NTFS drives. File system driver compatibility with VFAT,
 ISO9660 and EXT2 is also provided.
 
 
+Project Home
+------------
+
+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'.
+
+'captive' package creates 'captive' user and 'captive' group on your system.
+
+
 Drivers Availability
 --------------------
 
@@ -27,7 +47,7 @@ most by the Wine http://www.winehq.com/ project. Required driver files:
   ntoskrnl.exe - Windows NT kernel; required for ANY use of this project.
   ntfs.sys - NTFS filesystem driver; required to access NTFS disk drives.
 
-Run captive-install-aquire(1) installer for proper guided steps.
+Run captive-install-acquire(1) installer for proper guided steps.
 
 
 Packaged Installations
@@ -35,9 +55,9 @@ Packaged Installations
 
 Case #1 - All packages installed:
     captive-install - Acquire needed MS-Windows drivers and setup /etc/fstab.
-    captive-lufs - Linux User File System module driver to be native filesystem.
+    captive-lufs - Linux Userland File System module to be native filesystem.
     captive - Base package of this project.
-    lufs >=0.9.6-1captive - Linux User File System engine for captive-lufs.
+    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.
@@ -54,9 +74,9 @@ Case #1 - All packages installed:
     mount /mnt/captive-
 
 Case #2 - Packages without installer:
-    captive-lufs - Linux User File System module driver to be native filesystem.
+    captive-lufs - Linux Userland File System module to be native filesystem.
     captive - Base package of this project.
-    lufs >=0.9.6-1captive - Linux User File System engine for captive-lufs.
+    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).
@@ -118,13 +138,21 @@ Now you have './src/client/cmdline/captive-cmdline' available for testing.
 Later you may invoke standard:
   make install
 
+Manual addition of user and group 'captive' is required for '--sandbox-server':
+  useradd captive
+
+Both these steps will be suggested during 'make install' if appropriate:
+You may need to add '/usr/local/lib' line (without quotes) to your
+'/etc/ld.so.conf' file. You may also need to run as 'root' user:
+  ldconfig
+
 
 Bug Reporting
 -------------
 
 Captive produces its bugreports automatically in '/var/lib/captive' directory
 named by 'bug-yyyy-mm-ddThh:mm:ss.captivebug.xml.gz' template. Microsoft
-Windows subsystem emulation failures should be reproducable from this snapshot
+Windows subsystem emulation failures should be reproducible from this snapshot
 file. You should attempt to minimize the number of operations from the mount
 operation till the expected crash to minimize the snapshot file size.
 
@@ -136,9 +164,9 @@ CVS Bleeding Edge
 
 cvs -d :pserver:pserver@cvs.jankratochvil.net:/cvs login
     Just hit ENTER (empty password)
-cvs -d :pserver:pserver@cvs.jankratochvil.net:/cvs -z3 checkout -d captive priv/captive
+cvs -d :pserver:pserver@cvs.jankratochvil.net:/cvs -z3 checkout captive
 cd captive
-cvs -d :pserver:pserver@cvs.jankratochvil.net:/cvs -z3 checkout -d reactos -r captive -kk priv/reactos
+cvs -d :pserver:pserver@cvs.jankratochvil.net:/cvs -z3 checkout -r captive -kk reactos
 ./autogen.pl
 make
 ./src/client/cmdline/captive-cmdline --load-module=/var/lib/captive/ntoskrnl.exe --filesystem=/var/lib/captive/ntfs.sys --disk  --blind /dev/hda1
@@ -148,7 +176,7 @@ Files Overview
 --------------
 
 User:
-src/client/lufs - Linux User File System module to access NTFS as filesystem.
+src/client/lufs - Linux Userland File System module to access NTFS filesystem.
 src/client/sandbox-server - Security+safety wrapper of emulated W32 environment.
     Disable during debugging sessions.
 src/client/cmdline - Simple ftp(1)-like client.