luke
/
xschem
mirror of https://github.com/StefanSchippers/xschem.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update man page

This commit is contained in:
Stefan Frederik 2021-10-13 21:39:47 +02:00
parent de0afdd843
commit fccb8b58f9
2 changed files with 20 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/manpages/xschem.1.in
View File

@ -38,7 +38,7 @@ hierarchical representation of circuits with a top down approach.
Print help and exit.
.TP
.B -n, --batch
.B -b, --detach
Detach xschem from console.
.TP
@ -62,6 +62,18 @@ Run a simulation of the current schematc file (spice/Verilog/VHDL, depending on
Set netlist type to Verilog.
.TP
.B --tcl <tcl_script>
Execute specified tcl instructions before any other action, this can be used to change xschemrc variables.
.TP
.B --script <file>
Execute specified tcl file as a command script (perhaps with xschem commands).
.TP
.B --tcp-port <number>
Listen to specified tcp port for client connections. (number >=1024).
.TP
.B -i, --no_rcload
Do not load any xschemrc file.
.TP
@ -70,6 +82,10 @@ Do not load any xschemrc file.
Set output for netlist.
.TP
.B -N, --netlist_filename
Set name (only name, not path) of top level netlist file.
.TP
.B -t, --tedax
Set netlist type to tEDAx.
.TP
@ -78,18 +94,10 @@ Set netlist type to tEDAx.
Set netlist type to SPICE.
.TP
.B -3, --a3page
Set page size for pdf export to A3.
.TP
.B -x, --no_x
Dont use X (only command mode).
.TP
.B --events
Do not use tclreadline, empty tcl shell prompt, dump activity on stdout for remote controlling other software.
.TP
.B -z, --rainbow
Use a raibow-looking layer color table.
.TP
@ -118,14 +126,6 @@ Use <file> as output for plot export (png, svg, postscript/pdf)
Use <file> as a rc file for startup instead of the default xschemrc.
.TP
.B --tcl <tcl command>
Execute specified tcl instructions before any other action, this can be used to change xschemrc variables.
.TP
.B --script <tcl file>
Execute specified tcl file as a command script, perhaps with xschem commands.
.TP
.B -p, --postscript, --pdf
Export pdf schematic.
.TP

9
doc/xschem_man/create_pdf_man
View File

@ -1,8 +1,5 @@
#### before creating set width of images in html:
sed -i '/<img/s/ width="[0-9][0-9]*"//' *.html
sed -i '/<img/s/>/ width="640">/' *.html
cat \
/home/schippes/xschem-repo/trunk/doc/xschem_man/xschem_man.html \
@ -33,7 +30,7 @@ tutorial_busses.html \
tutorial_ngspice_backannotation.html \
tutorial_symgen.html \
tutorial_gschemtoxschem.html \
| htmldoc --no-toc --left 10mm --webpage -t pdf -f xschem_man.pdf -
| sed '/<img/s/>/ width="640">/' \
| htmldoc --no-toc --top 10mm --bottom 10mm --right 10mm --left 10mm \
--webpage --linkcolor blue --footer ..1 --header ..h -t pdf -f xschem_man.pdf -
#### restore after doing pdf:
sed -i '/<img/s/ width="[0-9][0-9]*"//' *.html