General-Options.html 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
  2. <html>
  3. <!-- Created on December 10, 2012 by texi2html 1.82
  4. texi2html was written by:
  5. Lionel Cons <[email protected]> (original author)
  6. Karl Berry <[email protected]>
  7. Olaf Bachmann <[email protected]>
  8. and many others.
  9. Maintained by: Many creative people.
  10. Send bugs and suggestions to <[email protected]>
  11. -->
  12. <head>
  13. <title>avram - a virtual machine code interpreter: 1.1 General Options</title>
  14. <meta name="description" content="avram - a virtual machine code interpreter: 1.1 General Options">
  15. <meta name="keywords" content="avram - a virtual machine code interpreter: 1.1 General Options">
  16. <meta name="resource-type" content="document">
  17. <meta name="distribution" content="global">
  18. <meta name="Generator" content="texi2html 1.82">
  19. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  20. <style type="text/css">
  21. <!--
  22. a.summary-letter {text-decoration: none}
  23. blockquote.smallquotation {font-size: smaller}
  24. pre.display {font-family: serif}
  25. pre.format {font-family: serif}
  26. pre.menu-comment {font-family: serif}
  27. pre.menu-preformatted {font-family: serif}
  28. pre.smalldisplay {font-family: serif; font-size: smaller}
  29. pre.smallexample {font-size: smaller}
  30. pre.smallformat {font-family: serif; font-size: smaller}
  31. pre.smalllisp {font-size: smaller}
  32. span.roman {font-family:serif; font-weight:normal;}
  33. span.sansserif {font-family:sans-serif; font-weight:normal;}
  34. ul.toc {list-style: none}
  35. -->
  36. </style>
  37. </head>
  38. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  39. <a name="General-Options"></a>
  40. <table cellpadding="1" cellspacing="1" border="0">
  41. <tr><td valign="middle" align="left">[<a href="User-Manual.html#User-Manual" title="Previous section in reading order"> &lt; </a>]</td>
  42. <td valign="middle" align="left">[<a href="Modes-of-Operation.html#Modes-of-Operation" title="Next section in reading order"> &gt; </a>]</td>
  43. <td valign="middle" align="left"> &nbsp; </td>
  44. <td valign="middle" align="left">[<a href="User-Manual.html#User-Manual" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
  45. <td valign="middle" align="left">[<a href="User-Manual.html#User-Manual" title="Up section"> Up </a>]</td>
  46. <td valign="middle" align="left">[<a href="Virtual-Machine-Specification.html#Virtual-Machine-Specification" title="Next chapter"> &gt;&gt; </a>]</td>
  47. <td valign="middle" align="left"> &nbsp; </td>
  48. <td valign="middle" align="left"> &nbsp; </td>
  49. <td valign="middle" align="left"> &nbsp; </td>
  50. <td valign="middle" align="left"> &nbsp; </td>
  51. <td valign="middle" align="left">[<a href="avram.html#Top" title="Cover (top) of document">Top</a>]</td>
  52. <td valign="middle" align="left">[<a href="avram_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
  53. <td valign="middle" align="left">[<a href="Function-Index.html#Function-Index" title="Index">Index</a>]</td>
  54. <td valign="middle" align="left">[<a href="avram_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
  55. </tr></table>
  56. <hr size="1">
  57. <a name="General-Options-1"></a>
  58. <h2 class="section">1.1 General Options</h2>
  59. <p>Regardless of whatever other command line parameters are given,
  60. <code>avram</code> accepts the following parameters:
  61. </p>
  62. <a name="index-help"></a>
  63. <a name="index-emulation"></a>
  64. <a name="index-help-command-line-option"></a>
  65. <a name="index-emulation-command-line-option"></a>
  66. <dl compact="compact">
  67. <dt> <code>-h, --help</code></dt>
  68. <dd><p>Show a summary of options and exit.
  69. </p></dd>
  70. <dt> <code>-V,-v, --version</code></dt>
  71. <dd><p>Show the version of program and a short copyleft message and exit.
  72. </p></dd>
  73. <dt> <code>--emulation=<var>version</var></code></dt>
  74. <dd><p>Be backward compatible with an older version of <code>avram</code>. This
  75. option should include a valid version number, for example
  76. <kbd>0.13.0</kbd>, which is the version of <code>avram</code> to be
  77. emulated. It can make virtual code applications future proof, assuming
  78. that future versions of <code>avram</code> correctly support backward
  79. compatibility. It may be used in conjunction with any other option in
  80. any mode of operation.
  81. <a name="index-web-page"></a>
  82. <a name="index-home-page"></a>
  83. <a name="index-url"></a>
  84. This copy of the user manual has not been updated since version 0.13.0 of
  85. <code>avram</code>, so it is unable to document incompatibilities with later
  86. versions. The latest version of the manual may be found at
  87. <a href="http://www.lsbu.ac.uk/~fureyd/avram">http://www.lsbu.ac.uk/~fureyd/avram</a>.
  88. </p></dd>
  89. <dt> <code>-e, --external-libraries</code></dt>
  90. <dd><a name="index-external_002dlibraries"></a>
  91. <p>Show a list of libraries with which <code>avram</code> has been linked and
  92. whose functions therefore could be called from virtual machine
  93. programs. This growing list currently includes selected functions from
  94. <code>fftw</code>, <code>glpk</code>, <code>gsl</code>, <code>kinsol</code>, <code>lapack</code>,
  95. <code>minpack</code>, <code>mpfr</code>, <code>lpsolve</code>, <code>Rmath</code> and <code>ufsparse</code>
  96. (see <a href="Preface.html#Preface">Preface</a>) which are documented further in <a href="External-Libraries.html#External-Libraries">External Libraries</a>.
  97. </p></dd>
  98. <dt> <code>-j, --jail</code></dt>
  99. <dd><a name="index-jail"></a>
  100. <p>This option disables execution of shell commands by virtual code
  101. applications, which is normally possible by default even for nominally
  102. non-interactive applications (see <a href="Parameter-Mode-Options.html#Parameter-Mode-Options">Parameter Mode Options</a>). A
  103. virtual code application attempting to spawn a shell (using the
  104. <code>interact</code> combinator) when this option is selected will
  105. encounter an exception rather than successful completion of the
  106. operation. This option is provided as a security feature for running
  107. untrusted code (see <a href="Security.html#Security">Security</a>), and is incompatible with
  108. &lsquo;<samp>-i</samp>&rsquo;, &lsquo;<samp>-t</samp>&rsquo;, and &lsquo;<samp>-s</samp>&rsquo;.
  109. </p></dd>
  110. <dt> <code>-f, --force-text-input</code></dt>
  111. <dd><a name="index-force_002dtext_002dinput-command-line-option"></a>
  112. <p>Normally <code>avram</code> will try to guess by looking at a file whether it
  113. is an ordinary text file or one that has been written in the virtual
  114. code file format, and choose a different internal representation
  115. accordingly. An application may require one representation or the
  116. other. This option tells <code>avram</code> to treat all input files other
  117. than the virtual code file (named in the first command line parameter)
  118. as text files regardless of whether or not it would be possible to
  119. interpret them otherwise. This option may be used in combination with
  120. any other option.
  121. </p></dd>
  122. </dl>
  123. <hr size="1">
  124. <table cellpadding="1" cellspacing="1" border="0">
  125. <tr><td valign="middle" align="left">[<a href="User-Manual.html#User-Manual" title="Previous section in reading order"> &lt; </a>]</td>
  126. <td valign="middle" align="left">[<a href="Modes-of-Operation.html#Modes-of-Operation" title="Next section in reading order"> &gt; </a>]</td>
  127. <td valign="middle" align="left"> &nbsp; </td>
  128. <td valign="middle" align="left">[<a href="User-Manual.html#User-Manual" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
  129. <td valign="middle" align="left">[<a href="User-Manual.html#User-Manual" title="Up section"> Up </a>]</td>
  130. <td valign="middle" align="left">[<a href="Virtual-Machine-Specification.html#Virtual-Machine-Specification" title="Next chapter"> &gt;&gt; </a>]</td>
  131. <td valign="middle" align="left"> &nbsp; </td>
  132. <td valign="middle" align="left"> &nbsp; </td>
  133. <td valign="middle" align="left"> &nbsp; </td>
  134. <td valign="middle" align="left"> &nbsp; </td>
  135. <td valign="middle" align="left">[<a href="avram.html#Top" title="Cover (top) of document">Top</a>]</td>
  136. <td valign="middle" align="left">[<a href="avram_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
  137. <td valign="middle" align="left">[<a href="Function-Index.html#Function-Index" title="Index">Index</a>]</td>
  138. <td valign="middle" align="left">[<a href="avram_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
  139. </tr></table>
  140. <p>
  141. <font size="-1">
  142. This document was generated on <i>December 10, 2012</i> using <a href="http://www.nongnu.org/texi2html/"><i>texi2html 1.82</i></a>.
  143. </font>
  144. <br>
  145. </p>
  146. </body>
  147. </html>