'\" t
.\"     Title: faum-node-pc
.\"    Author: FAUmachine team
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 11/11/2018
.\"    Manual: Reference Information
.\"    Source: FAUmachine
.\"  Language: English
.\"
.TH "FAUM\-NODE\-PC" "1" "11/11/2018" "FAUmachine" "Reference Information"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
faum-node-pc \- Start a virtual machine
.SH "SYNOPSIS"
.HP \w'\fBfaum\-node\-pc\fR\ 'u
\fBfaum\-node\-pc\fR [\fB\-h\fR] [\fB\-B\ \fR\fB\fIdirname\fR\fR] [\fB\-D\ \fR\fB\fIn\fR\fR] [\fB\-d\fR] [\fB\-k\ \fR\fB\fIkeymap\fR\fR] [\fB\-g\ \fR\fB\fIguitype\fR\fR] [\fB\-a\ \fR\fB\fIaudio_module\fR\fR] [\fB\-\-sparse\fR]
.SH "DESCRIPTION"
.PP
\fBfaum\-node\-pc\fR
starts a virtual machine\&.
.SH "OPTIONS"
.PP
\fB\-h\fR
.RS 4
print short explanation
.RE
.PP
\fB\-B \fR\fIdirname\fR
.RS 4
Use directory
\fIdirname\fR
to creating temporary files and disk image files\&. As a default
node\&.def
in the will get used\&.
.RE
.PP
\fB\-D \fR\fIn\fR
.RS 4
set debug level to
\fIn\fR
.RE
.PP
\fB\-d\fR
.RS 4
turn on debugging (short for \-D 1)
.RE
.PP
\fB\-k \fR\fIkeymap\fR
.RS 4
set the key translation map to
\fIkeymap\fR
.RE
.PP
\fB\-g \fR\fIguitype\fR
.RS 4
Use
\fIguitype\fR, where
\fIguitype\fR
is one of
\fBgtk\fR
or
\fBnull\fR\&.
\fBnull\fR
disables the GUI entirely, useful for running automated experiments\&.
\fBgtk\fR
is the default\&.
.RE
.PP
\fB\-a \fR\fIaudio_module\fR
.RS 4
Use
\fIaudio_module\fR, where
\fIaudio_module\fR
is one of
\fBalsa1x\fR,
\fBesd\fR,
\fBfile\fR,
\fBmacosx\fR,
\fBoss\fR,
\fBpulse\fR
or
\fBnull\fR\&. Not all modules may be available for your system\&. By default, the best available audio module is chosen\&.
.RE
.PP
\fB\-\-sparse\fR
.RS 4
Enable usage of sparse files for all generated media images, like hard disc images\&. Please use this option only, if you know that you\*(Aqve got sufficient disk space\&.
.RE
.SH "EXAMPLES"
.PP
To run
\fBfaum\-node\-pc\fR, you must have a precompiled
system\&.ic
that specifies the setup of the simulated PC as well as a
simulation\&.setup
that determines simulation specific parameters in your working directory\&. You can use
\fBfauhdlc\fR
to compile a structural VHDL setup into a
system\&.ic
file\&.
.PP
FAUmachine comes with a number of example experiments in
/usr/share/faumachine/experiments\&.
.PP
To run such an experiment, you can use
\fBmake \-f /usr/share/faumachine/experiments/<experiment>/Makefile experiment\fR\&.
.SH "ENVIRONMENT"
.PP
\fIFAUM_AUDIO\fR
.RS 4
Specifies the desired audio module to use\&. Same as the
\fB\-a\fR
option\&.
.RE
.PP
\fIFAUM_SPARSE\fR
.RS 4
Set to
\fB1\fR
to use sparse files for all media files\&.
.RE
.PP
\fIFAUM_GUI\fR
.RS 4
Specifies which gui to use\&. Same as the
\fB\-g\fR
option\&.
.RE
.SH "BUGS"
.PP
Please report all bugs to
\m[blue]\fBinfo@faumachine\&.org\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "SEE ALSO"
.PP
\fBfauhdlc\fR(1)
.SH "AUTHOR"
.PP
This manual page was written by the
\m[blue]\fBFAUmachine Team\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "CONTACT"
.PP
\m[blue]\fBWebpage\fR\m[]\&\s-2\u[2]\d\s+2
.PP
\m[blue]\fBProject Team\fR\m[]\&\s-2\u[1]\d\s+2
.SH "AUTHOR"
.PP
\fBFAUmachine team\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2000-2009 FAUmachine team. Developed at Friedrich Alexander University Erlangen-Nuremberg.
.br
.PP
FAUmachine comes with ABSOLUTELY NO WARRANTY. FAUmachine is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. See COPYING for details.
.sp
.SH "NOTES"
.IP " 1." 4
info@faumachine.org
.RS 4
\%mailto:info@faumachine.org
.RE
.IP " 2." 4
Webpage
.RS 4
\%http://www.faumachine.org/
.RE