Filter-Mode-Options.html 5.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. <html lang="en">
  2. <head>
  3. <title>Filter Mode Options - avram - a virtual machine code interpreter</title>
  4. <meta http-equiv="Content-Type" content="text/html">
  5. <meta name="description" content="avram - a virtual machine code interpreter">
  6. <meta name="generator" content="makeinfo 4.13">
  7. <link title="Top" rel="start" href="index.html#Top">
  8. <link rel="up" href="User-Manual.html#User-Manual" title="User Manual">
  9. <link rel="prev" href="Modes-of-Operation.html#Modes-of-Operation" title="Modes of Operation">
  10. <link rel="next" href="Parameter-Mode-Options.html#Parameter-Mode-Options" title="Parameter Mode Options">
  11. <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
  12. <meta http-equiv="Content-Style-Type" content="text/css">
  13. <style type="text/css"><!--
  14. pre.display { font-family:inherit }
  15. pre.format { font-family:inherit }
  16. pre.smalldisplay { font-family:inherit; font-size:smaller }
  17. pre.smallformat { font-family:inherit; font-size:smaller }
  18. pre.smallexample { font-size:smaller }
  19. pre.smalllisp { font-size:smaller }
  20. span.sc { font-variant:small-caps }
  21. span.roman { font-family:serif; font-weight:normal; }
  22. span.sansserif { font-family:sans-serif; font-weight:normal; }
  23. --></style>
  24. </head>
  25. <body>
  26. <div class="node">
  27. <a name="Filter-Mode-Options"></a>
  28. <p>
  29. Next:&nbsp;<a rel="next" accesskey="n" href="Parameter-Mode-Options.html#Parameter-Mode-Options">Parameter Mode Options</a>,
  30. Previous:&nbsp;<a rel="previous" accesskey="p" href="Modes-of-Operation.html#Modes-of-Operation">Modes of Operation</a>,
  31. Up:&nbsp;<a rel="up" accesskey="u" href="User-Manual.html#User-Manual">User Manual</a>
  32. <hr>
  33. </div>
  34. <h3 class="section">1.3 Filter Mode Options</h3>
  35. <p>The options available in filter mode are listed below. Except as
  36. otherwise noted, all options are mutually exclusive. Ordinarily a
  37. given application will require certain fixed settings of these options
  38. and will not work properly if they are set inappropriately.
  39. <dl>
  40. <dt><code>-r, --raw-output</code><dd><a name="index-raw_002doutput-command-line-option-25"></a>Normally the result obtained by evaluating the function in the virtual
  41. code file must be a list of character strings, which is written as
  42. such to standard output. However, if this option is selected, the form
  43. of the result is unconstrained, and it will be written in a data file
  44. format that is not human readable but can be used by other
  45. applications. This option is incompatible with any other options
  46. except <samp><span class="option">-u</span></samp>.
  47. <br><dt><code>-c, --choice-of-output</code><dd><a name="index-g_t_0040code_007bchoice_002dof_002doutput_007d-command-line-option-26"></a>When this option is used, the evaluation of the function given by the
  48. virtual machine code will be expected to yield a data structure from
  49. which <code>avram</code> will ascertain whether standard output should be
  50. written in text or raw data format. This option should be used only
  51. if application is aware of it. It is incompatible with any other options
  52. except <samp><span class="option">-u</span></samp>.
  53. <br><dt><code>-l, --line-map</code><dd><a name="index-g_t_0040code_007bline_002dmap_007d-command-line-option-27"></a>Normally the entire contents of standard input up to <code>EOF</code> are
  54. loaded into memory and used as the argument to the function in the
  55. virtual code file. However, this option causes standard input to be read
  56. a line at a time, with the function applied individually to each line,
  57. and its result in each case written immediately to standard output. A
  58. given application either requires this option or does not, and will not
  59. work properly in the alternative. This option implies
  60. <samp><span class="option">--force-text-input</span></samp> and is incompatible with any other option except
  61. <samp><span class="option">-u</span></samp>.
  62. <br><dt><code>-b, --byte-transducer</code><dd><a name="index-g_t_0040code_007bbyte_002dtransducer_007d-command-line-option-28"></a>This option causes standard input to be read one character at a time,
  63. evaluating the function given by the virtual code file each time. The
  64. function is used as a state transition function that takes a state and
  65. input to a next state and output. The output is written concurrently
  66. with the input operations. A given application will not work properly
  67. with an inappropriate setting of this option. This option implies
  68. <samp><span class="option">--force-text-input</span></samp> and is incompatible with any other option
  69. except <samp><span class="option">-u</span></samp>.
  70. <br><dt><code>-u, --unparameterized</code><dd><a name="index-g_t_0040code_007bunparameterized_007d-command-line-option-29"></a>Normally <code>avram</code> guesses whether to use filter mode or parameter
  71. mode depending on whether there are any parameters. Selecting this
  72. option forces it to operate in filter mode regardless. Any parameters
  73. that may appear on the command line after the virtual code file name
  74. are ignored. This option may be used in conjunction with any other
  75. filter mode option.
  76. </dl>
  77. </body></html>