Index: trunk/doc/man/Makefile =================================================================== --- trunk/doc/man/Makefile (nonexistent) +++ trunk/doc/man/Makefile (revision 1489) @@ -0,0 +1,65 @@ +# This Makefile is a plain old hand written one; all configuration settings +# are included from $(ROOT)/Makefile.conf which is scconfig generated +ROOT=../.. + +IN=route-rnd.1.mml +OUT_HTML = route-rnd.1.html +OUT_MAN1 = route-rnd.1 +OUT_LINT = route-rnd.1.lint + +OUTPUT = $(OUT_HTML) $(OUT_MAN1) index.html +MML = /usr/bin/mml + +all: $(OUTPUT) + +lint: $(OUT_LINT) + +.SUFFIXES: .html .mml .lint + +.mml.html: .mml_linkmap + $(MML) -i copyright.mml -f html $< > $@ + +.mml: + $(MML) -i copyright.mml -f man $< > $@ + +.mml_linkmap: + $(MML) -i copyright.mml -f linkmap $(IN) > $@ + +index.html: $(IN) + @echo '' > $@ + @echo 'man page index - route-rnd" >> $@ + +clean: + +distclean: + +genclean: + rm $(OUTPUT) 2>/dev/null ; true + +.mml.lint: + $(MML) -i copyright.mml -f lint $< + +install_all: + $(SCCBOX) mkdir -p "$(MAN1DIR)" + $(SCCBOX) $(HOW) "route-rnd.1" "$(MAN1DIR)/route-rnd.1" + $(SCCBOX) $(HOW) "pcb-prj2lht.1" "$(MAN1DIR)/pcb-prj2lht.1" + $(SCCBOX) $(HOW) "gsch2route-rnd.1" "$(MAN1DIR)/gsch2route-rnd.1" + $(SCCBOX) $(HOW) "fp2preview.1" "$(MAN1DIR)/fp2preview.1" + $(SCCBOX) $(HOW) "fp2subc.1" "$(MAN1DIR)/fp2subc.1" + $(SCCBOX) $(HOW) "route-rnd-svg.1" "$(MAN1DIR)/route-rnd-svg.1" + $(SCCBOX) $(HOW) "bxl2txt.1" "$(MAN1DIR)/bxl2txt.1" + $(SCCBOX) $(HOW) "txt2bxl.1" "$(MAN1DIR)/txt2bxl.1" + +install: + $(MAKE) install_all HOW="install -f" + +linstall: + $(MAKE) install_all HOW="linstall -f" + +uninstall: + $(MAKE) install_all HOW="uninstall" + +include $(ROOT)/Makefile.conf + Index: trunk/doc/man/copyright.mml =================================================================== --- trunk/doc/man/copyright.mml (nonexistent) +++ trunk/doc/man/copyright.mml (revision 1489) @@ -0,0 +1,21 @@ + +route-rnd - manual\n +Copyright (C) 2021 Tibor 'Igor2' Palinkas\n +\n +This program is free software; you can redistribute it and/or modify\n +it under the terms of the GNU General Public License as published by\n +the Free Software Foundation; either version 2 of the License, or\n +(at your option) any later version.\n +\n +This program is distributed in the hope that it will be useful,\n +but WITHOUT ANY WARRANTY; without even the implied warranty of\n +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n +GNU General Public License for more details.\n +\n +You should have received a copy of the GNU General Public License along\n +with this program; if not, write to the Free Software Foundation, Inc.,\n +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n +\n +Contact: pcb-rnd-man[removethis]@igor2.repo.hu + +route-rnd manual Index: trunk/doc/man/index.html =================================================================== --- trunk/doc/man/index.html (nonexistent) +++ trunk/doc/man/index.html (revision 1489) @@ -0,0 +1,4 @@ + +man page index - route-rnd Index: trunk/doc/man/route-rnd.1 =================================================================== --- trunk/doc/man/route-rnd.1 (nonexistent) +++ trunk/doc/man/route-rnd.1 (revision 1489) @@ -0,0 +1,63 @@ +.\" route-rnd - manual +.\" Copyright (C) 2021 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: pcb-rnd-man[removethis]@igor2.repo.hu +.TH route-rnd 1 2021-10-10 "" "route-rnd manual" +.SH NAME +route-rnd - external PCB autorouter +.SH SYNPOSIS +.nf +.sp +\fBroute-rnd [-v] -m \fImethod\fB [-o \fIout_fn\fB] \fIinp_fn\fB +\fBroute-rnd -m \fImethod\fB -l +\fBroute-rnd -M +.fi +.SH DECSRIPTION + +.BR route-rnd +takes a route request in tEDAx form, routes zero or more nets and returns a route result in tEDAx form. It has options to list methods (algorithms) and their settings in computer readable format. +.SH OPTIONS + + +.TP + +.B -M +List available methods (in TSV format) on stdout. +.TP + +.B -m \fImethod\fR +Select which method (algorithm) to use; method names can be learned from the first column of -M output. +.TP + +.B -l +List config options of a method in tEDAx route res format on stdout. Use it together with -m. +.TP + +.B -v +increase verbosity (can be specified multiple times) +.TP + +.B -o \fIout_fn\fR +Output file name (for tEDAx route result). +.TP + +.B \fIinp_fn\fR +Input file name (tEDAx route request). +.PP + +.SH SEE ALSO +pcb-rnd(1) Index: trunk/doc/man/route-rnd.1.html =================================================================== --- trunk/doc/man/route-rnd.1.html (nonexistent) +++ trunk/doc/man/route-rnd.1.html (revision 1489) @@ -0,0 +1,102 @@ + + + +route-rnd - route-rnd manual + + + + +
route-rnd 1 + 2021-10-10 + route-rnd manual +
+ + + +

NAME

+
+route-rnd - external PCB autorouter +
+ +

SYNPOSIS

+
+

+route-rnd [-v] -m method [-o out_fn] inp_fn +
route-rnd -m method -l +
route-rnd -M + + + +

+ +

DESCRIPTION

+
+route-rnd takes a route request in tEDAx form, routes zero or more nets and returns a route result in tEDAx form. It has options to list methods (algorithms) and their settings in computer readable format. +
+ + +

OPTIONS

+
+ + + + + + + + + + + + + + + +
-M + List available methods (in TSV format) on stdout. +
-m method + Select which method (algorithm) to use; method names can be learned from the first column of -M output. +
-l + List config options of a method in tEDAx route res format on stdout. Use it together with -m. +
-v + increase verbosity (can be specified multiple times) +
-o out_fn + Output file name (for tEDAx route result). +
inp_fn + Input file name (tEDAx route request). +
+
+ +

SEE ALSO

+ +

+ + +
route-rnd 1 + 2021-10-10 + route-rnd manual +
+ + + Index: trunk/doc/man/route-rnd.1.mml =================================================================== --- trunk/doc/man/route-rnd.1.mml (nonexistent) +++ trunk/doc/man/route-rnd.1.mml (revision 1489) @@ -0,0 +1,47 @@ +route-rnd +1 +2021-10-10 + + route-rnd - external PCB autorouter + route-rnd [-v] -m method [-o out_fn] inp_fn + route-rnd -m method -l + route-rnd -M + + +route-rnd takes a route request in tEDAx form, routes zero or +more nets and returns a route result in tEDAx form. It has options to +list methods (algorithms) and their settings in computer readable format. + + + + + + -M + List available methods (in TSV format) on stdout. + + + -m method + Select which method (algorithm) to use; method names can be + learned from the first column of -M output. + + + -l + List config options of a method in tEDAx route res format on + stdout. Use it together with -m. + + + -v + increase verbosity (can be specified multiple times) + + + -o out_fn + Output file name (for tEDAx route result). + + + inp_fn + Input file name (tEDAx route request). + + + + + pcb-rnd(1)