txlyre
/
avram


			
				
					
						
						
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
							<html lang="en">
<head>
<title>User Manual - avram - a virtual machine code interpreter</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="avram - a virtual machine code interpreter">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Preface.html#Preface" title="Preface">
<link rel="next" href="Virtual-Machine-Specification.html#Virtual-Machine-Specification" title="Virtual Machine Specification">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<a name="User-Manual"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Virtual-Machine-Specification.html#Virtual-Machine-Specification">Virtual Machine Specification</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Preface.html#Preface">Preface</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>

<h2 class="chapter">1 User Manual</h2>

<p>This chapter provides the basic information on how to use <code>avram</code>
to execute virtual machine code applications.

   <p><code>avram</code> is invoked
by typing a command at a shell prompt in one of these three forms.

<pre class="display">     <kbd>avram</kbd> [<em>general options</em>]
     <kbd>avram</kbd> [<em>filter mode options</em>] <var>codefile</var>[<kbd>.avm</kbd>]
     <kbd>avram</kbd> [<em>parameter mode options</em>] <var>codefile</var>[<kbd>.avm</kbd>] [<em>parameters</em>]
</pre>
   <p class="noindent">In the second case, <code>avram</code> reads from standard input, and may
of course appear as part of commands such as
<a name="index-standard-input-7"></a>
<pre class="display">     <kbd>avram</kbd> [<em>filter mode options</em>] <var>codefile</var>[<kbd>.avm</kbd>] &lt; <var>inputfile</var>
     <var>anothercommand</var> | <kbd>avram</kbd> [<em>filter mode options</em>] <var>codefile</var>[<kbd>.avm</kbd>]
</pre>
   <p class="noindent">When <code>avram</code> is invoked with the name of an input file (with a
default extension <kbd>.avm</kbd>), it reads virtual machine code from the
file and executes it on the host machine.

   <p><a name="index-functional-programming-8"></a>The virtual code format used by <code>avram</code> is designed
to support the features of functional or applicative programming
languages. Although this chapter documents only the usage of
<code>avram</code> and not the internals, it will be helpful to keep in mind
that the virtual machine code expresses a mathematical function rather
than a program in the conventional sense. As such, it performs no action
directly, but may be applied in a choice of ways by the user of
<code>avram</code> according to the precise operation required.

   <p>The following sections provide information in greater detail about
usage and diagnostics.

<ul class="menu">
<li><a accesskey="1" href="General-Options.html#General-Options">General Options</a>:              getting help and version information
<li><a accesskey="2" href="Modes-of-Operation.html#Modes-of-Operation">Modes of Operation</a>:           stream processing or file oriented
<li><a accesskey="3" href="Filter-Mode-Options.html#Filter-Mode-Options">Filter Mode Options</a>:          how to run a stream processor
<li><a accesskey="4" href="Parameter-Mode-Options.html#Parameter-Mode-Options">Parameter Mode Options</a>:       how to have an application use files
<li><a accesskey="5" href="Command-Line-Syntax.html#Command-Line-Syntax">Command Line Syntax</a>:          application-independent conventions
<li><a accesskey="6" href="Diagnostics.html#Diagnostics">Diagnostics</a>:                  explanation of error messages
<li><a accesskey="7" href="Security.html#Security">Security</a>:                     running untrusted applications
<li><a accesskey="8" href="Example-Script.html#Example-Script">Example Script</a>:               how to unburden the end users
<li><a accesskey="9" href="Files.html#Files">Files</a>:                        miscellaneous files used
<li><a href="Environment.html#Environment">Environment</a>:                  environment variables
<li><a href="Bugs.html#Bugs">Bugs</a>:                         hall of shame
</ul>

   </body></html>