project/captive/man/mount.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>mount.captive - B&lt;mount&gt; interface 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="#synopsis">SYNOPSIS</a></li>
  15         <li><a href="#description">DESCRIPTION</a></li>
  16         <li><a href="#options">OPTIONS</a></li>
  17         <li><a href="#see_also">SEE ALSO</a></li>
  18         <li><a href="#author">AUTHOR</a></li>
  19 </ul>
  20 <!-- INDEX END -->
  21
  22 <hr />
  23 <p>
  24 </p>
  25 <h1><a name="name">NAME</a></h1>
  26 <p>mount.captive - <strong>mount</strong>(8) interface for NTFS disk access</p>
  27 <p>
  28 </p>
  29 <hr />
  30 <h1><a name="synopsis">SYNOPSIS</a></h1>
  31 <p><strong>mount.captive-ntfs</strong> {<strong>image-file</strong>|<strong>device</strong>} <strong>mountdir</strong>
  32 [<strong>-n</strong>] [<strong>-v</strong>] [<strong>-o</strong> <strong>options</strong>]</p>
  33 <p><strong>mount</strong> <strong>-t</strong> <strong>captive-ntfs</strong>
  34 [<strong>-n</strong>] [<strong>-v</strong>] [<strong>-o</strong> <strong>options</strong>]
  35 {<strong>image-file</strong>|<strong>device</strong>} <strong>dir</strong></p>
  36 <p>
  37 </p>
  38 <hr />
  39 <h1><a name="description">DESCRIPTION</a></h1>
  40 <p><strong>mount.captive</strong>(8) provides <strong>mount</strong>(8) interface to <strong>captive</strong>(7) library
  41 You should never call this command directly - use <strong>mount</strong>(8) instead.</p>
  42 <p><strong>mount.captive</strong>(8) (<strong>captive</strong> filesystem type) is never used - this command
  43 is provided just as a base <code>mount(8)</code> interface to <strong>captive</strong>(7). You must always
  44 use captive-<strong>fstype</strong> filesystem type such as <strong>captive-ntfs</strong>. Other supported
  45 filesystem types are:
  46 <strong>ntfs</strong>, <strong>fastfat</strong>, <strong>cdfs</strong>, <strong>ext2fsd</strong></p>
  47 <p>
  48 </p>
  49 <hr />
  50 <h1><a name="options">OPTIONS</a></h1>
  51 <dl>
  52 <dt><strong><a name="item__7bimage_2dfile_7cdevice_7d">{<strong>image-file</strong>|<strong>device</strong>}</a></strong></dt>
  53
  54 <dd>
  55 <p>Pathname such as <strong>/dev/hda1</strong> or <strong>/tmp/ntfs.bin</strong>. You should refer to the
  56 partition name, not the whole device (<strong>/dev/hda</strong> is forbidden).
  57 <strong>/dev/hda1</strong> may correspond to <strong>/dev/ide/host0/bus0/target0/lun0/part1</strong>
  58 on your system.</p>
  59 </dd>
  60 <dt><strong><a name="item_mountdir"><strong>mountdir</strong></a></strong></dt>
  61
  62 <dd>
  63 <p>Existing empty target directory where {<strong>image-file</strong>|<strong>device</strong>} will be
  64 mounted.</p>
  65 </dd>
  66 <dt><strong><a name="item__2dn"><strong>-n</strong></a></strong></dt>
  67
  68 <dd>
  69 <p>No effect. The standard functionality of 'do not modify <strong>/etc/mtab</strong>' is not
  70 supported - <strong>/etc/mtab</strong> is always modified.</p>
  71 </dd>
  72 <dt><strong><a name="item__2dv"><strong>-v</strong></a></strong></dt>
  73
  74 <dd>
  75 <p>No effect. The standard functionality of 'verbose mode' is not supported.</p>
  76 </dd>
  77 <dt><strong><a name="item__2do_options"><strong>-o</strong> <strong>options</strong></a></strong></dt>
  78
  79 <dd>
  80 <p>Custom options passed to <strong>captive</strong>(7) separated by comma (<strong>,</strong>).</p>
  81 </dd>
  82 <dd>
  83 <p>Options without double-dashes (<strong>--</strong>) will be used for FUSE, please
  84 see their description in the section ``<strong>Mount options</strong>'' of your local
  85 <strong>/usr/share/doc/fuse/README</strong> or the online:
  86 <a href="http://cvs.sourceforge.net/viewcvs.py/fuse/fuse/README?rev=HEAD">http://cvs.sourceforge.net/viewcvs.py/fuse/fuse/README</a></p>
  87 </dd>
  88 <dd>
  89 <p>Options prefixed by double-dashes (<strong>--</strong>) are used for libcaptive, the
  90 options list:</p>
  91 </dd>
  92 <dl>
  93 <dt><strong><a name="item__2d_2dfilesystem_3dpathname"><strong>--filesystem</strong>=<strong>pathname</strong></a></strong></dt>
  94
  95 <dd>
  96 <p>Pathname to <strong>.sys</strong> or <strong>.so</strong> filesystem module file. You will use exactly
  97 once this option. Possible choices are
  98 <strong>/usr/local/var/lib/captive/ntfs.sys</strong>
  99 etc.</p>
 100 </dd>
 101 <dt><strong><a name="item__2d_2dload_2dmodule_3dpathname"><strong>--load-module</strong>=<strong>pathname</strong></a></strong></dt>
 102
 103 <dd>
 104 <p>Pathname to any W32 module to load w/o initialization. Multiple modules can be
 105 loaded although in common case you will use just
 106 <strong>/usr/local/var/lib/captive/ntoskrnl.exe</strong>
 107 here.</p>
 108 </dd>
 109 <dt><strong><a name="item__2d_2dmodid_2dpath_3dpathname"><strong>--modid-path</strong>=<strong>pathname</strong></a></strong></dt>
 110
 111 <dd>
 112 <p>Pathname to the <strong>.captivemodid.xml</strong> database of existing W32 module
 113 identifications. The default used one is:
 114 <strong>/usr/local/etc/w32-mod-id.captivemodid.xml</strong>
 115 You must have this database update for any W32 binary module you are using.
 116 If you miss such database you may also try to use <strong>--load-untested</strong> below.</p>
 117 </dd>
 118 <dt><strong><a name="item__2d_2dload_2duntested"><strong>--load-untested</strong></a></strong></dt>
 119
 120 <dd>
 121 <p>Load tthe W32 modules despite they may not match the current <strong>--modid-path</strong>
 122 identifications database. If you use this option Captive may fail very easily
 123 as such module was never tested before the release and may need some
 124 compatibility updates. Still no data should be corrupted even if using this
 125 <strong>--load-untested</strong> option.</p>
 126 </dd>
 127 <dt><strong><a name="item__2d_2dro"><strong>--ro</strong></a></strong></dt>
 128
 129 <dd>
 130 <p>Read/write mode: Any write access will be forbidden. You should set this mode
 131 for <strong>cdfs.sys</strong> (<em>CD-ROM</em> filesystem). This option is mutually exclusive with
 132 <strong>--blind</strong> and <strong>--rw</strong>.</p>
 133 </dd>
 134 <dt><strong><a name="item__2d_2dblind"><strong>--blind</strong></a></strong></dt>
 135
 136 <dd>
 137 <p>Read/write mode: All writes are just simulated in memory (default). Microsoft
 138 Windows filesystem driver will see no difference between <strong>--blind</strong> and <strong>--rw</strong>
 139 although the UNIX image file/device will be open read/only as for <strong>--ro</strong>.
 140 All the changes get 'written' as long as <strong>captive</strong>(7) program runs - all the
 141 changes will be lost afterwards. This mode is the most suitable for debugging.
 142 This option is mutually exclusive with <strong>--ro</strong> and <strong>--rw</strong>.</p>
 143 </dd>
 144 <dt><strong><a name="item__2d_2drw"><strong>--rw</strong></a></strong></dt>
 145
 146 <dd>
 147 <p>Read/write mode: Write directly to the image file/device. Standard read/write
 148 disk mode. You should use <strong>--sandbox-server</strong> option in this case to have the
 149 disk protected against Microsoft Windows filesystem driver crashes. Modified
 150 disk image blocks are in <strong>--sandbox-server</strong> <strong>--rw</strong> mode buffered in the
 151 memory and they get reflected to the disk only after successful completion
 152 of all filesystem operations including filesystem unmount.
 153 This option is mutually exclusive with <strong>--ro</strong> and <strong>--blind</strong>.</p>
 154 </dd>
 155 <dt><strong><a name="item__2d_2dcdrom"><strong>--cdrom</strong></a></strong></dt>
 156
 157 <dd>
 158 <p>Media type: CD-ROM. You must set this media type for <strong>cdfs.sys</strong>.
 159 Virtual Microsoft Windows block device driver used by Captive maps to
 160 <strong>\Device\CdRom0</strong>. This option is mutually exclusive with <strong>--disk</strong>.</p>
 161 </dd>
 162 <dt><strong><a name="item__2d_2ddisk"><strong>--disk</strong></a></strong></dt>
 163
 164 <dd>
 165 <p>Media type: Disk (default). You must set this media type for all the Microsoft
 166 Windows filesystem drivers except <strong>cdfs.sys</strong>. Virtual Microsoft Windows block
 167 device driver used by Captive maps to <strong>\Device\CaptiveHarddisk0</strong>.
 168 This option is mutually exclusive with <strong>--cdrom</strong>.</p>
 169 </dd>
 170 <dt><strong><a name="item__2d_2ddebug_2dmessages"><strong>--debug-messages</strong></a></strong></dt>
 171
 172 <dd>
 173 <p>Turn on debugging messages. Be prepared for substation debug output.
 174 Use of <strong>--syslog</strong> feature is not recommended in this case.</p>
 175 </dd>
 176 <dt><strong><a name="item__2d_2dsandbox_2dserver_3dpathname"><strong>--sandbox-server</strong>=<strong>pathname</strong></a></strong></dt>
 177
 178 <dd>
 179 <p>Pathname to
 180 <strong>/usr/local/sbin/captive-sandbox-server</strong>
 181 program, turns on sandboxing.
 182 You should always use this option in conjunction with <strong>--rw</strong>, see it for
 183 details. Although this program is <em>setuid root</em> and it drops it privileges
 184 to <strong>captive</strong> user. Your system gets protected by
 185 <strong>chroot</strong>(2), <strong>setuid</strong>(2), <strong>setgid</strong>(2) and <strong>setrlimit</strong>(2) UNIX security
 186 features against malicious Microsoft Windows drivers. You should never use this
 187 option during debugging.</p>
 188 </dd>
 189 <dd>
 190 <p>This option is turned on automatically during the mount operation by
 191 <strong>mount.captive-ntfs</strong>(8).
 192 Option needs to be used by hand for the <strong>captive-cmdline</strong>(2) client.</p>
 193 </dd>
 194 <dt><strong><a name="item__2d_2dsandbox_2dserver_2dior_3dior"><strong>--sandbox-server-ior</strong>=<strong>IOR</strong></a></strong></dt>
 195
 196 <dd>
 197 <p>Specify <em>CORBA IOR</em> of
 198 <strong>/usr/local/sbin/captive-sandbox-server</strong>
 199 program, turns on
 200 sandboxing. Specified <em>CORBA IOR</em> should be the string starting by ``<strong>IOR:</strong>''
 201 text. This option is useful only for debugging. No sandbox restarting is
 202 possible in this case.</p>
 203 </dd>
 204 <dt><strong><a name="item__2d_2dno_2dsandbox"><strong>--no-sandbox</strong></a></strong></dt>
 205
 206 <dd>
 207 <p>Turn off sandboxing feature (default). No
 208 <strong>/usr/local/sbin/captive-sandbox-server</strong>
 209 is run. Microsoft Windows filesystem driver is run in native UNIX environment
 210 without any <em>CORBA</em> separation. This option is recommended only for debugging.
 211 It is dangerous to use <strong>--rw</strong> together, see its description for the details.</p>
 212 </dd>
 213 <dt><strong><a name="item__2d_2dbug_2dpathname_3dpathname"><strong>--bug-pathname</strong>=<strong>pathname</strong></a></strong></dt>
 214
 215 <dd>
 216 <p>Pathname to <strong>strftime</strong>(3) for <strong>.captivebug.xml.gz</strong> bugreports. Every crash of
 217 sandbox child gets bugreported to the specified file. You should attempt to
 218 minimize the number of operations from the mount operation till the expected
 219 crash to minimize the snapshot file size. <strong>--sandbox-server</strong> option is
 220 required for <strong>--bug-pathname</strong>.</p>
 221 </dd>
 222 <dd>
 223 <p><strong>!!! Be aware '.captivebug.xml.gz' will contain data from your disk drive !!!</strong></p>
 224 </dd>
 225 <dt><strong><a name="item__2d_2dsyslog"><strong>--syslog</strong></a></strong></dt>
 226
 227 <dd>
 228 <p>Messages sent to <strong>syslog</strong>(3) instead of <em>stderr</em>. This option gets handy
 229 for <strong>mount</strong>(8) operation as the messages would be lost otherway.
 230 Watch our for possible ``<strong>Filesystem crash broke dirty object</strong>'' messages where
 231 some written filesystem data got lost in the case of Microsoft Windows
 232 filesystem driver crash.</p>
 233 </dd>
 234 <dt><strong><a name="item__2d_2dsyslog_2dfacility_3dfacility"><strong>--syslog-facility</strong>=<strong>facility</strong></a></strong></dt>
 235
 236 <dd>
 237 <p><strong>openlog</strong>(3) facility for <strong>--syslog</strong>. See <strong>facility</strong> section of
 238 <strong>openlog</strong>(3) man page for details. Lowercased values such as <strong>daemon</strong> or
 239 <strong>user</strong> are supported.</p>
 240 </dd>
 241 </dl>
 242 </dl>
 243 <p>
 244 </p>
 245 <hr />
 246 <h1><a name="see_also">SEE ALSO</a></h1>
 247 <p><strong>captive</strong>(7)</p>
 248 <p>
 249 </p>
 250 <hr />
 251 <h1><a name="author">AUTHOR</a></h1>
 252 <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;,
 253 <tr><td><td><em><a href="http://www.jankratochvil.net/">http://www.jankratochvil.net/</a></em></table></p>
 254
 255 </body>
 256
 257 </html>