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