--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>captive - Microsoft Windows NT kernel emulation for NTFS disk access</title>
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+<p><a name="__index__"></a></p>
+<!-- INDEX BEGIN -->
+
+<ul>
+
+ <li><a href="#name">NAME</a></li>
+ <li><a href="#description">DESCRIPTION</a></li>
+ <li><a href="#options">OPTIONS</a></li>
+ <li><a href="#see_also">SEE ALSO</a></li>
+ <li><a href="#author">AUTHOR</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>captive - Microsoft Windows NT kernel emulation for NTFS disk access</p>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p><strong>captive</strong>(7) library allows applications running under the <strong>GNU/Linux</strong>
+operating system to access <strong>NTFS</strong> drives. File system driver compatibility
+with <strong>VFAT</strong>, <strong>ISO9660</strong> and <strong>EXT2</strong> is also provided.</p>
+<p>This man page <strong>captive</strong>(7) show the common options of all <strong>captive</strong>
+clients. You will always use a specific client such as
+<strong>mount.captive</strong>(8) or <strong>captive-cmdline</strong>(1).</p>
+<p>
+</p>
+<hr />
+<h1><a name="options">OPTIONS</a></h1>
+<p>All programs using <strong>captive</strong>(7) library share the common set of configuration
+options:</p>
+<dl>
+<dt><strong><a name="item_%2d%2dfilesystem%3dpathname"><strong>--filesystem</strong>=<strong>pathname</strong></a></strong><br />
+</dt>
+<dd>
+Pathname to <strong>.sys</strong> or <strong>.so</strong> filesystem module file. You will use exactly
+once this option. Possible choices are
+<strong>/usr/local/var/lib/captive/ntfs.sys</strong>
+etc.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2dload%2dmodule%3dpathname"><strong>--load-module</strong>=<strong>pathname</strong></a></strong><br />
+</dt>
+<dd>
+Pathname to any W32 module to load w/o initialization. Multiple modules can be
+loaded although in common case you will use just
+<strong>/usr/local/var/lib/captive/ntoskrnl.exe</strong>
+here.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2dro"><strong>--ro</strong></a></strong><br />
+</dt>
+<dd>
+Read/write mode: Any write access will be forbidden. You should set this mode
+for <strong>cdfs.sys</strong> (<em>CD-ROM</em> filesystem). This option is mutually exclusive with
+<strong>--blind</strong> and <strong>--rw</strong>.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2dblind"><strong>--blind</strong></a></strong><br />
+</dt>
+<dd>
+Read/write mode: All writes are just simulated in memory (default). Microsoft
+Windows filesystem driver will see no difference between <strong>--blind</strong> and <strong>--rw</strong>
+although the UNIX image file/device will be open read/only as for <strong>--ro</strong>.
+All the changes get 'written' as long as <strong>captive</strong>(7) program runs - all the
+changes will be lost afterwards. This mode is the most suitable for debugging.
+This option is mutually exclusive with <strong>--ro</strong> and <strong>--rw</strong>.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2drw"><strong>--rw</strong></a></strong><br />
+</dt>
+<dd>
+Read/write mode: Write directly to the image file/device. Standard read/write
+disk mode. You should use <strong>--sandbox-server</strong> option in this case to have the
+disk protected against Microsoft Windows filesystem driver crashes. Modified
+disk image blocks are in <strong>--sandbox-server</strong> <strong>--rw</strong> 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 <strong>--ro</strong> and <strong>--blind</strong>.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2dcdrom"><strong>--cdrom</strong></a></strong><br />
+</dt>
+<dd>
+Media type: CD-ROM. You must set this media type for <strong>cdfs.sys</strong>.
+Virtual Microsoft Windows block device driver used by Captive maps to
+<strong>\Device\CdRom0</strong>. This option is mutually exclusive with <strong>--disk</strong>.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2ddisk"><strong>--disk</strong></a></strong><br />
+</dt>
+<dd>
+Media type: Disk (default). You must set this media type for all the Microsoft
+Windows filesystem drivers except <strong>cdfs.sys</strong>. Virtual Microsoft Windows block
+device driver used by Captive maps to <strong>\Device\CaptiveHarddisk0</strong>.
+This option is mutually exclusive with <strong>--cdrom</strong>.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2ddebug%2dmessages"><strong>--debug-messages</strong></a></strong><br />
+</dt>
+<dd>
+Turn on debugging messages. Be prepared for substation debug output.
+Use of <strong>--syslog</strong> feature is not recommended in this case.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2dsandbox%2dserver%3dpathname"><strong>--sandbox-server</strong>=<strong>pathname</strong></a></strong><br />
+</dt>
+<dd>
+Pathname to
+<strong>/usr/local/sbin/captive-sandbox-server</strong>
+program, turns on sandboxing.
+You should always use this option in conjunction with <strong>--rw</strong>, see it for
+details. Although this program is <em>setuid root</em> and it drops it privileges
+to <strong>@CAPTIVE_SANDBOX_SETUID@</strong> user. Your system gets protected by
+<strong>chroot</strong>(2), <strong>setuid</strong>(2), <strong>setgid</strong>(2) and <strong>setrlimit</strong>(2) UNIX security
+features against malicious Microsoft Windows drivers. You should never use this
+option during debugging.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2dsandbox%2dserver%2dior%3dior"><strong>--sandbox-server-ior</strong>=<strong>IOR</strong></a></strong><br />
+</dt>
+<dd>
+Specify <em>CORBA IOR</em> of
+<strong>/usr/local/sbin/captive-sandbox-server</strong>
+program, turns on
+sandboxing. Specified <em>CORBA IOR</em> should be the string starting by ``<strong>IOR:</strong>''
+text. This option is useful only for debugging. No sandbox restarting is
+possible in this case.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2dno%2dsandbox"><strong>--no-sandbox</strong></a></strong><br />
+</dt>
+<dd>
+Turn off sandboxing feature (default). No
+<strong>/usr/local/sbin/captive-sandbox-server</strong>
+is run. Microsoft Windows filesystem driver is run in native UNIX environment
+without any <em>CORBA</em> separation. This option is recommended only for debugging.
+It is dangerous to use <strong>--rw</strong> together, see its description for the details.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2dbug%2dpathname%3dpathname"><strong>--bug-pathname</strong>=<strong>pathname</strong></a></strong><br />
+</dt>
+<dd>
+Pathname to <strong>strftime</strong>(3) for <strong>.captivebug.xml.gz</strong> 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. <strong>--sandbox-server</strong> option is
+required for <strong>--bug-pathname</strong>.
+</dd>
+<dd>
+<p><strong>!!! Be aware '.captivebug.xml.gz' will contain data from your disk drive !!!</strong></p>
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2dsyslog"><strong>--syslog</strong></a></strong><br />
+</dt>
+<dd>
+Messages sent to <strong>syslog</strong>(3) instead of <em>stderr</em>. This option gets handy
+for <strong>mount</strong>(8) operation as the messages would be lost otherway.
+Watch our for possible ``<strong>Filesystem crash broke dirty object</strong>'' messages where
+some written filesystem data got lost in the case of Microsoft Windows
+filesystem driver crash.
+</dd>
+<p></p>
+<dt><strong><a name="item_%2d%2dsyslog%2dfacility%3dfacility"><strong>--syslog-facility</strong>=<strong>facility</strong></a></strong><br />
+</dt>
+<dd>
+<strong>openlog</strong>(3) facility for <strong>--syslog</strong>. See <strong>facility</strong> section of
+<strong>openlog</strong>(3) man page for details. Lowercased values such as <strong>daemon</strong> or
+<strong>user</strong> are supported.
+</dd>
+<p></p></dl>
+<p>
+</p>
+<hr />
+<h1><a name="see_also">SEE ALSO</a></h1>
+<p><strong>mount.captive</strong>(8), <strong>captive-cmdline</strong>(1), <strong>captive-install-acquire</strong>(1)</p>
+<p>
+</p>
+<hr />
+<h1><a name="author">AUTHOR</a></h1>
+<p><table cellspacing="0" cellpadding="0"><tr><td>Jan Kratochvil <<strong><a href="mailto:project-captive@jankratochvil.net">project-captive@jankratochvil.net</a></strong>>,
+<tr><td><td><em><a href="http://www.jankratochvil.net/">http://www.jankratochvil.net/</a></em></table></p>
+
+</body>
+
+</html>
git://git.jankratochvil.net / www.jankratochvil.net.git / blobdiff