project/captive/man/captive.pod.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <title>captive - Microsoft Windows NT kernel emulation for NTFS disk access</title>
   5 <link rev="made" href="mailto:root@localhost" />
   6 </head>
   7
   8 <body style="background-color: white">
   9
  10 <p><a name="__index__"></a></p>
  11 <!-- INDEX BEGIN -->
  12
  13 <ul>
  14
  15         <li><a href="#name">NAME</a></li>
  16         <li><a href="#description">DESCRIPTION</a></li>
  17         <li><a href="#options">OPTIONS</a></li>
  18         <li><a href="#see_also">SEE ALSO</a></li>
  19         <li><a href="#author">AUTHOR</a></li>
  20 </ul>
  21 <!-- INDEX END -->
  22
  23 <hr />
  24 <p>
  25 </p>
  26 <h1><a name="name">NAME</a></h1>
  27 <p>captive - Microsoft Windows NT kernel emulation for NTFS disk access</p>
  28 <p>
  29 </p>
  30 <hr />
  31 <h1><a name="description">DESCRIPTION</a></h1>
  32 <p><strong>captive</strong>(7) library allows applications running under the <strong>GNU/Linux</strong>
  33 operating system to access <strong>NTFS</strong> drives. File system driver compatibility
  34 with <strong>VFAT</strong>, <strong>ISO9660</strong> and <strong>EXT2</strong> is also provided.</p>
  35 <p>This man page <strong>captive</strong>(7) show the common options of all <strong>captive</strong>
  36 clients. You will always use a specific client such as
  37 <strong>mount.captive</strong>(8) or <strong>captive-cmdline</strong>(1).</p>
  38 <p>
  39 </p>
  40 <hr />
  41 <h1><a name="options">OPTIONS</a></h1>
  42 <p>All programs using <strong>captive</strong>(7) library share the common set of configuration
  43 options:</p>
  44 <dl>
  45 <dt><strong><a name="item_%2d%2dfilesystem%3dpathname"><strong>--filesystem</strong>=<strong>pathname</strong></a></strong><br />
  46 </dt>
  47 <dd>
  48 Pathname to <strong>.sys</strong> or <strong>.so</strong> filesystem module file. You will use exactly
  49 once this option. Possible choices are
  50 <strong>/var/lib/captive/ntfs.sys</strong>
  51 etc.
  52 </dd>
  53 <p></p>
  54 <dt><strong><a name="item_%2d%2dload%2dmodule%3dpathname"><strong>--load-module</strong>=<strong>pathname</strong></a></strong><br />
  55 </dt>
  56 <dd>
  57 Pathname to any W32 module to load w/o initialization. Multiple modules can be
  58 loaded although in common case you will use just
  59 <strong>/var/lib/captive/ntoskrnl.exe</strong>
  60 here.
  61 </dd>
  62 <p></p>
  63 <dt><strong><a name="item_%2d%2dro"><strong>--ro</strong></a></strong><br />
  64 </dt>
  65 <dd>
  66 Read/write mode: Any write access will be forbidden. You should set this mode
  67 for <strong>cdfs.sys</strong> (<em>CD-ROM</em> filesystem). This option is mutually exclusive with
  68 <strong>--blind</strong> and <strong>--rw</strong>.
  69 </dd>
  70 <p></p>
  71 <dt><strong><a name="item_%2d%2dblind"><strong>--blind</strong></a></strong><br />
  72 </dt>
  73 <dd>
  74 Read/write mode: All writes are just simulated in memory (default). Microsoft
  75 Windows filesystem driver will see no difference between <strong>--blind</strong> and <strong>--rw</strong>
  76 although the UNIX image file/device will be open read/only as for <strong>--ro</strong>.
  77 All the changes get 'written' as long as <strong>captive</strong>(7) program runs - all the
  78 changes will be lost afterwards. This mode is the most suitable for debugging.
  79 This option is mutually exclusive with <strong>--ro</strong> and <strong>--rw</strong>.
  80 </dd>
  81 <p></p>
  82 <dt><strong><a name="item_%2d%2drw"><strong>--rw</strong></a></strong><br />
  83 </dt>
  84 <dd>
  85 Read/write mode: Write directly to the image file/device. Standard read/write
  86 disk mode. You should use <strong>--sandbox-server</strong> option in this case to have the
  87 disk protected against Microsoft Windows filesystem driver crashes. Modified
  88 disk image blocks are in <strong>--sandbox-server</strong> <strong>--rw</strong> mode buffered in the
  89 memory and they get reflected to the disk only after successful completion
  90 of all filesystem operations including filesystem unmount.
  91 This option is mutually exclusive with <strong>--ro</strong> and <strong>--blind</strong>.
  92 </dd>
  93 <p></p>
  94 <dt><strong><a name="item_%2d%2dcdrom"><strong>--cdrom</strong></a></strong><br />
  95 </dt>
  96 <dd>
  97 Media type: CD-ROM. You must set this media type for <strong>cdfs.sys</strong>.
  98 Virtual Microsoft Windows block device driver used by Captive maps to
  99 <strong>\Device\CdRom0</strong>. This option is mutually exclusive with <strong>--disk</strong>.
 100 </dd>
 101 <p></p>
 102 <dt><strong><a name="item_%2d%2ddisk"><strong>--disk</strong></a></strong><br />
 103 </dt>
 104 <dd>
 105 Media type: Disk (default). You must set this media type for all the Microsoft
 106 Windows filesystem drivers except <strong>cdfs.sys</strong>. Virtual Microsoft Windows block
 107 device driver used by Captive maps to <strong>\Device\CaptiveHarddisk0</strong>.
 108 This option is mutually exclusive with <strong>--cdrom</strong>.
 109 </dd>
 110 <p></p>
 111 <dt><strong><a name="item_%2d%2ddebug%2dmessages"><strong>--debug-messages</strong></a></strong><br />
 112 </dt>
 113 <dd>
 114 Turn on debugging messages. Be prepared for substation debug output.
 115 Use of <strong>--syslog</strong> feature is not recommended in this case.
 116 </dd>
 117 <p></p>
 118 <dt><strong><a name="item_%2d%2dsandbox%2dserver%3dpathname"><strong>--sandbox-server</strong>=<strong>pathname</strong></a></strong><br />
 119 </dt>
 120 <dd>
 121 Pathname to
 122 <strong>/usr/sbin/captive-sandbox-server</strong>
 123 program, turns on sandboxing.
 124 You should always use this option in conjunction with <strong>--rw</strong>, see it for
 125 details. Although this program is <em>setuid root</em> and it drops it privileges
 126 to <strong>@CAPTIVE_SANDBOX_SETUID@</strong> user. Your system gets protected by
 127 <strong>chroot</strong>(2), <strong>setuid</strong>(2), <strong>setgid</strong>(2) and <strong>setrlimit</strong>(2) UNIX security
 128 features against malicious Microsoft Windows drivers. You should never use this
 129 option during debugging.
 130 </dd>
 131 <dd>
 132 <p>This option is turned on automatically during the mount operation by
 133 <strong>mount.captive-ntfs</strong>(8).
 134 Option needs to be used by hand for the <strong>captive-cmdline</strong>(2) client.</p>
 135 </dd>
 136 <p></p>
 137 <dt><strong><a name="item_%2d%2dsandbox%2dserver%2dior%3dior"><strong>--sandbox-server-ior</strong>=<strong>IOR</strong></a></strong><br />
 138 </dt>
 139 <dd>
 140 Specify <em>CORBA IOR</em> of
 141 <strong>/usr/sbin/captive-sandbox-server</strong>
 142 program, turns on
 143 sandboxing. Specified <em>CORBA IOR</em> should be the string starting by ``<strong>IOR:</strong>''
 144 text. This option is useful only for debugging. No sandbox restarting is
 145 possible in this case.
 146 </dd>
 147 <p></p>
 148 <dt><strong><a name="item_%2d%2dno%2dsandbox"><strong>--no-sandbox</strong></a></strong><br />
 149 </dt>
 150 <dd>
 151 Turn off sandboxing feature (default). No
 152 <strong>/usr/sbin/captive-sandbox-server</strong>
 153 is run. Microsoft Windows filesystem driver is run in native UNIX environment
 154 without any <em>CORBA</em> separation. This option is recommended only for debugging.
 155 It is dangerous to use <strong>--rw</strong> together, see its description for the details.
 156 </dd>
 157 <p></p>
 158 <dt><strong><a name="item_%2d%2dbug%2dpathname%3dpathname"><strong>--bug-pathname</strong>=<strong>pathname</strong></a></strong><br />
 159 </dt>
 160 <dd>
 161 Pathname to <strong>strftime</strong>(3) for <strong>.captivebug.xml.gz</strong> bugreports. Every crash of
 162 sandbox child gets bugreported to the specified file. You should attempt to
 163 minimize the number of operations from the mount operation till the expected
 164 crash to minimize the snapshot file size. <strong>--sandbox-server</strong> option is
 165 required for <strong>--bug-pathname</strong>.
 166 </dd>
 167 <dd>
 168 <p><strong>!!! Be aware '.captivebug.xml.gz' will contain data from your disk drive !!!</strong></p>
 169 </dd>
 170 <p></p>
 171 <dt><strong><a name="item_%2d%2dsyslog"><strong>--syslog</strong></a></strong><br />
 172 </dt>
 173 <dd>
 174 Messages sent to <strong>syslog</strong>(3) instead of <em>stderr</em>. This option gets handy
 175 for <strong>mount</strong>(8) operation as the messages would be lost otherway.
 176 Watch our for possible ``<strong>Filesystem crash broke dirty object</strong>'' messages where
 177 some written filesystem data got lost in the case of Microsoft Windows
 178 filesystem driver crash.
 179 </dd>
 180 <p></p>
 181 <dt><strong><a name="item_%2d%2dsyslog%2dfacility%3dfacility"><strong>--syslog-facility</strong>=<strong>facility</strong></a></strong><br />
 182 </dt>
 183 <dd>
 184 <strong>openlog</strong>(3) facility for <strong>--syslog</strong>. See <strong>facility</strong> section of
 185 <strong>openlog</strong>(3) man page for details. Lowercased values such as <strong>daemon</strong> or
 186 <strong>user</strong> are supported.
 187 </dd>
 188 <p></p></dl>
 189 <p>
 190 </p>
 191 <hr />
 192 <h1><a name="see_also">SEE ALSO</a></h1>
 193 <p><strong>mount.captive</strong>(8), <strong>captive-cmdline</strong>(1), <strong>captive-install-acquire</strong>(1)</p>
 194 <p>
 195 </p>
 196 <hr />
 197 <h1><a name="author">AUTHOR</a></h1>
 198 <p><table cellspacing="0" cellpadding="0"><tr><td>Jan Kratochvil &lt;<strong><a href="mailto:project-captive@jankratochvil.net">project-captive@jankratochvil.net</a></strong>&gt;,
 199 <tr><td><td><em><a href="http://www.jankratochvil.net/">http://www.jankratochvil.net/</a></em></table></p>
 200
 201 </body>
 202
 203 </html>