Filter-Mode-Options.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  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.3 Filter Mode Options</title>
  14. <meta name="description" content="avram - a virtual machine code interpreter: 1.3 Filter Mode Options">
  15. <meta name="keywords" content="avram - a virtual machine code interpreter: 1.3 Filter Mode 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="Filter-Mode-Options"></a>
  40. <table cellpadding="1" cellspacing="1" border="0">
  41. <tr><td valign="middle" align="left">[<a href="Parameter-Mode.html#Parameter-Mode" title="Previous section in reading order"> &lt; </a>]</td>
  42. <td valign="middle" align="left">[<a href="Parameter-Mode-Options.html#Parameter-Mode-Options" 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="Filter-Mode-Options-1"></a>
  58. <h2 class="section">1.3 Filter Mode Options</h2>
  59. <p>The options available in filter mode are listed below. Except as
  60. otherwise noted, all options are mutually exclusive. Ordinarily a
  61. given application will require certain fixed settings of these options
  62. and will not work properly if they are set inappropriately.
  63. </p>
  64. <dl compact="compact">
  65. <dt> <code>-r, <code>--raw-output</code></code></dt>
  66. <dd><a name="index-raw_002doutput-command-line-option"></a>
  67. <p>Normally the result obtained by evaluating the function in the virtual
  68. code file must be a list of character strings, which is written as
  69. such to standard output. However, if this option is selected, the form
  70. of the result is unconstrained, and it will be written in a data file
  71. format that is not human readable but can be used by other
  72. applications. This option is incompatible with any other options
  73. except &lsquo;<samp>-u</samp>&rsquo;.
  74. </p></dd>
  75. <dt> <code>-c, --choice-of-output</code></dt>
  76. <dd><a name="index-choice_002dof_002doutput-command-line-option"></a>
  77. <p>When this option is used, the evaluation of the function given by the
  78. virtual machine code will be expected to yield a data structure from
  79. which <code>avram</code> will ascertain whether standard output should be
  80. written in text or raw data format. This option should be used only
  81. if application is aware of it. It is incompatible with any other options
  82. except &lsquo;<samp>-u</samp>&rsquo;.
  83. </p></dd>
  84. <dt> <code>-l, --line-map</code></dt>
  85. <dd><a name="index-line_002dmap-command-line-option"></a>
  86. <p>Normally the entire contents of standard input up to <code>EOF</code> are
  87. loaded into memory and used as the argument to the function in the
  88. virtual code file. However, this option causes standard input to be read
  89. a line at a time, with the function applied individually to each line,
  90. and its result in each case written immediately to standard output. A
  91. given application either requires this option or does not, and will not
  92. work properly in the alternative. This option implies
  93. &lsquo;<samp>--force-text-input</samp>&rsquo; and is incompatible with any other option except
  94. &lsquo;<samp>-u</samp>&rsquo;.
  95. </p></dd>
  96. <dt> <code>-b, --byte-transducer</code></dt>
  97. <dd><a name="index-byte_002dtransducer-command-line-option"></a>
  98. <p>This option causes standard input to be read one character at a time,
  99. evaluating the function given by the virtual code file each time. The
  100. function is used as a state transition function that takes a state and
  101. input to a next state and output. The output is written concurrently
  102. with the input operations. A given application will not work properly
  103. with an inappropriate setting of this option. This option implies
  104. &lsquo;<samp>--force-text-input</samp>&rsquo; and is incompatible with any other option
  105. except &lsquo;<samp>-u</samp>&rsquo;.
  106. </p></dd>
  107. <dt> <code>-u, --unparameterized</code></dt>
  108. <dd><a name="index-unparameterized-command-line-option"></a>
  109. <p>Normally <code>avram</code> guesses whether to use filter mode or parameter
  110. mode depending on whether there are any parameters. Selecting this
  111. option forces it to operate in filter mode regardless. Any parameters
  112. that may appear on the command line after the virtual code file name
  113. are ignored. This option may be used in conjunction with any other
  114. filter mode option.
  115. </p></dd>
  116. </dl>
  117. <hr size="1">
  118. <table cellpadding="1" cellspacing="1" border="0">
  119. <tr><td valign="middle" align="left">[<a href="Parameter-Mode.html#Parameter-Mode" title="Previous section in reading order"> &lt; </a>]</td>
  120. <td valign="middle" align="left">[<a href="Parameter-Mode-Options.html#Parameter-Mode-Options" title="Next section in reading order"> &gt; </a>]</td>
  121. <td valign="middle" align="left"> &nbsp; </td>
  122. <td valign="middle" align="left">[<a href="User-Manual.html#User-Manual" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
  123. <td valign="middle" align="left">[<a href="User-Manual.html#User-Manual" title="Up section"> Up </a>]</td>
  124. <td valign="middle" align="left">[<a href="Virtual-Machine-Specification.html#Virtual-Machine-Specification" title="Next chapter"> &gt;&gt; </a>]</td>
  125. <td valign="middle" align="left"> &nbsp; </td>
  126. <td valign="middle" align="left"> &nbsp; </td>
  127. <td valign="middle" align="left"> &nbsp; </td>
  128. <td valign="middle" align="left"> &nbsp; </td>
  129. <td valign="middle" align="left">[<a href="avram.html#Top" title="Cover (top) of document">Top</a>]</td>
  130. <td valign="middle" align="left">[<a href="avram_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
  131. <td valign="middle" align="left">[<a href="Function-Index.html#Function-Index" title="Index">Index</a>]</td>
  132. <td valign="middle" align="left">[<a href="avram_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
  133. </tr></table>
  134. <p>
  135. <font size="-1">
  136. This document was generated on <i>December 10, 2012</i> using <a href="http://www.nongnu.org/texi2html/"><i>texi2html 1.82</i></a>.
  137. </font>
  138. <br>
  139. </p>
  140. </body>
  141. </html>