3.\" xschem - manual
.\" Copyright (C) 2018 Tibor 'Igor2' Palinkas
.\" 
.\" This program 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.
.\" 
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\" 
.\" You should have received a copy of the GNU General Public License along
.\" with this program; if not, write to the Free Software Foundation, Inc.,
.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
.\" 
.\" Contact: TODO: an email address
.TH xschem 1 2018-01-01 "" "xschem manual"
.SH NAME
xschem - schematic capture and netlisting EDA tool
.SH SYNPOSIS
.nf
.sp
\fBxschem [\fIoptions\fB] [\fIinputfile\fB]
.fi
.SH DECSRIPTION

.BR Xschem
is a schematic capture program, it allows creation of
hierarchical representation of circuits with a top down approach.
.SH OPTIONS


.TP

.B -h
Print help screen and exit.
.TP

.B -n
do a netlist of the given schematic cell
.TP

.B -v
set netlist type to VHDL
.TP

.B -w
set netlist type to verilog
.TP

.B -t
set netlist type to tedax
.TP

.B -s
set netlist type to SPICE
.TP

.B -3
set page size for printing to A3
.TP

.B -x
dont use X (only command mode)
.TP

.B -i
Do not read any system or user configuration files (xschemrc)
.TP

.B -z
use a raibow-looking layer color table
.TP

.B -W
show simulation waveforms
.TP

.B -f
set flat netlist (for spice format only)
.TP

.B -r
start without the tclreadline package (this is necessary if
stdin and stdout are to be redirected for example 
to /dev/null).
.TP

.B -c
set color postscript
.TP

.B -p
print schematic
.TP

.B -S
simulate schematic
.TP

.B -q
quit after doing things (no interactive mode)
.TP

.B -l \ffile\fR
set a log file
.TP

.B -d \flevel\fR
set debug level:  1,  2,  3, n sets C program debug, -1, -2, -3, -n
sets TCL frontend debug


.SH FILES

.TP

.B $PREFIX/share/xschem/xschemrc
default configuration
.TP

.B ~/.xschem/xschemrc
user configuration; if exists overrides settings from default configuration;
may be partial: settings not overridden will remain as set from the system
config
.TP

.B ./xschemrc
local/per-project configuration; if exists overrides settings from
the user configuration and default configuration; may be partial:
settings not overridden will remain as set from the system config
or user config
.TP

.B $PREFIX/share/xschem/systemlib
builtin essentials, such as font and missing symbol graphics
.TP

.B $PREFIX/share/xschem/utile
TODO
.TP