1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
<!--
Copyright (C) 2004-2009 FAUmachine Team <info@faumachine.org>.
This program is free software. You can redistribute it and/or modify it
under the terms of the GNU General Public License, either version 2 of
the License, or (at your option) any later version. See COPYING.
-->
<refentry>
<refmeta>
<refentrytitle>faum-node-pc</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>&packageversion;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>faum-node-pc</refname>
<refpurpose>Start a virtual machine</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv>
<cmdsynopsis>
<command>faum-node-pc</command>
<arg><option>-h</option></arg>
<arg><option>-B <replaceable>dirname</replaceable></option></arg>
<arg><option>-D <replaceable>n</replaceable></option></arg>
<arg><option>-d</option></arg>
<arg><option>-k <replaceable>keymap</replaceable></option></arg>
<arg><option>-g <replaceable>guitype</replaceable></option></arg>
<arg><option>-a <replaceable>audio_module</replaceable></option></arg>
<arg><option>--sparse</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>DESCRIPTION</title>
<para><command>faum-node-pc</command>
starts a virtual machine.</para>
</refsect1>
<refsect1><title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>-h</option></term>
<listitem>
<para>print short explanation</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-B </option><replaceable>dirname</replaceable></term>
<listitem>
<para>
Use directory <replaceable>dirname</replaceable>
to creating temporary files and disk image files.
As a default <filename>node.def</filename> in the
will get used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-D </option><replaceable>n</replaceable></term>
<listitem>
<para>
set debug level to <replaceable>n</replaceable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<listitem>
<para>turn on debugging (short for -D 1)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-k </option><replaceable>keymap</replaceable></term>
<listitem>
<para>
set the key translation map to
<replaceable>keymap</replaceable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-g </option><replaceable>guitype</replaceable>
</term>
<listitem>
<para>
Use <replaceable>guitype</replaceable>, where
<replaceable>guitype</replaceable> is one of
<constant>gtk</constant> or <constant>null</constant>.
<constant>null</constant> disables the GUI entirely, useful
for running automated experiments. <constant>gtk</constant>
is the default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a </option><replaceable>audio_module</replaceable>
</term>
<listitem>
<para>
Use <replaceable>audio_module</replaceable>, where
<replaceable>audio_module</replaceable> is one of
<constant>alsa1x</constant>, <constant>esd</constant>,
<constant>file</constant>, <constant>macosx</constant>,
<constant>oss</constant>, <constant>pluse</constant> or
<constant>null</constant>. Not all modules may be available
for your system.
By default, the best available audio module is chosen.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--sparse</option>
</term>
<listitem>
<para>
Enable usage of sparse files for all generated media images,
like hard disc images.
Please use this option only, if you know that you've got
sufficient disk space.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>EXAMPLES</title>
<para>
To run <command>faum-node-pc</command>, you must have a precompiled
<filename>system.ic</filename> that specifies the setup of the
simulated PC as well as a <filename>simulation.setup</filename> that
determines simulation specific parameters in your working directory.
You can use <command>fauhdlc</command> to compile a structural VHDL
setup into a <filename>system.ic</filename> file.
</para>
<para>
FAUmachine comes with a number of example experiments in
<filename class="directory">/usr/share/faumachine/experiments</filename>.
</para>
<para>
To run such an experiment, you can use
<userinput>make -f
/usr/share/faumachine/experiments/<experiment>/Makefile
experiment</userinput>.
</para>
</refsect1>
<refsect1><title>ENVIRONMENT</title>
<variablelist>
<varlistentry>
<term><varname>FAUM_AUDIO</varname></term>
<listitem>
<para>
Specifies the desired audio module to use. Same as the
<option>-a</option> option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>FAUM_SPARSE</varname></term>
<listitem>
<para>
Set to <constant>1</constant> to use sparse files for all media files.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>FAUM_GUI</varname></term>
<listitem>
<para>
Specifies which gui to use. Same as the <option>-g</option> option.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
&bugs;
<refsect1><title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>fauhdlc</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
&author;
&contact;
</refentry>
|
