'\" t
.\"     Title: FAUHDLC
.\"    Author: FAUmachine Team
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 07/22/2020
.\"    Manual: [FIXME: manual]
.\"    Source: FAUmachine Team
.\"  Language: English
.\"
.TH "FAUHDLC" "1" "07/22/2020" "FAUmachine Team" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * 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"
fauhdlc \- Compile VHDL files to intermediate code\&.
.SH "SYNOPSIS"
.HP \w'\fBfauhdlc\fR\ 'u
\fBfauhdlc\fR [\fBflags\fR] [\fB\ \-\-output\ \fR\fB\fIfilename\fR\fR\fB\ \fR] [\fB\ \-\-c\-output\ \fR\fB\fIfilename\fR\fR\fB\ \fR] [\fB\ \-\-lib\ \fR\fB\fIlibrary\fR\fR\fB\ \fR\ [\ \fB\ \fR\fB\fIvhdl\-file\fR\fR\fB\ \fR\ ]...] {\fB\ \fR\fB\fIvhdl\-file\fR\fR\fB\ \fR...}
.SH "DESCRIPTION"
.PP
\fBfauhdlc\fR
is a VHDL compiler, that will output intermediate code or C\-code\&. It supports a subset of the VHDL 2000 standard\&.
.SH "OPTIONS"
.PP
These programs follow the usual GNU command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&.
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show summary of options\&.
.RE
.PP
\fB\-o\fR, \fB\-\-output\fR \fIoutput\-file\fR
.RS 4
Output intermediate code into
\fIoutput\-file\fR\&.
.RE
.PP
\fB\-l\fR, \fB\-\-lib\fR \fIlibrary\-name\fR
.RS 4
Put the following VHDL\-files into the library with name
\fIlibrary\-name\fR\&. If no
\fB\-\-lib\fR
is present, all files will be put into the library "work"\&.
.RE
.PP
\fB\-f\fR, \fB\-\-freestanding\fR
.RS 4
Do not preload any library except std\&.vhdl\&. By default,
\fBfauhdlc\fR
will preload common libraries (currently only std_logic_1164) in the appropriate library namespace\&. The
\fB\-\-freestanding\fR
prevents this behaviour, for example if you want to override the implementation of such a library\&.
.RE
.PP
\fB\-Werror\fR
.RS 4
Treat warnings as errors\&.
.RE
.PP
\fB\-p\fR, \fB\-\-parse\-only\fR
.RS 4
Stop with compilation after parsing the source file(s)\&. Mainly useful for debugging the compiler\&.
.RE
.PP
\fB\-d\fR, \fB\-\-dot\-parse\fR \fIdot\-file\fR
.RS 4
Output the raw syntax tree into
\fIdot\-file\fR, which can be used with the GraphViz tools\&.
.RE
.PP
\fB\-c\fR, \fB\-\-dot\-const\fR \fIdot\-file\fR
.RS 4
Output the syntax tree that exists after performing constant folding into
\fIdot\-file\fR, which can be used with the GraphViz tools\&.
.RE
.PP
\fB\-C\fR, \fB\-\-c\-output\fR \fIc\-file\fR
.RS 4
Generate output as a C file
\fIc\-file\fR, that can be compiled with a C\-compiler, e\&.g\&.
\fBgcc\fR\&. This option is yet experimental\&.
.RE
.SH "SEE ALSO"
.PP
\fBfauhdli\fR(1)
.SH "CONTACT"
.PP
Please report all bugs to FAUmachine Team
<info@faumachine\&.org>\&.
\m[blue]\fBFAUmachine/fauhdlc Homepage\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "AUTHOR"
.PP
\fBFAUmachine Team\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2009-2010 FAUmachine Team. Developed at Friedrich Alexander University Erlangen-Nuremberg.
.br
.PP
FAUhdlc comes with ABSOLUTELY NO WARRANTY\&. FAUhdlc 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
FAUmachine/fauhdlc Homepage
.RS 4
\%http://www.faumachine.org
.RE