Index: gsch2pcb.1 =================================================================== --- gsch2pcb.1 (revision 4315) +++ gsch2pcb.1 (nonexistent) @@ -1,134 +0,0 @@ -.TH gsch2pcb-rnd 1 "September 25th, 2013" "gEDA Project" 1.8.2.20130925 -.SH NAME -gsch2pcb-rnd - Update pcb-rnd layouts from gEDA/gaf schematics -.SH SYNOPSIS -\fBgsch2pcb-rnd\fR [\fIOPTION\fR ...] {\fIPROJECT\fR | \fIFILE\fR ...} -.SH DESCRIPTION -.PP -\fBgsch2pcb-rnd\fR is a frontend to \fBgnetlist\fR(1) which aids in -creating and updating \fBpcb-rnd\fR(1) printed circuit board layouts based -on a set of electronic schematics created with \fBgschem\fR(1). - -.PP -Instead of specifying all options and input gEDA schematic \fIFILE\fRs -on the command line, \fBgsch2pcb-rnd\fR can use a \fIPROJECT\fR file -instead. - -.PP -\fBgsch2pcb-rnd\fR first runs \fBgnetlist\fR(1) with the `PCB' backend to -create a `.net' file containing a \fBpcb-rnd\fR(1) formatted netlist for -the design. - -.PP -The second step is to run \fBgnetlist\fR(1) again with the `gsch2pcb-rnd' -backend to find any \fBM4\fR(1) elements required by the schematics. -Any missing elements are found by searching a set of file element -directories. If no `.pcb' file exists for the design yet, it is -created with the required elements; otherwise, any new elements -are output to a `.new.pcb' file. - -.PP -If a `.pcb' file exists, it is searched for elements with a -non-empty element name with no matching schematic symbol. These -elements are removed from the `.pcb' file, with a backup in a -`.pcb.bak' file. - -.PP -Finally, \fBgnetlist\fR(1) is run a third time with the `pcbpins' -backend to create a `.cmd' file. This can be loaded into -\fBpcb-rnd\fR(1) to rename all pin names in the PCB layout to match the -schematic. - -.SH OPTIONS -.TP 8 -\fB-o\fR, \fB--output-name\fR=\fIBASENAME\fR -Use output filenames `\fIBASENAME\fR.net', `\fIBASENAME\fR.pcb', and -`\fIBASENAME\fR.new.pcb'. By default, the basename of the first -schematic file in the list of input files is used. -.TP 8 -\fB-d\fR, \fB--elements-dir\fR=\fIDIRECTORY\fR -Add \fIDIRECTORY\fR to the list of directories to search for PCB file -elements. -.TP 8 -\fB-r\fR, \fB--remove-unfound\fR -Don't include references to unfound elements in the generated `.pcb' -files. Use if you want \fBpcb-rnd\fR(1) to be able to load the -(incomplete) `.pcb' file. This is enabled by default. -.TP 8 -\fB-k\fR, \fB--keep-unfound\fR -Keep include references to unfound elements in the generated `.pcb' -files. Use if you want to hand edit or otherwise preprocess the -generated `.pcb' file before running \fBpcb\fR(1). -.TP 8 -\fB-p\fR, \fB--preserve\fR -Preserve elements in PCB files which are not found in the schematics. -Since elements with an empty element name (schematic "refdes") are -never deleted, this option is rarely useful. -.TP 8 -\fB--gnetlist\fR \fIBACKEND\fR -In addition to the default backends, run \fBgnetlist\fR(1) with `\-g -\fIBACKEND\fR', with output to `.\fIBACKEND\fR'. -.TP 8 -\fB--gnetlist-arg\fR \fIARG\fR -Pass \fIARG\fR as an additional argument to \fBgnetlist\fR(1). -.TP 8 -\fB--empty-footprint\fR \fINAME\fR -If \fINAME\fR is not `none', \fBgsch2pcb-rnd\fR will not add elements for -components with that name to the PCB file. Note that if the omitted -components have net connections, they will still appear in the netlist -and \fBpcb-rnd\fR(1) will warn that they are missing. -.TP 8 -\fB--fix-elements\fR -If a schematic component's `footprint' attribute is not equal to the -`Description' of the corresponding PCB element, update the -`Description' instead of replacing the element. -.TP 8 -\fB-q\fR, \fB--quiet\fR -Don't output information on steps to take after running \fBgsch2pcb-rnd\fR. -.TP 8 -\fB-v\fR, \fB--verbose\fR -Output extra debugging information. This option can be specified -twice (`\-v \-v') to obtain additional debugging for file elements. -.TP 8 -\fB-h\fR, \fB--help\fR -Print a help message. -.TP 8 -\fB-V\fR, \fB--version\fR -Print \fBgsch2pcb-rnd\fR version information. - -.SH PROJECT FILES -.PP -A \fBgsch2pcb-rnd\fR project file is a file (not ending in `.sch') -containing a list of schematics to process and some options. Any -long-form command line option can appear in the project file with the -leading `\-\-' removed, with the exception of `\-\-gnetlist-arg', -`\-\-fix-elements', `\-\-verbose', and `\-\-version'. Schematics should be -listed on a line beginning with `schematics'. -.PP -An example project file might look like: - -.nf - schematics partA.sch partB.sch - output-name design -.ad b - -.SH ENVIRONMENT -.TP 8 -.B GNETLIST -specifies the \fBgnetlist\fR(1) program to run. The default is -`gnetlist'. - -.SH AUTHORS -See the `AUTHORS' file included with this program. - -.SH COPYRIGHT -.nf -Copyright \(co 1999-2011 gEDA Contributors. License GPLv2+: GNU GPL -version 2 or later. Please see the `COPYING' file included with this -program for full details. -.PP -This is free software: you are free to change and redistribute it. -There is NO WARRANTY, to the extent permitted by law. - -.SH SEE ALSO -\fBgschem\fR(1), \fBgnetlist\fR(1), \fBpcb-rnd\fR(1) Index: gsch2pcb-rnd.1 =================================================================== --- gsch2pcb-rnd.1 (nonexistent) +++ gsch2pcb-rnd.1 (revision 4316) @@ -0,0 +1,134 @@ +.TH gsch2pcb-rnd 1 "September 25th, 2013" "gEDA Project" 1.8.2.20130925 +.SH NAME +gsch2pcb-rnd - Update pcb-rnd layouts from gEDA/gaf schematics +.SH SYNOPSIS +\fBgsch2pcb-rnd\fR [\fIOPTION\fR ...] {\fIPROJECT\fR | \fIFILE\fR ...} +.SH DESCRIPTION +.PP +\fBgsch2pcb-rnd\fR is a frontend to \fBgnetlist\fR(1) which aids in +creating and updating \fBpcb-rnd\fR(1) printed circuit board layouts based +on a set of electronic schematics created with \fBgschem\fR(1). + +.PP +Instead of specifying all options and input gEDA schematic \fIFILE\fRs +on the command line, \fBgsch2pcb-rnd\fR can use a \fIPROJECT\fR file +instead. + +.PP +\fBgsch2pcb-rnd\fR first runs \fBgnetlist\fR(1) with the `PCB' backend to +create a `.net' file containing a \fBpcb-rnd\fR(1) formatted netlist for +the design. + +.PP +The second step is to run \fBgnetlist\fR(1) again with the `gsch2pcb-rnd' +backend to find any \fBM4\fR(1) elements required by the schematics. +Any missing elements are found by searching a set of file element +directories. If no `.pcb' file exists for the design yet, it is +created with the required elements; otherwise, any new elements +are output to a `.new.pcb' file. + +.PP +If a `.pcb' file exists, it is searched for elements with a +non-empty element name with no matching schematic symbol. These +elements are removed from the `.pcb' file, with a backup in a +`.pcb.bak' file. + +.PP +Finally, \fBgnetlist\fR(1) is run a third time with the `pcbpins' +backend to create a `.cmd' file. This can be loaded into +\fBpcb-rnd\fR(1) to rename all pin names in the PCB layout to match the +schematic. + +.SH OPTIONS +.TP 8 +\fB-o\fR, \fB--output-name\fR=\fIBASENAME\fR +Use output filenames `\fIBASENAME\fR.net', `\fIBASENAME\fR.pcb', and +`\fIBASENAME\fR.new.pcb'. By default, the basename of the first +schematic file in the list of input files is used. +.TP 8 +\fB-d\fR, \fB--elements-dir\fR=\fIDIRECTORY\fR +Add \fIDIRECTORY\fR to the list of directories to search for PCB file +elements. +.TP 8 +\fB-r\fR, \fB--remove-unfound\fR +Don't include references to unfound elements in the generated `.pcb' +files. Use if you want \fBpcb-rnd\fR(1) to be able to load the +(incomplete) `.pcb' file. This is enabled by default. +.TP 8 +\fB-k\fR, \fB--keep-unfound\fR +Keep include references to unfound elements in the generated `.pcb' +files. Use if you want to hand edit or otherwise preprocess the +generated `.pcb' file before running \fBpcb\fR(1). +.TP 8 +\fB-p\fR, \fB--preserve\fR +Preserve elements in PCB files which are not found in the schematics. +Since elements with an empty element name (schematic "refdes") are +never deleted, this option is rarely useful. +.TP 8 +\fB--gnetlist\fR \fIBACKEND\fR +In addition to the default backends, run \fBgnetlist\fR(1) with `\-g +\fIBACKEND\fR', with output to `.\fIBACKEND\fR'. +.TP 8 +\fB--gnetlist-arg\fR \fIARG\fR +Pass \fIARG\fR as an additional argument to \fBgnetlist\fR(1). +.TP 8 +\fB--empty-footprint\fR \fINAME\fR +If \fINAME\fR is not `none', \fBgsch2pcb-rnd\fR will not add elements for +components with that name to the PCB file. Note that if the omitted +components have net connections, they will still appear in the netlist +and \fBpcb-rnd\fR(1) will warn that they are missing. +.TP 8 +\fB--fix-elements\fR +If a schematic component's `footprint' attribute is not equal to the +`Description' of the corresponding PCB element, update the +`Description' instead of replacing the element. +.TP 8 +\fB-q\fR, \fB--quiet\fR +Don't output information on steps to take after running \fBgsch2pcb-rnd\fR. +.TP 8 +\fB-v\fR, \fB--verbose\fR +Output extra debugging information. This option can be specified +twice (`\-v \-v') to obtain additional debugging for file elements. +.TP 8 +\fB-h\fR, \fB--help\fR +Print a help message. +.TP 8 +\fB-V\fR, \fB--version\fR +Print \fBgsch2pcb-rnd\fR version information. + +.SH PROJECT FILES +.PP +A \fBgsch2pcb-rnd\fR project file is a file (not ending in `.sch') +containing a list of schematics to process and some options. Any +long-form command line option can appear in the project file with the +leading `\-\-' removed, with the exception of `\-\-gnetlist-arg', +`\-\-fix-elements', `\-\-verbose', and `\-\-version'. Schematics should be +listed on a line beginning with `schematics'. +.PP +An example project file might look like: + +.nf + schematics partA.sch partB.sch + output-name design +.ad b + +.SH ENVIRONMENT +.TP 8 +.B GNETLIST +specifies the \fBgnetlist\fR(1) program to run. The default is +`gnetlist'. + +.SH AUTHORS +See the `AUTHORS' file included with this program. + +.SH COPYRIGHT +.nf +Copyright \(co 1999-2011 gEDA Contributors. License GPLv2+: GNU GPL +version 2 or later. Please see the `COPYING' file included with this +program for full details. +.PP +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + +.SH SEE ALSO +\fBgschem\fR(1), \fBgnetlist\fR(1), \fBpcb-rnd\fR(1)