From: short <>
Date: Mon, 6 Oct 2003 02:23:30 +0000 (+0000)
Subject: +man
X-Git-Url: https://git.jankratochvil.net/?p=www.jankratochvil.net.git;a=commitdiff_plain;h=574005723187e37293ed2896a7102c31169f1c2b
+man
---
diff --git a/project/captive/Index.html.pl b/project/captive/Index.html.pl
index 9c12190..cbdadf4 100755
--- a/project/captive/Index.html.pl
+++ b/project/captive/Index.html.pl
@@ -230,6 +230,7 @@ print <<"HERE";
available Microsoft Windows drivers versions. Now you can execute:
+ @{[
+ do {
+ my @mans=(
+ 'captive'=>[7,'Microsoft Windows NT kernel emulation for NTFS disk access'],
+ 'mount.captive'=>[8,'mount(8) interface for NTFS disk access'],
+ 'lufs-captivefs'=>[7,'Linux Userland File System module for NTFS as filesystem'],
+ 'captive-cmdline'=>[1,'Command-line client for captive(7) NTFS disk access'],
+ 'captive-sandbox-server'=>[1,'Security+safety wrapper for NTFS disk access'],
+ 'captive-install-acquire'=>[1,'Find MS Windows XP driver files for NTFS'],
+ 'captive-install-fstab'=>[1,'Manage captive-ntfs /etc/fstab entries'],
+ );
+ my @r;
+ while (@mans) {
+ my $file=shift @mans;
+ my($section,$name)=@{shift @mans};
+ push @r,"
+Pathname to .sys or .so filesystem module file. You will use exactly
+once this option. Possible choices are
+/usr/local/var/lib/captive/ntfs.sys
+etc.
+
+Pathname to any W32 module to load w/o initialization. Multiple modules can be
+loaded although in common case you will use just
+/usr/local/var/lib/captive/ntoskrnl.exe
+here.
+
+Read/write mode: Any write access will be forbidden. You should set this mode
+for cdfs.sys (CD-ROM filesystem). This option is mutually exclusive with
+--blind and --rw.
+
+Read/write mode: All writes are just simulated in memory (default). Microsoft
+Windows filesystem driver will see no difference between --blind and --rw
+although the UNIX image file/device will be open read/only as for --ro.
+All the changes get 'written' as long as captive(7) program runs - all the
+changes will be lost afterwards. This mode is the most suitable for debugging.
+This option is mutually exclusive with --ro and --rw.
+
+Read/write mode: Write directly to the image file/device. Standard read/write
+disk mode. You should use --sandbox-server option in this case to have the
+disk protected against Microsoft Windows filesystem driver crashes. Modified
+disk image blocks are in --sandbox-server--rw mode buffered in the
+memory and they get reflected to the disk only after successful completion
+of all filesystem operations including filesystem unmount.
+This option is mutually exclusive with --ro and --blind.
+
+Media type: CD-ROM. You must set this media type for cdfs.sys.
+Virtual Microsoft Windows block device driver used by Captive maps to
+\Device\CdRom0. This option is mutually exclusive with --disk.
+
+Media type: Disk (default). You must set this media type for all the Microsoft
+Windows filesystem drivers except cdfs.sys. Virtual Microsoft Windows block
+device driver used by Captive maps to \Device\CaptiveHarddisk0.
+This option is mutually exclusive with --cdrom.
+
+Pathname to
+/usr/local/sbin/captive-sandbox-server
+program, turns on sandboxing.
+You should always use this option in conjunction with --rw, see it for
+details. Although this program is setuid root and it drops it privileges
+to @CAPTIVE_SANDBOX_SETUID@ user. Your system gets protected by
+chroot(2), setuid(2), setgid(2) and setrlimit(2) UNIX security
+features against malicious Microsoft Windows drivers. You should never use this
+option during debugging.
+
+Specify CORBA IOR of
+/usr/local/sbin/captive-sandbox-server
+program, turns on
+sandboxing. Specified CORBA IOR should be the string starting by ``IOR:''
+text. This option is useful only for debugging. No sandbox restarting is
+possible in this case.
+
+Turn off sandboxing feature (default). No
+/usr/local/sbin/captive-sandbox-server
+is run. Microsoft Windows filesystem driver is run in native UNIX environment
+without any CORBA separation. This option is recommended only for debugging.
+It is dangerous to use --rw together, see its description for the details.
+
+Pathname to strftime(3) for .captivebug.xml.gz bugreports. Every crash of
+sandbox child gets bugreported to the specified file. You should attempt to
+minimize the number of operations from the mount operation till the expected
+crash to minimize the snapshot file size. --sandbox-server option is
+required for --bug-pathname.
+
+
+
!!! Be aware '.captivebug.xml.gz' will contain data from your disk drive !!!
+Messages sent to syslog(3) instead of stderr. This option gets handy
+for mount(8) operation as the messages would be lost otherway.
+Watch our for possible ``Filesystem crash broke dirty object'' messages where
+some written filesystem data got lost in the case of Microsoft Windows
+filesystem driver crash.
+
+openlog(3) facility for --syslog. See facility section of
+openlog(3) man page for details. Lowercased values such as daemon or
+user are supported.
+
Program acquires the needed Microsoft Windows XP driver files. Multiple
+methods of getting the driver files are supported. All the driver files are
+stored to the directory
+/usr/local/var/lib/captive/
+where they are
+expected by mount.captive(8).
Program will run interactively if no action options (--scan-disks,
+--scan-disks-quick, --scan-path or --microsoft-com) are specified.
+Otherwise the requested action(s) is proceeded in silent batch mode.
+Disable Gnome user interface even if X Window System is available.
+You must specify this option as the first one. This option has effect only for
+interactive mode (no action options specified).
+
+Path to .captivemodid.xml database (default:
+/usr/local/etc/w32-mod-id.captivemodid.xml). This file contains
+identifications (md5sum(1)) of known compatible Microsoft Windows XP
+driver files. captive-install-acquire(1) will ignore any files not
+identified by this file although you may try to copy them to
+/usr/local/var/lib/captive/
+manually for captive(7) clients.
+
+Scan all files on any local hard drive (mounted or unmounted) NTFS or
+(mounted) FAT partitions. This scanning includes cabinet (.cab)
+archives. This scanning can last for very long time.
+
+Reduced version of --scan-disks. Only windows/system32 subdirectory in
+the root of any local hard drive (mounted or unmounted) NTFS or (mounted)
+FAT partition is investigated. This scan should find existing driver files
+in already existing Microsoft Windows XP installations.
+
+Scan the specified path/URI for device driver files. You may use either
+filename (/tmp/ntoskrnl.ex_), directory (/tmp/servicepack.cab), NTFS
+disk file/directory (file:///dev/hda1#libntfs:/windows/system32) or remote
+URI filename (http://server/path/to/ntfs.sys). Remote URI directory
+(such as http://server/subdir/) is not supported.
+
+
+
Possibly specified directory is always scanned recursively.
Program will scan your local disk drive partitions (from /proc/partitions)
+and it will add/remove appropriate file-system type captive-ntfs entries
+in /etc/fstab.
+
Destination directory is chosen automatically as /mnt/captive-LABEL_NAME
+where LABEL_NAME is the label used for the NTFS partition. Directory
+/mnt/captive- may be used if no volume label is set. Different (numbered)
+directory name is used if multiple disks have the same volume label set.
Program implementing separation of emulated Microsoft Windows NT kernel
+environment from the rest of UNIX system. Your system gets protected by
+chroot(2), setuid(2), setgid(2) and setrlimit(2) UNIX security
+features against malicious Microsoft Windows drivers.
+
Use this program as argument of --sandbox-server option of captive(7).
+Do not use this option/program during captive(7) debugging.
captive(7) library allows applications running under the GNU/Linux
+operating system to access NTFS drives. File system driver compatibility
+with VFAT, ISO9660 and EXT2 is also provided.
+
This man page captive(7) show the common options of all captive
+clients. You will always use a specific client such as
+mount.captive(8) or captive-cmdline(1).
+Pathname to .sys or .so filesystem module file. You will use exactly
+once this option. Possible choices are
+/usr/local/var/lib/captive/ntfs.sys
+etc.
+
+Pathname to any W32 module to load w/o initialization. Multiple modules can be
+loaded although in common case you will use just
+/usr/local/var/lib/captive/ntoskrnl.exe
+here.
+
+Read/write mode: Any write access will be forbidden. You should set this mode
+for cdfs.sys (CD-ROM filesystem). This option is mutually exclusive with
+--blind and --rw.
+
+Read/write mode: All writes are just simulated in memory (default). Microsoft
+Windows filesystem driver will see no difference between --blind and --rw
+although the UNIX image file/device will be open read/only as for --ro.
+All the changes get 'written' as long as captive(7) program runs - all the
+changes will be lost afterwards. This mode is the most suitable for debugging.
+This option is mutually exclusive with --ro and --rw.
+
+Read/write mode: Write directly to the image file/device. Standard read/write
+disk mode. You should use --sandbox-server option in this case to have the
+disk protected against Microsoft Windows filesystem driver crashes. Modified
+disk image blocks are in --sandbox-server--rw mode buffered in the
+memory and they get reflected to the disk only after successful completion
+of all filesystem operations including filesystem unmount.
+This option is mutually exclusive with --ro and --blind.
+
+Media type: CD-ROM. You must set this media type for cdfs.sys.
+Virtual Microsoft Windows block device driver used by Captive maps to
+\Device\CdRom0. This option is mutually exclusive with --disk.
+
+Media type: Disk (default). You must set this media type for all the Microsoft
+Windows filesystem drivers except cdfs.sys. Virtual Microsoft Windows block
+device driver used by Captive maps to \Device\CaptiveHarddisk0.
+This option is mutually exclusive with --cdrom.
+
+Pathname to
+/usr/local/sbin/captive-sandbox-server
+program, turns on sandboxing.
+You should always use this option in conjunction with --rw, see it for
+details. Although this program is setuid root and it drops it privileges
+to @CAPTIVE_SANDBOX_SETUID@ user. Your system gets protected by
+chroot(2), setuid(2), setgid(2) and setrlimit(2) UNIX security
+features against malicious Microsoft Windows drivers. You should never use this
+option during debugging.
+
+Specify CORBA IOR of
+/usr/local/sbin/captive-sandbox-server
+program, turns on
+sandboxing. Specified CORBA IOR should be the string starting by ``IOR:''
+text. This option is useful only for debugging. No sandbox restarting is
+possible in this case.
+
+Turn off sandboxing feature (default). No
+/usr/local/sbin/captive-sandbox-server
+is run. Microsoft Windows filesystem driver is run in native UNIX environment
+without any CORBA separation. This option is recommended only for debugging.
+It is dangerous to use --rw together, see its description for the details.
+
+Pathname to strftime(3) for .captivebug.xml.gz bugreports. Every crash of
+sandbox child gets bugreported to the specified file. You should attempt to
+minimize the number of operations from the mount operation till the expected
+crash to minimize the snapshot file size. --sandbox-server option is
+required for --bug-pathname.
+
+
+
!!! Be aware '.captivebug.xml.gz' will contain data from your disk drive !!!
+Messages sent to syslog(3) instead of stderr. This option gets handy
+for mount(8) operation as the messages would be lost otherway.
+Watch our for possible ``Filesystem crash broke dirty object'' messages where
+some written filesystem data got lost in the case of Microsoft Windows
+filesystem driver crash.
+
+openlog(3) facility for --syslog. See facility section of
+openlog(3) man page for details. Lowercased values such as daemon or
+user are supported.
+
lufs-captivefs(7) module for Linux Userland File System (LUFS) enables
+GNU/Linux system to access NTFS drives by Microsoft Windows drivers in
+the most common way of kernel-level filesystem implementation.
+
{-c CHAN|--channels=CHAN} option of lufsmount(1) is respected
+although the final filesystem operations are always processed in single-channel
+mode. Do not set CHAN to 1 as it would invoke errors by LUFS kernel
+driver.
+Pathname to .sys or .so filesystem module file. You will use exactly
+once this option. Possible choices are
+/usr/local/var/lib/captive/ntfs.sys
+etc.
+
+Pathname to any W32 module to load w/o initialization. Multiple modules can be
+loaded although in common case you will use just
+/usr/local/var/lib/captive/ntoskrnl.exe
+here.
+
+Read/write mode: Any write access will be forbidden. You should set this mode
+for cdfs.sys (CD-ROM filesystem). This option is mutually exclusive with
+--blind and --rw.
+
+Read/write mode: All writes are just simulated in memory (default). Microsoft
+Windows filesystem driver will see no difference between --blind and --rw
+although the UNIX image file/device will be open read/only as for --ro.
+All the changes get 'written' as long as captive(7) program runs - all the
+changes will be lost afterwards. This mode is the most suitable for debugging.
+This option is mutually exclusive with --ro and --rw.
+
+Read/write mode: Write directly to the image file/device. Standard read/write
+disk mode. You should use --sandbox-server option in this case to have the
+disk protected against Microsoft Windows filesystem driver crashes. Modified
+disk image blocks are in --sandbox-server--rw mode buffered in the
+memory and they get reflected to the disk only after successful completion
+of all filesystem operations including filesystem unmount.
+This option is mutually exclusive with --ro and --blind.
+
+Media type: CD-ROM. You must set this media type for cdfs.sys.
+Virtual Microsoft Windows block device driver used by Captive maps to
+\Device\CdRom0. This option is mutually exclusive with --disk.
+
+Media type: Disk (default). You must set this media type for all the Microsoft
+Windows filesystem drivers except cdfs.sys. Virtual Microsoft Windows block
+device driver used by Captive maps to \Device\CaptiveHarddisk0.
+This option is mutually exclusive with --cdrom.
+
+Pathname to
+/usr/local/sbin/captive-sandbox-server
+program, turns on sandboxing.
+You should always use this option in conjunction with --rw, see it for
+details. Although this program is setuid root and it drops it privileges
+to @CAPTIVE_SANDBOX_SETUID@ user. Your system gets protected by
+chroot(2), setuid(2), setgid(2) and setrlimit(2) UNIX security
+features against malicious Microsoft Windows drivers. You should never use this
+option during debugging.
+
+Specify CORBA IOR of
+/usr/local/sbin/captive-sandbox-server
+program, turns on
+sandboxing. Specified CORBA IOR should be the string starting by ``IOR:''
+text. This option is useful only for debugging. No sandbox restarting is
+possible in this case.
+
+Turn off sandboxing feature (default). No
+/usr/local/sbin/captive-sandbox-server
+is run. Microsoft Windows filesystem driver is run in native UNIX environment
+without any CORBA separation. This option is recommended only for debugging.
+It is dangerous to use --rw together, see its description for the details.
+
+Pathname to strftime(3) for .captivebug.xml.gz bugreports. Every crash of
+sandbox child gets bugreported to the specified file. You should attempt to
+minimize the number of operations from the mount operation till the expected
+crash to minimize the snapshot file size. --sandbox-server option is
+required for --bug-pathname.
+
+
+
!!! Be aware '.captivebug.xml.gz' will contain data from your disk drive !!!
+Messages sent to syslog(3) instead of stderr. This option gets handy
+for mount(8) operation as the messages would be lost otherway.
+Watch our for possible ``Filesystem crash broke dirty object'' messages where
+some written filesystem data got lost in the case of Microsoft Windows
+filesystem driver crash.
+
+openlog(3) facility for --syslog. See facility section of
+openlog(3) man page for details. Lowercased values such as daemon or
+user are supported.
+
mount.captive(8) provides mount(8) interface to lufs-captivefs(7)
+by calling lufsmount(1) with appropriate arguments. You should never call
+this command directly - use mount(8) instead.
+
mount.captive(8) (captive filesystem type) is never used - this command
+is provided just as a base mount(8) interface to captive(7). You must always
+use captive-fstype filesystem type such as captive-ntfs. Other supported
+filesystem types are:
+ntfs, fastfat, cdfs, ext2fsd
+Pathname such as /dev/hda1 or /tmp/ntfs.bin. You should refer to the
+partition name, not the whole device (/dev/hda is forbidden).
+/dev/hda1 may correspond to /dev/ide/host0/bus0/target0/lun0/part1
+on your system.
+
+Custom options passed to captive(7). See its manpage for details. Options
+double-dashes (--) can be omitted for lufs-captivefs(7) or
+mount.captive(8).
+