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