path: root/debian/yosys.1
diff options
authorRuben Undheim <>2014-04-14 18:56:39 +0200
committerRuben Undheim <>2014-04-14 18:56:39 +0200
commit9770cbd51873f96b000359855cc9bc12c802829e (patch)
treed89b7626bdc6dc23ba69820b99536f65076a7148 /debian/yosys.1
parent2b066ddc784ea3f426e6f652a56f3f600015ec4e (diff)
Updated copyright info and manpage
Diffstat (limited to 'debian/yosys.1')
1 files changed, 51 insertions, 27 deletions
diff --git a/debian/yosys.1 b/debian/yosys.1
index 07626afc..b4babcd5 100644
--- a/debian/yosys.1
+++ b/debian/yosys.1
@@ -16,44 +16,68 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
-yosys \- program to do something
+yosys \- Yosys Open SYnthesis Suite
.B yosys
-.RI [ options ] " files" ...
-.B bar
-.RI [ options ] " files" ...
+.RI [-V]\ [-S]\ [-q]\ [-v\ <level>\ [-t]\ [-l\ <logfile>]\ [-o\ <outfile>]\ [-f\ <frontend>]\ [-h\ cmd]\ [{-s|-c}\ <scriptfile>]\ [-p\ <pass>\ [-p\ ..]]\ [-b\ <backend>]\ [-m\ <module\_file>]\ [<infile>\ [..]]
This manual page documents briefly the
.B yosys
-.B bar
.\" 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\fP is a program that...
+\fByosys\fP is a program that synthesizes RTL to gate-level logic.
-These programs follow the usual GNU command line syntax, with long
-options starting with two dashes (`-').
A summary of options is included below.
-For a complete description, see the Info files.
-.B \-h, \-\-help
-Show summary of options.
-.B \-v, \-\-version
-Show version of program.
-.BR bar (1),
-.BR baz (1).
-The programs are documented fully by
-.IR "The Rise and Fall of a Fooish Bar" ,
-available via the Info system.
+.B \-q
+quiet operation. only write error message to console
+.B \-v <level>
+print log headers up to level <level> to the console. (implies -q)
+.B \-t
+annotate all log messages with a time stamp
+.B \-l logfile
+write log messages to the specified file
+.B \-o outfile
+write the design to the specified file on exit
+.B \-b backend
+use this backend for the output file specified on the command line
+.B \-H
+print the command list
+.B \-h command
+print the help message for the specified command
+.B \-s scriptfile
+execute the commands in the script file
+.B \-c tcl_scriptfile
+execute the commands in the tcl script file (see 'help tcl' for details)
+.B \-p command
+execute the commands
+.B \-m module_file
+load the specified module (aka plugin)
+.B \-V
+print version information and exit
+.B \-S
+The option -S is an alias for the following options that perform a simple
+transformation of the input to a gate-level netlist.
+ -p hierarchy -p proc -p opt -p memory -p opt -p techmap -p opt
-yosys was written by <upstream author>.
+yosys was written by Clifford Wolf <>.
-This manual page was written by Ruben <ruben@unknown>,
+This manual page was written by Ruben Undheim <>,
for the Debian project (and may be used by others).