Updated all ChangeLogs by running ./update-changelogs.sh 1.0-20070526..master
[geda-gaf.git] / gnetlist / docs / README.pcb
blob2b69726fe5e48cc050c3e1958a25c07d8e267284
1 ------------------------------------------------------------------
2 JM Routoure. routoure@greyc.ismra.fr
3 17/01/2000
5 I would like to thank Stefan Petersen for debuging the scheme program.
7 -------------------------------------------------------------------
10 This document describes how to install (section I) and use (section II) the
11 gschem2pcb package. Section III describes some of the footprints
12 available in pcb
14 The purpose of this package is to interface gschem with pcb. It uses a scheme 
15 program and a script.
18 Section I : Installation.
20 1. Untar the gschem2pcb.tar. You must obtain 3 files gschem2pcb.sh, 
21 GNET-PCBboard.scm and the README file.
23 2. Move gschem2pcb.sh in a directory which is in your PATH (/usr/local/bin for
24 instance ). Be sure that gschem2pcb.sh can be executed (chmod 755 gschem2pcb.sh)
26 3. Move GNET-PCBboard.scm in the share directory of your gEDA distribution.
27 Normally, it should be /usr/local/share/gEDA/scheme.
29 4. Modify the common.m4 file of the pcb program (should be found in
30 /usr/X11R6/lib/X11/pcb/m4/) like this : the include keywords at the end of the
31 file  must be replace by
33 include(/usr/X11R6/lib/X11/pcb/m4/connector.inc)
34 include(/usr/X11R6/lib/X11/pcb/m4/dil.inc)
35 include(/usr/X11R6/lib/X11/pcb/m4/misc.inc)
36 include(/usr/X11R6/lib/X11/pcb/m4/plcc.inc)
37 include(/usr/X11R6/lib/X11/pcb/m4/to.inc)
38 include(/usr/X11R6/lib/X11/pcb/m4/qfp.inc)
40 5. Edit the ~/.gEDA/gschemrc file and be sure that the following line exists : 
41 (attribute-name "footprint")
44 6. Be sure that grep, sed and gawk are installed. That's all..
47 Section II : using gschem2pcb.
49 1. With gschem, create a schematic. All the device you want to have in pcb must
50 have a Uref attribute. The footprint that you want to use in pcb are indicated
51 by the footprint attribute (see section III for the description of the footprint
52 in pcb)
54 Be careful that the attributes Uref, name, value and device must not contain 
55 space char.
56 --------------------------------------------------------
58 2. Save your work (ultralownoise.sch for instance -ambitious design!) and type in a shell
60         gschem2pcb.sh ultralownoise.sch.
62 note : the gschem file must end by .sch
64 Error messages will appear if some space characters are found in the
65 attributes Uref, name, value and device and if the name of the footprint was not
66 found. Warning, pcb files are created even if errors occur!
68 - if  ultralownoise.pcb does not exist, it will be created. A netlist file
69 ultralownoise.net will also be created. In pcb, load the pcb (load layout). All
70 the footprints will appears at the top-left corner of the windows. Load the
71 netlist (load netlist file) and type the key "w". Place the footprints and type
72 "o" to optimize the rastnet. See the pcb documentation for details.
74 - if  ultralownoise.pcb exists, a ultralownoise.new.pcb file should be
75 created. It should contain only the new device that have been added in the
76 schematic since the last save of the ultralownoise.pcb file. Use "load layout
77 data to paste buffer" to include the new footprints in the pcb file. The nestlist
78 file is also updated so read it again. 
81 Section III. Description of the name of the footprint in pcb. 
82 pcb uses macro to define the footprints. For DIL packages, for instance, 2
83 arguments are used to indicate the number of pins and the width in mil of the
84 footprint. In gschem the footprint attribute of a 300 mil width and 8 pins DIL
85 is: 
86 DIL 8 300.
87 Warning, for that attribute, you have to included the space char!
89 In the following. I describe the footprint attribute that are to be used in
90 gschem for the footprint avalaible in pcb. N stands
91 for the number of pins, W the width in mil, L the length in mil and D the
92 diameter in mil
93 CONNECTOR ROWS COLS     # single connector
94 DIN41_651LAY N          # DIN 41.651 laying
95 DIN41_651STAND N        # DIN 41.651 standing
96 SUBD_LAY_BASE N         # SUB-D connector laying
97 SUBD_MALE_LAY_BASE N    # SUB-D connector male laying
98 SUBD_FEMALE_LAY_BASE N  # SUB-D connector female laying
99 DIL N W                 # dual-inline standard
100 D N                     # dual inline with W=244
101 DW N                    # dual inline with W=419
102 SD N                    # SD (ZIP) 
103 MULTIWATT15             # 15 pins multiwatt footprint
104 R025                    # standard 1/4W resistor !now attributes
105 SIL N                   # SIL 
106 CSIL                    # SIL package with a common pin
107 QFP132                  # QFP132 flat pack
108 LED D                   # standing LED
109 DIODE_LAY L             # laying diode
110 AXIAL_LAY L             # standard axial footprint
111 CRYSTAL W               # crystal package
112 OSC                     # a can oscillator
113 ISA8                    # 8 bit ISA Slot card
114 OVEN_OSC                # ovenized-oscillator package
115 RADIAL_CAN W            # a radial capcitor package
116 PLCC N                  # pllc
117 PLCC N add              # pllc with additionnal border add
118 QFP N add               # qfp   with additionnal border add
119 No additional parameters for the to footprints
120 TO3_90
121 TO3_45
123 TO92
124 TO126
125 TO126LAY-WIDE
126 TO126STAND-WIDE
127 TO220
128 TO220LAY-WIDE
129 TO220STAND
130 TO220STAND-WIDE