Index: trunk/doc-rnd/man/gsch2pcb.1 =================================================================== --- trunk/doc-rnd/man/gsch2pcb.1 (revision 4313) +++ trunk/doc-rnd/man/gsch2pcb.1 (revision 4314) @@ -1,26 +1,26 @@ -.TH gsch2pcb 1 "September 25th, 2013" "gEDA Project" 1.8.2.20130925 +.TH gsch2pcb-rnd 1 "September 25th, 2013" "gEDA Project" 1.8.2.20130925 .SH NAME -gsch2pcb - Update PCB layouts from gEDA/gaf schematics +gsch2pcb-rnd - Update pcb-rnd layouts from gEDA/gaf schematics .SH SYNOPSIS -\fBgsch2pcb\fR [\fIOPTION\fR ...] {\fIPROJECT\fR | \fIFILE\fR ...} +\fBgsch2pcb-rnd\fR [\fIOPTION\fR ...] {\fIPROJECT\fR | \fIFILE\fR ...} .SH DESCRIPTION .PP -\fBgsch2pcb\fR is a frontend to \fBgnetlist\fR(1) which aids in -creating and updating \fBpcb\fR(1) printed circuit board layouts based +\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\fR can use a \fIPROJECT\fR file +on the command line, \fBgsch2pcb-rnd\fR can use a \fIPROJECT\fR file instead. .PP -\fBgsch2pcb\fR first runs \fBgnetlist\fR(1) with the `PCB' backend to -create a `.net' file containing a \fBpcb\fR(1) formatted netlist for +\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' +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 @@ -36,7 +36,7 @@ .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\fR(1) to rename all pin names in the PCB layout to match the +\fBpcb-rnd\fR(1) to rename all pin names in the PCB layout to match the schematic. .SH OPTIONS @@ -48,29 +48,11 @@ .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. By default, the following directories are searched if they -exist: `./packages', `/usr/local/share/pcb/newlib', -`/usr/share/pcb/newlib', `/usr/local/lib/pcb_lib', `/usr/lib/pcb_lib', -`/usr/local/pcb_lib'. +elements. .TP 8 -\fB-f\fR, \fB--use-files\fR -Force use of file elements in preference to elements generated with -\fBM4\fR(1). -.TP 8 -\fB-s\fR, \fB--skip-m4\fR -Disable element generation using \fBM4\fR(1) entirely. -.TP 8 -\fB--m4-file\fR \fIFILE\fR -Use the \fBM4\fR(1) file \fIFILE\fR in addition to the default M4 -files `./pcb.inc' and `~/.pcb/pcb.inc'. -.TP 8 -\fB--m4-pcbdir\fR \fIDIRECTORY\fR -Set \fIDIRECTORY\fR as the directory where \fBgsch2pcb\fR should look -for \fBM4\fR(1) files installed by \fBpcb\fR(1). -.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\fR(1) to be able to load the +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 @@ -91,10 +73,10 @@ 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\fR will not add elements for +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\fR(1) will warn that they are missing. +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 @@ -102,7 +84,7 @@ `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\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 @@ -112,11 +94,11 @@ Print a help message. .TP 8 \fB-V\fR, \fB--version\fR -Print \fBgsch2pcb\fR version information. +Print \fBgsch2pcb-rnd\fR version information. .SH PROJECT FILES .PP -A \fBgsch2pcb\fR project file is a file (not ending in `.sch') +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', @@ -149,4 +131,4 @@ There is NO WARRANTY, to the extent permitted by law. .SH SEE ALSO -\fBgschem\fR(1), \fBgnetlist\fR(1), \fBpcb\fR(1) +\fBgschem\fR(1), \fBgnetlist\fR(1), \fBpcb-rnd\fR(1)