summaryrefslogtreecommitdiff
path: root/debian/yosys-config.1
diff options
context:
space:
mode:
Diffstat (limited to 'debian/yosys-config.1')
-rw-r--r--debian/yosys-config.153
1 files changed, 53 insertions, 0 deletions
diff --git a/debian/yosys-config.1 b/debian/yosys-config.1
new file mode 100644
index 00000000..f8d45b1b
--- /dev/null
+++ b/debian/yosys-config.1
@@ -0,0 +1,53 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH YOSYS-CONFIG 1 "October 16, 2014"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+yosys-config \- Yosys Open SYnthesis Suite Config
+.SH SYNOPSIS
+.B yosys-config
+.RI "[ -exec ] [ --prefix pf ]" " args"
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B yosys-config
+command.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+\fByosys-config\fP is a shell script which can be used to query compiler options and other information needed for building loadable modules for yosys. It is similar in behaviour to pkg-config.
+.SH OPTIONS
+A summary of options is included below.
+.TP
+.B \-\-cxx
+.TP
+.B \-\-cxxflag
+.TP
+.B \-\-ldflags
+.TP
+.B \-\-ldlibs
+.TP
+.B \-\-bindir
+.TP
+.B \-\-datdir
+.SH SEE ALSO
+yosys(1), yosys-filterlib(1)
+.SH AUTHOR
+yosys-config was written by Clifford Wolf <clifford@clifford.at>.
+.PP
+This manual page was written by Ruben Undheim <ruben.undheim@gmail.com>,
+for the Debian project (and may be used by others).