| 1 | |
|---|
| 2 | |
|---|
| 3 | |
|---|
| 4 | |
|---|
| 5 | <?xml version="1.0" encoding="UTF-8"?> |
|---|
| 6 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
|---|
| 7 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr"> |
|---|
| 8 | <head> |
|---|
| 9 | <style type="text/css"><!-- |
|---|
| 10 | @import url("../www/wizard.css"); |
|---|
| 11 | //--></style> |
|---|
| 12 | <title>Wizard's Toolkit: Command-line Options</title> |
|---|
| 13 | <meta http-equiv="Content-Language" content="en-US"/> |
|---|
| 14 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> |
|---|
| 15 | <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/> |
|---|
| 16 | <meta name="Generator" content="PHP"/> |
|---|
| 17 | <meta name="Keywords" content="command-line, options, WizardsToolkit, Wizard's, Toolkit"/> |
|---|
| 18 | <meta name="Description" content="The Wizard's Toolkit, version 1.0.2, is a free C API that includes a number of methods most developers will find useful in their projects."/> |
|---|
| 19 | <meta name="Rating" content="INDEX, FOLLOW"/> |
|---|
| 20 | <meta name="Robots" content="ALL"/> |
|---|
| 21 | <meta name="Generator" content="ImageMagick Studio LLC"/> |
|---|
| 22 | <meta name="Author" content="ImageMagick Studio LLC"/> |
|---|
| 23 | <meta name="Revisit-after" content="2 DAYS"/> |
|---|
| 24 | <meta name="Resource-type" content="document"/> |
|---|
| 25 | <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/> |
|---|
| 26 | <meta name="Distribution" content="Global"/> |
|---|
| 27 | <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/> |
|---|
| 28 | </head> |
|---|
| 29 | |
|---|
| 30 | <body id="www-wizards-toolkit.org"> |
|---|
| 31 | <table id="titlebar" style="width: 100%;background-color: #f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="Wizard's Toolkit"> |
|---|
| 32 | <tbody> |
|---|
| 33 | <tr valign="top"> |
|---|
| 34 | <td align="left"><a href="../index.html"><img id="titlebar-west" src="../images/script.png" alt="[Wizard's Toolkit]" width="400" height="60" border="0" vspace="28" name="titlebar-west" /></a></td> |
|---|
| 35 | <td align="left"><a href="http://www.wizards-toolkit.org/" target="774471637"><img id="titlebar-west" src="../images/sponsor.jpg" alt="[sponsor]" border="0" vspace="28" name="titlebar-west" /></a></td> |
|---|
| 36 | <td width="99%"><br /></td> |
|---|
| 37 | <td style="background-color: white" align="right"><a href="../index.html"><img src="../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td> |
|---|
| 38 | <td style="background-color: white" align="right"><a href="http://www.wizards-toolkit.org/discourse-server/viewforum.html?f=17" target="1792834935"><img id="titlebar-east" src="../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td> |
|---|
| 39 | </tr> |
|---|
| 40 | </tbody> |
|---|
| 41 | </table> |
|---|
| 42 | |
|---|
| 43 | <table style="width: 100%" border="0" cellpadding="0" cellspacing="0" summary=""> |
|---|
| 44 | <tbody> |
|---|
| 45 | |
|---|
| 46 | <tr valign="top" style="height: 100%;"> |
|---|
| 47 | <td id="menu" width="1%" height="100%"> |
|---|
| 48 | <p><a href="#main">Skip to page contents</a></p> |
|---|
| 49 | <font size="-1"> |
|---|
| 50 | <span>[</span> |
|---|
| 51 | <a href="../index.html">About the<br />Wizard's Toolkit</a> |
|---|
| 52 | <span>]</span><br /><span>[</span> |
|---|
| 53 | <a href="../www/command-line-tools.html">Command-line Tools</a> |
|---|
| 54 | <span>]</span><br /><span>[</span> |
|---|
| 55 | <a href="../www/api.html">Application Program<br />Interface</a> |
|---|
| 56 | <span>]</span><br /><span>[</span> |
|---|
| 57 | <a href="../www/install-source.html">Install from Source</a> |
|---|
| 58 | <a href="../www/install-source.html#unix" class="sub">Unix</a> |
|---|
| 59 | <a href="../www/install-source.html#windows" class="sub">Windows</a> |
|---|
| 60 | <a href="../www/binary-releases.html">Binary Releases</a> |
|---|
| 61 | <a href="../www/binary-releases.html#unix" class="sub">Unix</a> |
|---|
| 62 | <a href="../www/binary-releases.html#windows" class="sub">Windows</a> |
|---|
| 63 | <span>]</span><br /><span>[</span> |
|---|
| 64 | <a href="../www/download.html">Download</a> |
|---|
| 65 | <span>]</span><br /><span>[</span> |
|---|
| 66 | <a href="../www/sponsors.html">Sponsors:</a> |
|---|
| 67 | <fieldset> |
|---|
| 68 | <a href="http://www.anxietyspinnerrings.com" class="sponsor" target="sponsor">Silver Rings</a><!-- 200904010140 --> |
|---|
| 69 | <br /> |
|---|
| 70 | </fieldset> |
|---|
| 71 | <span>]</span> |
|---|
| 72 | </font> |
|---|
| 73 | </td> |
|---|
| 74 | |
|---|
| 75 | <td id="main" valign="top"> |
|---|
| 76 | <p class="navigation-index">[<a href="#authenticate">-authenticate</a> • <a href="#chunksize">-chunksize</a> • <a href="#cipher">-cipher</a> • <a href="#debug">-debug</a> • <a href="#(de)compress">-(de)compress</a> • <a href="#entropy">-entropy</a> • <a href="#export">-export</a> • <a href="#help">-help</a> • <a href="#hmac">-hmac</a> • <a href="#key">-key</a> • <a href="#key-length">-key-length</a> • <a href="#keyring">-keyring</a> • <a href="#level">-level</a> • <a href="#list">-list</a> • <a href="#log">-log</a> • <a href="#mode">-mode</a> • <a href="#passphrase">-passphrase</a> • <a href="#properties">-properties</a> • <a href="#random">-random</a> • <a href="#true-random">-true-random</a> • <a href="#verbose">-verbose</a> • <a href="#version">-version</a>]</p> |
|---|
| 77 | |
|---|
| 78 | <p>Below is list of command-line options recognized by the Wizard's Toolkit <a href="../www/command-line-tools.html">command-line tools</a>. If you want a description of a particular option, click on the option name in the navigation bar above and you will go right to it.</p> |
|---|
| 79 | |
|---|
| 80 | <div style="margin: auto;"> |
|---|
| 81 | <h4><a name="authenticate" id="authenticate"></a>-authenticate <em class="option">method</em></h4> |
|---|
| 82 | </div> |
|---|
| 83 | |
|---|
| 84 | <p>authenticate with this method.</p> |
|---|
| 85 | |
|---|
| 86 | <p>To print a complete list of authentication methods, use the <a href="#list">-list authenticate</a> option.</p> |
|---|
| 87 | |
|---|
| 88 | <div style="margin: auto;"> |
|---|
| 89 | <h4><a name="chunksize" id="chunksize"></a>-chunksize <em class="option">bytes</em></h4> |
|---|
| 90 | </div> |
|---|
| 91 | |
|---|
| 92 | <p>number of bytes in a chunk.</p> |
|---|
| 93 | |
|---|
| 94 | <div style="margin: auto;"> |
|---|
| 95 | <h4><a name="cipher" id="cipher"></a>-cipher <em class="option">type</em></h4> |
|---|
| 96 | </div> |
|---|
| 97 | |
|---|
| 98 | <p>cipher to encipher or decipher content.</p> |
|---|
| 99 | |
|---|
| 100 | <p>To print a complete list of cipher algorithms, use the <a href="#list">-list cipher</a> option.</p> |
|---|
| 101 | |
|---|
| 102 | <div style="margin: auto;"> |
|---|
| 103 | <h4><a name="(de)compress" id="(de)compress"></a>-(de)compress</h4> |
|---|
| 104 | </div> |
|---|
| 105 | |
|---|
| 106 | <p>automagically (de)compress BZIP and ZIP files.</p> |
|---|
| 107 | |
|---|
| 108 | <p>By default, the <a href="../www/encipher.html">encipher</a> and <a href="../www/decipher.html">decipher</a> tools <em>automagically</em> expand the content of any BZIP or ZIP files on input or compresses any content on output if the filename extension is <kbd>.bz2</kbd> or <kbd>.gz</kbd>. The <a href="../www/digest.html">digest</a> tool, by default, computes the message digest of the unexpanded content of BZIP and ZIP files. Use this option to change this default behavior. Use <a href="#(de)compress">+(de)compress</a>, for example, to encipher the compressed content of BZIP or ZIP files.</p> |
|---|
| 109 | |
|---|
| 110 | <div style="margin: auto;"> |
|---|
| 111 | <h4><a name="debug" id="debug"></a>-debug <em class="option">events</em></h4> |
|---|
| 112 | </div> |
|---|
| 113 | |
|---|
| 114 | <p>display copious debugging information.</p> |
|---|
| 115 | |
|---|
| 116 | <div style="margin: auto;"> |
|---|
| 117 | <h4><a name="entropy" id="entropy"></a>-entropy <em class="option">type</em></h4> |
|---|
| 118 | </div> |
|---|
| 119 | |
|---|
| 120 | <p>increase content entropy.</p> |
|---|
| 121 | |
|---|
| 122 | <p>To print a complete list of entropy types, use the <a href="#list">-list entropy</a> option.</p> |
|---|
| 123 | |
|---|
| 124 | <div style="margin: auto;"> |
|---|
| 125 | <h4><a name="export" id="export"></a>-export <em class="option">id</em></h4> |
|---|
| 126 | </div> |
|---|
| 127 | |
|---|
| 128 | <p>export a key from your keyring.</p> |
|---|
| 129 | |
|---|
| 130 | <div style="margin: auto;"> |
|---|
| 131 | <h4><a name="help" id="help"></a>-help</h4> |
|---|
| 132 | </div> |
|---|
| 133 | |
|---|
| 134 | <p>print program options.</p> |
|---|
| 135 | |
|---|
| 136 | <div style="margin: auto;"> |
|---|
| 137 | <h4><a name="hmac" id="hmac"></a>-hmac <em class="option">hash</em></h4> |
|---|
| 138 | </div> |
|---|
| 139 | |
|---|
| 140 | <p>ensure message integrity with this hash.</p> |
|---|
| 141 | |
|---|
| 142 | <p>To print a complete list of hashes, use the <a href="#list">-list hash</a> option.</p> |
|---|
| 143 | |
|---|
| 144 | <div style="margin: auto;"> |
|---|
| 145 | <h4><a name="key" id="key"></a>-key <em class="option">hash</em></h4> |
|---|
| 146 | </div> |
|---|
| 147 | |
|---|
| 148 | <p>strengthen the key with this hash.</p> |
|---|
| 149 | |
|---|
| 150 | <div style="margin: auto;"> |
|---|
| 151 | <h4><a name="key-length" id="key-length"></a>-key-length <em class="option">value</em></h4> |
|---|
| 152 | </div> |
|---|
| 153 | |
|---|
| 154 | <p>cipher key length in bits: 256, 512, 1024, or 2048.</p> |
|---|
| 155 | |
|---|
| 156 | <div style="margin: auto;"> |
|---|
| 157 | <h4><a name="keyring" id="keyring"></a>-keyring <em class="option">filename</em></h4> |
|---|
| 158 | </div> |
|---|
| 159 | |
|---|
| 160 | <p>get or add private keys to this file.</p> |
|---|
| 161 | |
|---|
| 162 | <div style="margin: auto;"> |
|---|
| 163 | <h4><a name="level" id="level"></a>-level <em class="option">value</em></h4> |
|---|
| 164 | </div> |
|---|
| 165 | |
|---|
| 166 | <p>entropy level: 1 (less entropy) to 9 (more entropy).</p> |
|---|
| 167 | |
|---|
| 168 | <div style="margin: auto;"> |
|---|
| 169 | <h4><a name="list" id="list"></a>-list <em class="option">type</em></h4> |
|---|
| 170 | </div> |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | <p>print a list of supported option arguments. Choose from these list types:</p> |
|---|
| 174 | |
|---|
| 175 | <pre class="text"> |
|---|
| 176 | Authenticate |
|---|
| 177 | Cipher |
|---|
| 178 | Command |
|---|
| 179 | Configure |
|---|
| 180 | DataType |
|---|
| 181 | Debug |
|---|
| 182 | Endian |
|---|
| 183 | Entropy |
|---|
| 184 | EntropyLevel |
|---|
| 185 | Hash |
|---|
| 186 | KeyLength |
|---|
| 187 | List |
|---|
| 188 | Mode |
|---|
| 189 | </pre> |
|---|
| 190 | |
|---|
| 191 | <div style="margin: auto;"> |
|---|
| 192 | <h4><a name="log" id="log"></a>-log <em class="option">format</em></h4> |
|---|
| 193 | </div> |
|---|
| 194 | |
|---|
| 195 | <p>format of debugging information.</p> |
|---|
| 196 | |
|---|
| 197 | <div style="margin: auto;"> |
|---|
| 198 | <h4><a name="mode" id="mode"></a>-mode <em class="option">type</em></h4> |
|---|
| 199 | </div> |
|---|
| 200 | |
|---|
| 201 | <p>mode of encryption or decryption.</p> |
|---|
| 202 | |
|---|
| 203 | <p>To print a complete list of modes, use the <a href="#list">-list mode</a> option.</p> |
|---|
| 204 | |
|---|
| 205 | <div style="margin: auto;"> |
|---|
| 206 | <h4><a name="passphrase" id="passphrase"></a>-passphrase <em class="option">filename</em></h4> |
|---|
| 207 | </div> |
|---|
| 208 | |
|---|
| 209 | <p>get the passphrase from this file.</p> |
|---|
| 210 | |
|---|
| 211 | <div style="margin: auto;"> |
|---|
| 212 | <h4><a name="properties" id="properties"></a>-properties <em class="option">filename</em></h4> |
|---|
| 213 | </div> |
|---|
| 214 | |
|---|
| 215 | <p>cipher properties to/from this file.</p> |
|---|
| 216 | |
|---|
| 217 | <div style="margin: auto;"> |
|---|
| 218 | <h4><a name="random" id="random"></a>-random <em class="option">hash</em></h4> |
|---|
| 219 | </div> |
|---|
| 220 | |
|---|
| 221 | <p>strengthen random data with this hash.</p> |
|---|
| 222 | |
|---|
| 223 | <p>To print a complete list of hashes, use the <a href="#list">-list hash</a> option.</p> |
|---|
| 224 | |
|---|
| 225 | <div style="margin: auto;"> |
|---|
| 226 | <h4><a name="true-random" id="true-random"></a>-true-random</h4> |
|---|
| 227 | </div> |
|---|
| 228 | |
|---|
| 229 | <p>strengthen enciphering or deciphering with true random numbers.</p> |
|---|
| 230 | |
|---|
| 231 | <p>True random numbers are encouraged but may not always be practical because your application may block while entropy is gathered from your environment. If the application does block it may be waiting for your system to generate entropy. Move your mouse or press keystrokes in another window. Once enough entropy is generated, the application runs to completion.</p> |
|---|
| 232 | |
|---|
| 233 | <p>Use <a href="#true-random">+true-random</a> to force cryptographically strong pseudo-random numbers that do not block your application.</p> |
|---|
| 234 | |
|---|
| 235 | <div style="margin: auto;"> |
|---|
| 236 | <h4><a name="verbose" id="verbose"></a>-verbose</h4> |
|---|
| 237 | </div> |
|---|
| 238 | |
|---|
| 239 | <p>print detailed information about the secure content.</p> |
|---|
| 240 | |
|---|
| 241 | <div style="margin: auto;"> |
|---|
| 242 | <h4><a name="version" id="version"></a>-version</h4> |
|---|
| 243 | </div> |
|---|
| 244 | |
|---|
| 245 | <p>print version information.</p> |
|---|
| 246 | |
|---|
| 247 | </td> |
|---|
| 248 | <td id="margin" width="1%" height="100%" valign="top" align="right"> </td> |
|---|
| 249 | </tr> |
|---|
| 250 | </tbody> |
|---|
| 251 | </table> |
|---|
| 252 | <div id="linkbar"> |
|---|
| 253 | <a href="http://www.wizards-toolkit.org/discourse-server/viewforum.html?f=17" target="1068354252">Discourse Server</a> | |
|---|
| 254 | <a href="../www/license.html">License</a> | |
|---|
| 255 | <a href="../www/notice.html">Notice</a> |
|---|
| 256 | </div> |
|---|
| 257 | <div id="footer"> |
|---|
| 258 | <span id="footer-west">© 1999-2009 ImageMagick Studio LLC</span> |
|---|
| 259 | </div> |
|---|
| 260 | <div style="clear: both; margin: 0; width: 100%; "></div> |
|---|
| 261 | </body> |
|---|
| 262 | </html> |
|---|
