utils/examples/gsch2pcb/project.sample

   1 # $Id$
   2 #
   3 #           Sample poject file for gsch2pcb versions >= 1.0
   4 #
   5 # A project file may be named anything that does not end in ".sch" and placed
   6 # in your schematics and PCB working directory.  Then, running:
   7 #    gsch2pcb project.sample
   8 # is all that is required to process gschem schematic footprint and value
   9 # attribute changes into usable PCB files.  See the README and/or
  10 # run "gsch2pcb --help" for additional information.
  11 #
  12 # Some settings (elements-dir, use-files, m4-command, m4-pcbdir, and
  13 # m4-file) are candidates for placing in a ~/.gsch2pcb file so they can
  14 # be in effect for all projects by an individual user.  CAD administrators
  15 # can make appropriate settings site wide for all users by placing them
  16 # in /etc/gsch2pcb or /usr/local/etc/gsch2pcb.
  17
  18 # List all the schematics to be netlisted and layed out on the pc board.
  19 #
  20 schematics      first.sch second.sch third.sch
  21
  22 # For an output-name of foo, gsch2pcb generates files foo.net, foo.pcb,
  23 # and foo.new.pcb.  If there is no output-name specified, the file names
  24 # are derived from the first listed schematic, ie first.net, etc
  25 #
  26 output-name     foo
  27
  28
  29 # ---------- Project options related to PCB file elements  ----------------
  30 # gsch2pcb automatically searches for PCB file elements in /usr/local/pcb_lib
  31 # and ./packages (which may be a symlinks).  For additional local file element
  32 # directories, uncomment and edit elements-dir lines.
  33 #
  34 #elements-dir  ~/gaf/pcb-elements
  35 #elements-dir  /usr/local/share/pcb/newlib
  36
  37 # The default is to invoke M4 for PCB footprints.  Starting with the
  38 # 20070208 snapshot of PCB, the footprints which were generated with m4
  39 # are available as newlib footprints.  If you wish to never invoke m4
  40 # then set this variable.
  41 #
  42 #skip-m4
  43
  44 # If "skip-m4" is not specified, the default is to search for gschem footprints
  45 # first in PCB m4 files and if not found, then in PCB newlib style file
  46 # element directories.  Uncomment the use-files line to force using any
  47 # found file elements even though a m4 element may have been found first.
  48 # If skip-m4 is specified, then m4 is never run at all and use-files doesn't
  49 # really do anything.
  50 #use-files
  51
  52
  53 # ------------- Project options related to PCB m4 files -------------------
  54 # These options require gnetlist version >= 20030901
  55 #
  56 # The default m4 command is "m4".  This can specify a different command.
  57 #
  58 #m4-command     gm4
  59
  60 # The m4-pcbdir specifies where the PCB installation has its m4 database of
  61 # elements.  It is the directory where the PCB "common.m4" file is expected
  62 # to be found.  The default is /usr/X11R6/lib/X11/pcb/m4, so uncomment and
  63 # edit the following m4-pcbdir line if your PCB install is elsewhere.
  64 #
  65 #m4-pcbdir      /usr/X11R6/lib/X11/pcb/m4
  66
  67 # gsch2pcb will automatically check for the additional m4 files ./pcb.inc
  68 # and ~/.pcb/pcb.inc, but for other local m4 files, uncomment and edit
  69 # m4-file lines.
  70 #
  71 #m4-file /usr/local/share/pcb/pcb.inc
  72 #m4-file /usr/share/pcb/pcb.inc
  73
  74
  75 # ------------- Other project options -------------------
  76 #
  77 # As a convenience gsch2pcb can run extra gnetlist backend commands.
  78 # For example, to create a partslist file myproject.partslist3:
  79 #
  80 #gnetlist partslist3
  81 #
  82 # To create a partslist with a specified output file name board.parts:
  83 #
  84 #gnetlist partslist3 -o board.parts
  85
  86 # The default gsch2pcb behavior is to skip with a warning any components
  87 # with a footprint=none attribute.  So the "none" footprint can serve as a
  88 # generic place holder where multiple real footprints are candidates and the
  89 # gsch2pcb warning serves as a reminder that some real footprint should
  90 # be chosen.
  91 # However, if it is intended that components with a "none" footprint should
  92 # not be in the layout, you can suppress the warnings by specifying it as
  93 # the empty-footprint:
  94 #
  95 #empty-footprint none
  96 #
  97 # If you assign a name other than "none" to empty-footprint, then components
  98 # with that name will be omitted instead and you will need to use the verbose
  99 # option to see any warnings.  This is just a convenience way to have symbols
 100 # in a schematic which will not be mounted on the PC board and to shut up
 101 # gsch2pcb warnings about it.  But note that if you make net connections
 102 # to these symbols, they will be in the netlist and PCB will warn if the
 103 # netlist is loaded.  So, maybe connections to such parts should be drawn
 104 # with a graphical line and not a net?