.\" Text automatically generated by txt2man
.TH QROUTER 1 "16 February 2021" "" ""
.SH NAME
\fBqrouter \fP- Multi-level, over-the-cell maze router
\fB
.SH SYNOPSIS
.nf
.fam C
\fBqrouter\fP [\fB-noc\fP] [\fB-s\fP \fIscriptname\fP] [\fIoptions\fP] [\fIdesign_name\fP]

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
This manual page documents briefly the \fBqrouter\fP command.
.PP
Qrouter is a tool to generate metal layers and vias to physically connect together a netlist in a VLSI fabrication technology. It is a maze router, otherwise known as an "over-the-cell" router or "sea-of-gates" router. That is, unlike a channel router, it begins with a description of placed standard cells, usually packed together at minimum spacing, and places metal routes over the standard cells.
.PP
Qrouter uses the open standard LEF and DEF formats as file input and output. It takes the cell definitions from a LEF file, and analyzes the geometry for each cell to determine contact points and route obstructions. It then reads the cell placement, pin placement, and netlist from a DEF file, performs the detailed route, and writes an annotated DEF file as output.
.SH USAGE

Qrouter can run be run in several ways:
.IP 1. 4
Interactive mode. If \fBqrouter\fP is started without any \fIoptions\fP, a tkcon window will be opened with an interpreter where commands may be entered.
.IP 2. 4
Normal batch mode. This mode is activated if a tcl script is given with the "\fB-s\fP" option. It can be run with or without a graphical window. If "\fB-noc\fP" is given, no graphical window will appear.
.PP
.nf
.fam C
    Run without graphical window:
     qrouter -noc -s routescript.tcl

    Run with a graphical window showing the layout while it is routing:
     qrouter -s routescript.tcl

.fam T
.fi
.IP 3. 4
Compatibility mode with \fBqrouter\fP 1.1. This mode is activated if either of the \fIoptions\fP "\fB-c\fP", "\fB-v\fP", "\fB-i\fP", "\fB-p\fP" or "\fB-g\fP" are given. This is a batch mode.
.SH OPTIONS

.TP
.B
\fB-noc\fP
No console mode
.TP
.B
\fB-s\fP <\fIscriptname\fP>
Run \fIscriptname\fP
.SH COMPATIBILITY MODE
.TP
.B
\fB-c\fP <file>
Configuration file name (if not route.cfg)
.TP
.B
\fB-v\fP <level>
Verbose output level
.TP
.B
\fB-i\fP <name>
Print route names and pitches and exit
.TP
.B
\fB-p\fP <name>
Specify global power bus name
.TP
.B
\fB-g\fP <name>
Specify global ground bus name
.RE
.PP

.SH INPUT
The input files for \fBqrouter\fP is an unrouted or partly routed .def file containing the
layout and a .cfg file containing the tcl script used to do the routing. The .cfg
file also needs to specify a .lef file describing the technology.
.RE
.PP

.SH OUTPUT
\fBqrouter\fP will output the fully routed .def file (if successful routing). This may
then later be converted to a GDSII file using tools such as magic.
.SH SEE ALSO
\fBqflow\fP(1)
.SH AUTHOR
\fBqrouter\fP was written by Tim Edwards <tim@opencircuitdesign.com>.
.PP
This manual page was written by Ruben Undheim <ruben.undheim@gmail.com>, for the
Debian project (and may be used by others).