pcb-rnd-svg - pcb-rnd manual

Index: Makefile =================================================================== --- Makefile (revision 31940) +++ Makefile (revision 31941) @@ -2,10 +2,10 @@ # are included from $(ROOT)/Makefile.conf which is scconfig generated ROOT=../.. -IN=pcb-rnd.1.mml pcb-prj2lht.1.mml fp2preview.1.mml fp2subc.1.mml bxl2txt.1.mml txt2bxl.1.mml -OUT_HTML = pcb-rnd.1.html pcb-prj2lht.1.html fp2preview.1.html fp2subc.1.html bxl2txt.1.html txt2bxl.1.html -OUT_MAN1 = pcb-rnd.1 pcb-prj2lht.1 fp2preview.1 fp2subc.1 bxl2txt.1 txt2bxl.1 -OUT_LINT = pcb-rnd.1.lint pcb-prj2lht.1.lint fp2preview.1.lint fp2subc.1.lint bxl2txt.1.lint txt2bxl.1.lint +IN=pcb-rnd.1.mml pcb-prj2lht.1.mml fp2preview.1.mml fp2subc.1.mml bxl2txt.1.mml txt2bxl.1.mml pcb-rnd-svg.1.mml +OUT_HTML = pcb-rnd.1.html pcb-prj2lht.1.html fp2preview.1.html fp2subc.1.html bxl2txt.1.html txt2bxl.1.html pcb-rnd-svg.1.html +OUT_MAN1 = pcb-rnd.1 pcb-prj2lht.1 fp2preview.1 fp2subc.1 bxl2txt.1 txt2bxl.1 pcb-rnd-svg.1 +OUT_LINT = pcb-rnd.1.lint pcb-prj2lht.1.lint fp2preview.1.lint fp2subc.1.lint bxl2txt.1.lint txt2bxl.1.lint pcb-rnd-svg.1.lint OUTPUT = $(OUT_HTML) $(OUT_MAN1) index.html MML = /usr/bin/mml @@ -48,6 +48,7 @@ $(SCCBOX) $(HOW) "gsch2pcb-rnd.1" "$(MAN1DIR)/gsch2pcb-rnd.1" $(SCCBOX) $(HOW) "fp2preview.1" "$(MAN1DIR)/fp2preview.1" $(SCCBOX) $(HOW) "fp2subc.1" "$(MAN1DIR)/fp2subc.1" + $(SCCBOX) $(HOW) "pcb-rnd-svg.1" "$(MAN1DIR)/pcb-rnd-svg.1" install: $(MAKE) install_all HOW="install -f" Index: pcb-rnd-svg.1 =================================================================== --- pcb-rnd-svg.1 (nonexistent) +++ pcb-rnd-svg.1 (revision 31941) @@ -0,0 +1,55 @@ +.\" pcb-rnd - manual +.\" Copyright (C) 2016 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 pcb-rnd-svg 1 2020-06-16 "" "pcb-rnd manual" +.SH NAME +pcb-rnd-svg - compare pcb-rnd svg renders +.SH SYNPOSIS +.nf +.sp +\fBpcb-rnd-svg command [\fIargs\fB] +.fi +.SH DECSRIPTION + +.BR pcb-rnd-svg +compares svg renders generated by pcb-rnd in a way that order of objects within the svg does not matter, only layering and geometry do. This is done by sorting group objects, assuming each object is a single line. +.SH OPTIONS + + +.TP + +.B svg-sort +reads a pcb-rnd generated svg on stdin, prints sorted svg: objects within each group sorted alphabetically +.TP + +.B svg-diff s1 s2 +sort pcb-rnd generated svgs s1 and s2 and print diff s1 s2; result written to stdout in diff -u format +.TP + +.B svg-vis-comp s1 s2 +generate a visual comparison of s1 and s2, diffs highlighted: - lines of the diff with blue, + lines with red in a new group, over the faded version of s1. +.TP + +.B test brd +run pcb-rnd on brd and compare the resulting svg to a saved sorted svg reference file called brd.ref +.TP + +.B test-all dir1 [dir2 dirN...] +run test on all boards with a ref available under all directories listed, recursively. +.PP + Index: pcb-rnd-svg.1.html =================================================================== --- pcb-rnd-svg.1.html (nonexistent) +++ pcb-rnd-svg.1.html (revision 31941) @@ -0,0 +1,91 @@ + + + +pcb-rnd-svg - pcb-rnd manual + + + + +

pcb-rnd-svg 1 +	2020-06-16 +	pcb-rnd manual +

+ + + +

NAME

+pcb-rnd-svg - compare pcb-rnd svg renders +

+ +

SYNPOSIS

+
+pcb-rnd-svg command [args] + + + +

+ +

DESCRIPTION

+pcb-rnd-svg compares svg renders generated by pcb-rnd in a way that order of objects within the svg does not matter, only layering and geometry do. This is done by sorting group objects, assuming each object is a single line. +

+ + +

OPTIONS

+ + + + + + + + + + + + + +
svg-sort + reads a pcb-rnd generated svg on stdin, prints sorted svg: objects within each group sorted alphabetically +
svg-diff s1 s2 + sort pcb-rnd generated svgs s1 and s2 and print diff s1 s2; result written to stdout in diff -u format +
svg-vis-comp s1 s2 + generate a visual comparison of s1 and s2, diffs highlighted: - lines of the diff with blue, + lines with red in a new group, over the faded version of s1. +
test brd + run pcb-rnd on brd and compare the resulting svg to a saved sorted svg reference file called brd.ref +
test-all dir1 [dir2 dirN...] + run test on all boards with a ref available under all directories listed, recursively. +
+

+ + +
pcb-rnd-svg 1 + 2020-06-16 + pcb-rnd manual +
+ + + Index: pcb-rnd-svg.1.mml =================================================================== --- pcb-rnd-svg.1.mml (nonexistent) +++ pcb-rnd-svg.1.mml (revision 31941) @@ -0,0 +1,49 @@ +pcb-rnd-svg +1 +2020-06-16 + + pcb-rnd-svg - compare pcb-rnd svg renders + pcb-rnd-svg command [args] + +pcb-rnd-svg compares svg renders generated by pcb-rnd in a way +that order of objects within the svg does not matter, only layering and +geometry do. This is done by sorting group objects, assuming each object +is a single line. + + + + + + svg-sort + reads a pcb-rnd generated svg on stdin, prints sorted svg: objects + within each group sorted alphabetically + + + + + svg-diff s1 s2 + sort pcb-rnd generated svgs s1 and s2 and print diff s1 s2; result + written to stdout in diff -u format + + + + svg-vis-comp s1 s2 + generate a visual comparison of s1 and s2, diffs highlighted: - lines of + the diff with blue, + lines with red in a new group, over the faded + version of s1. + + + + test brd + run pcb-rnd on brd and compare the resulting svg to a saved + sorted svg reference file called brd.ref + + + + test-all dir1 [dir2 dirN...] + run test on all boards with a ref available under all directories + listed, recursively. + + + +

svg-sort +	reads a pcb-rnd generated svg on stdin, prints sorted svg: objects within each group sorted alphabetically +
svg-diff s1 s2 +	sort pcb-rnd generated svgs s1 and s2 and print diff s1 s2; result written to stdout in diff -u format +
svg-vis-comp s1 s2 +	generate a visual comparison of s1 and s2, diffs highlighted: - lines of the diff with blue, + lines with red in a new group, over the faded version of s1. +
test brd +	run pcb-rnd on brd and compare the resulting svg to a saved sorted svg reference file called brd.ref +
test-all dir1 [dir2 dirN...] +	run test on all boards with a ref available under all directories listed, recursively. +