Downloaded and integrated latest wiki documentation from the geda website.
[geda-gaf/peter-b.git] / docs / wiki / geda_master_attributes_list.html
blobf6cf8a9bc412e078712c72c7df87212ecba8eb47
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
4 lang="en" dir="ltr">
5 <head>
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7 <title>geda:master_attributes_list</title>
8 <meta name="generator" content="DokuWiki Release rc2007-05-24" />
9 <meta name="robots" content="index,follow" />
10 <meta name="date" content="2007-05-24T22:27:25-0400" />
11 <meta name="keywords" content="geda,master_attributes_list" />
12 <link rel="search" type="application/opensearchdescription+xml" href="http://geda.seul.org/wiki/lib/exe/opensearch.php" title="geda Wiki" />
13 <link rel="start" href="http://geda.seul.org/wiki/" />
14 <link rel="contents" href="http://geda.seul.org/wiki/geda:master_attributes_list?do=index" title="Index" />
15 <link rel="alternate" type="application/rss+xml" title="Recent Changes" href="http://geda.seul.org/wiki/feed.php" />
16 <link rel="alternate" type="application/rss+xml" title="Current Namespace" href="http://geda.seul.org/wiki/feed.php?mode=list&ns=geda" />
17 <link rel="alternate" type="text/html" title="Plain HTML" href="http://geda.seul.org/wiki/_export/xhtml/geda:master_attributes_list" />
18 <link rel="alternate" type="text/plain" title="Wiki Markup" href="http://geda.seul.org/wiki/_export/raw/geda:master_attributes_list" />
19 <link rel="stylesheet" media="all" type="text/css" href="lib/exe/css" />
20 <link rel="stylesheet" media="screen" type="text/css" href="lib/exe/001css" />
21 <link rel="stylesheet" media="print" type="text/css" href="lib/exe/002css" />
22 </head>
23 <body>
24 <div class="dokuwiki export">
25 <div class="toc">
26 <div class="tocheader toctoggle" id="toc__header">Table of Contents</div>
27 <div id="toc__inside">
29 <ul class="toc">
30 <li class="level1"><div class="li"><span class="li"><a href="#geda_gaf_master_attribute_document" class="toc">gEDA/gaf Master Attribute Document</a></span></div>
31 <ul class="toc">
32 <li class="level2"><div class="li"><span class="li"><a href="#overview" class="toc">Overview</a></span></div></li>
33 <li class="level2"><div class="li"><span class="li"><a href="#what_are_attributes" class="toc">What are Attributes?</a></span></div></li>
34 <li class="level2"><div class="li"><span class="li"><a href="#symbol_only_attributes" class="toc">Symbol only Attributes</a></span></div>
35 <ul class="toc">
36 <li class="level3"><div class="li"><span class="li"><a href="#device" class="toc">device</a></span></div></li>
37 <li class="level3"><div class="li"><span class="li"><a href="#graphical" class="toc">graphical</a></span></div></li>
38 <li class="level3"><div class="li"><span class="li"><a href="#description" class="toc">description</a></span></div></li>
39 <li class="level3"><div class="li"><span class="li"><a href="#author" class="toc">author</a></span></div></li>
40 <li class="level3"><div class="li"><span class="li"><a href="#comment" class="toc">comment</a></span></div></li>
41 <li class="level3"><div class="li"><span class="li"><a href="#pinseq" class="toc">pinseq</a></span></div></li>
42 <li class="level3"><div class="li"><span class="li"><a href="#pinnumber" class="toc">pinnumber</a></span></div></li>
43 <li class="level3"><div class="li"><span class="li"><a href="#pintype" class="toc">pintype</a></span></div></li>
44 <li class="level3"><div class="li"><span class="li"><a href="#pinlabel" class="toc">pinlabel</a></span></div></li>
45 <li class="level3"><div class="li"><span class="li"><a href="#numslots" class="toc">numslots</a></span></div></li>
46 <li class="level3"><div class="li"><span class="li"><a href="#slotdef" class="toc">slotdef</a></span></div></li>
47 <li class="level3"><div class="li"><span class="li"><a href="#footprint" class="toc">footprint</a></span></div></li>
48 <li class="level3"><div class="li"><span class="li"><a href="#documentation" class="toc">documentation</a></span></div></li>
49 </ul>
50 </li>
51 <li class="level2"><div class="li"><span class="li"><a href="#schematic_only_attributes" class="toc">Schematic only Attributes</a></span></div>
52 <ul class="toc">
53 <li class="level3"><div class="li"><span class="li"><a href="#netname" class="toc">netname</a></span></div></li>
54 <li class="level3"><div class="li"><span class="li"><a href="#source" class="toc">source</a></span></div></li>
55 </ul>
56 </li>
57 <li class="level2"><div class="li"><span class="li"><a href="#symbol_and_schematic_attributes" class="toc">Symbol and Schematic Attributes</a></span></div>
58 <ul class="toc">
59 <li class="level3"><div class="li"><span class="li"><a href="#refdes" class="toc">refdes</a></span></div></li>
60 <li class="level3"><div class="li"><span class="li"><a href="#slot" class="toc">slot</a></span></div></li>
61 <li class="level3"><div class="li"><span class="li"><a href="#net" class="toc">net</a></span></div></li>
62 <li class="level3"><div class="li"><span class="li"><a href="#value" class="toc">value</a></span></div></li>
63 <li class="level3"><div class="li"><span class="li"><a href="#symversion" class="toc">symversion</a></span></div></li>
64 </ul>
65 </li>
66 <li class="level2"><div class="li"><span class="li"><a href="#obsolete_attributes" class="toc">Obsolete Attributes</a></span></div>
67 <ul class="toc">
68 <li class="level3"><div class="li"><span class="li"><a href="#uref" class="toc">uref</a></span></div></li>
69 <li class="level3"><div class="li"><span class="li"><a href="#name" class="toc">name</a></span></div></li>
70 <li class="level3"><div class="li"><span class="li"><a href="#label" class="toc">label</a></span></div></li>
71 <li class="level3"><div class="li"><span class="li"><a href="#pin" class="toc">pin#</a></span></div></li>
72 <li class="level3"><div class="li"><span class="li"><a href="#slot1" class="toc">slot#</a></span></div></li>
73 <li class="level3"><div class="li"><span class="li"><a href="#type" class="toc">type</a></span></div></li>
74 <li class="level3"><div class="li"><span class="li"><a href="#email" class="toc">email</a></span></div></li>
75 </ul>
76 </li>
77 <li class="level2"><div class="li"><span class="li"><a href="#document_revision_history" class="toc">Document Revision History</a></span></div></li></ul>
78 </li></ul>
79 </div>
80 </div>
84 <h1><a name="geda_gaf_master_attribute_document" id="geda_gaf_master_attribute_document">gEDA/gaf Master Attribute Document</a></h1>
85 <div class="level1">
87 <p>
88 by: Ales V. Hvezda, ahvezda@geda.seul.org
89 </p>
91 <p>
92 This document is released under <a href="http://www.gnu.org/copyleft/fdl.html" class="urlextern" title="http://www.gnu.org/copyleft/fdl.html" rel="nofollow">GFDL</a>
93 </p>
95 <p>
96 July 6th, 2004
97 </p>
99 </div>
100 <!-- SECTION "gEDA/gaf Master Attribute Document" [1-187] -->
101 <h2><a name="overview" id="overview">Overview</a></h2>
102 <div class="level2">
105 This document describes all the attributes used in in gEDA/gaf (<acronym title="GNU General Public License">GPL</acronym>‘d Electronic Design Automation / Gschem And Friends). This document is broken down into several section: this overview, symbol only attributes, schematic only attributes, attributes which can appear in both symbols and schematics, and attributes which are obsolete or deprecated.<br/>
106 In this document, attribute names are in <strong>bold</strong> and examples are in the <code>typewriter</code> font.
107 </p>
109 </div>
110 <!-- SECTION "Overview" [188-654] -->
111 <h2><a name="what_are_attributes" id="what_are_attributes">What are Attributes?</a></h2>
112 <div class="level2">
115 Attributes in the gEDA/gaf system are nothing more than text items which take on the form: <strong>name</strong>=value. Name can be anything just as long as it doesn’t contain a equals sign. Value can also be anything just as long as it is something (vs nothing). <strong>name</strong>= (without a value part) is not a valid attribute. Also, there cannot be any spaces immediately before or after the equals sign.<br/>
116 Attributes can be attached to some part of the symbol. If the attribute conveys information specific to an object, then the attribute should be attached directly to the object, otherwise the attribute should be free standing or floating. Free standing attributes just exist in the symbol file as text items which take on the form <strong>name</strong>=value.
117 </p>
119 </div>
120 <!-- SECTION "What are Attributes?" [655-1425] -->
121 <h2><a name="symbol_only_attributes" id="symbol_only_attributes">Symbol only Attributes</a></h2>
122 <div class="level2">
124 </div>
125 <!-- SECTION "Symbol only Attributes" [1426-1461] -->
126 <h3><a name="device" id="device">device</a></h3>
127 <div class="level3">
130 <strong>device</strong>= is the device name of the symbol and is required by gnetlist.<br/>
131 <strong>device</strong>= should be placed somewhere in the symbol and made invisible. This is a free standing or floating attribute. If the object is a graphic then <strong>device</strong>= should be set to none (<strong>device</strong>=none) and attach a <a href="#graphical" title="geda:master_attributes_list &crarr;" class="wikilink1">graphical</a>= attribute. Do not confuse this attribute with just having a text label which the device name. Do not put spaces into the device name; there are some programs which dislike spaces in the device specifier. Generally the device name is in all caps.<br/>
132 Examples: <code>device=7400 device=CONNECTOR 10 device=NPN TRANSISTOR</code>
133 </p>
135 </div>
136 <!-- SECTION "device" [1462-2105] -->
137 <h3><a name="graphical" id="graphical">graphical</a></h3>
138 <div class="level3">
141 Symbols which have no electrical or circuit significance need a <strong>graphical</strong>=1 attribute. Symbols like titleboxes are purely graphical symbols. Any symbol which has <strong>graphical</strong>=1 is ignored by gnetlist.<br/>
142 <strong>graphical</strong>=1 should exist somewhere in the symbol and made invisible. This is a free standing or floating attribute. Don’t forget to set <a href="#device" title="geda:master_attributes_list &crarr;" class="wikilink1">device</a>=none.<br/>
143 Example: <code>graphical=1</code>
144 </p>
146 </div>
147 <!-- SECTION "graphical" [2106-2520] -->
148 <h3><a name="description" id="description">description</a></h3>
149 <div class="level3">
152 The <strong>description</strong> attribute provides a simple one line description of what the symbol is supposed to represent.<br/>
153 Example: <code>description=4 NAND gates with 2 inputs</code>
154 </p>
156 </div>
157 <!-- SECTION "description" [2521-2711] -->
158 <h3><a name="author" id="author">author</a></h3>
159 <div class="level3">
162 The <strong>author</strong> attribute identifies the name of the author of this symbol and their e-mail address. This attribute is optional, but it is nice to know who created which symbols. It also serves the purpose of known who to contact if there are questions about the intent(s) of the symbol. This attribute is free form and it can also include people’s names who modified the symbol as well as multiple e-mail addresses. It is probably also a good idea to obfuscate the e-mail address so it is not harvested for spam purposes.<br/>
163 Example: <code>author=Ales Hvezda ahvezdaATgeda.seul.org</code>
164 </p>
166 </div>
167 <!-- SECTION "author" [2712-3308] -->
168 <h3><a name="comment" id="comment">comment</a></h3>
169 <div class="level3">
172 The <code>comment</code> attribute can contain anything. This attribute can convey any additional information which might not fit into any other attribute. There can be multiple instances of this attribute.<br/>
173 Example: <code>comment=This is a comment inside a symbol</code>
174 </p>
176 </div>
177 <!-- SECTION "comment" [3309-3582] -->
178 <h3><a name="pinseq" id="pinseq">pinseq</a></h3>
179 <div class="level3">
182 This attribute is used to give each pin an unique number or sequence. All pins must have a <strong>pinseq</strong>=# attribute attached to the pin object. This attribute should be hidden. This attribute is used extensively by gschem and gnetlist.<br/>
183 In some backends (especially the SPICE backend), gnetlist will output pins in the order of increasing pin sequence. The sequence numbers start at 1 and should increase without skipping any numbers. This attribute is not the pin number (i.e. device pin numbers, like GND is 7 on TTL). For pin numbers see the <a href="#pinnumber" title="geda:master_attributes_list &crarr;" class="wikilink1">pinnumber</a> attribute.<br/>
184 Examples: <code>pinseq=1 pinseq=2 pinseq=3</code><br/>
186 </p>
189 This attribute replaces the obsolete <strong>pin#</strong>=# attribute.
190 </p>
192 </div>
193 <!-- SECTION "pinseq" [3583-4275] -->
194 <h3><a name="pinnumber" id="pinnumber">pinnumber</a></h3>
195 <div class="level3">
198 This attribute is the pin number (i.e. like GND is 7 on 74 TTL). All pins must have a <strong>pinnumber</strong>=# attribute attached to the pin object.<br/>
199 You can have numbers or letters for the value. This attribute should be visible with the value only visible. You also need a <a href="#pinseq" title="geda:master_attributes_list &crarr;" class="wikilink1">pinseq</a> attribute.<br/>
200 Examples: <code>pinnumber=1 pinnumber=13 pinnumber=A0</code><br/>
202 </p>
205 This attribute replaces the obsolete pin#=# attribute.
206 </p>
208 </div>
209 <!-- SECTION "pinnumber" [4276-4698] -->
210 <h3><a name="pintype" id="pintype">pintype</a></h3>
211 <div class="level3">
214 Each pin must have a <strong>pintype</strong>=value attribute attached to it and should be make hidden. Table 1 shows valid values for this attribute.<br/>
215 This attribute is not used extensively in the symbol library, but it will be used for DRC and netlisting.<br/>
216 Examples: <code>pintype=clk pintype=in pintype=pas</code><br/>
218 </p>
219 <table class="inline">
220 <tr>
221 <td>in</td><td>Input</td>
222 </tr>
223 <tr>
224 <td>out</td><td>Output</td>
225 </tr>
226 <tr>
227 <td>io</td><td>Input/Output</td>
228 </tr>
229 <tr>
230 <td>oc</td><td>Open collector</td>
231 </tr>
232 <tr>
233 <td>oe</td><td>Open emitter</td>
234 </tr>
235 <tr>
236 <td>pas</td><td>Passive</td>
237 </tr>
238 <tr>
239 <td>tp</td><td>Totem pole</td>
240 </tr>
241 <tr>
242 <td>tri</td><td>Tristate (high impedance)</td>
243 </tr>
244 <tr>
245 <td>clk</td><td>Clock</td>
246 </tr>
247 <tr>
248 <td>pwr</td><td>Power/Ground</td>
249 </tr>
250 <tr>
251 <td colspan="2">Table 1: pintype values</td>
252 </tr>
253 </table>
255 </div>
256 <!-- SECTION "pintype" [4699-5217] -->
257 <h3><a name="pinlabel" id="pinlabel">pinlabel</a></h3>
258 <div class="level3">
261 This attribute labels a pin object. This attribute is primarily used by gnetlist to support hierarchical designs.<br/>
262 This attribute must be attached to the pin and be left visible. Please make this attribute green (instead of the default attribute yellow).<br/>
263 Examples: <code>pinlabel=A0 pinlabel=DATA1 pinlabel=CLK</code><br/>
265 </p>
267 </div>
268 <!-- SECTION "pinlabel" [5218-5551] -->
269 <h3><a name="numslots" id="numslots">numslots</a></h3>
270 <div class="level3">
273 If a component has multiple slots in a physical package (such as a 7400 (NAND) which has 4 NANDs per package) then you need a <strong>numslots</strong>=# attribute. The # is the number of slots that are in a physical device. <strong>numslots</strong>=# should exist somewhere in the symbol and be made invisible. This is a free standing or floating attribute. If the symbol does not need slotting, then put <strong>numslots</strong>=0 into the symbol file.<br/>
274 Example: <code>numslots=4</code>
275 </p>
277 </div>
278 <!-- SECTION "numslots" [5552-6015] -->
279 <h3><a name="slotdef" id="slotdef">slotdef</a></h3>
280 <div class="level3">
283 If a component has multiple slots in a physical package then you must attach a <strong>slotdef</strong>=slotnumber:#,#,#&hellip; for every device inside the physical package.<br/>
284 The slotnumber corresponds to the slot number. The colon after the slot number is required. For example, if a device has 4 slots then there would be <strong>slotdef</strong>=1:&hellip;, <strong>slotdef</strong>=2:&hellip;, <strong>slotdef</strong>=3:&hellip;, and slotdef=4:&hellip; attributes somewhere in the symbol and be made invisible. This is a free standing or floating attribute.<br/>
285 The #‘s have a one-to-one correspondence to the <strong>pinseq</strong> attributes and specify which <strong>pinnumber</strong>=# is used during display (gschem) or netlisting (gnetlist).<br/>
286 It is recommended that all symbols which have slots have a <a href="#slot" title="geda:master_attributes_list &crarr;" class="wikilink1">slot</a>=1 attribute attached in the same fashion as the <a href="#device" title="geda:master_attributes_list &crarr;" class="wikilink1">device</a>= attribute.<br/>
287 See 7400-1.sym as a concrete example.<br/>
288 Examples: <code>slotdef=1:1,2,3 slotdef=2:4,5,6 slotdef=3:7,8,9</code><br/>
289 This attribute replaces the obsolete <strong>slot</strong>#=# attribute.
290 </p>
292 </div>
293 <!-- SECTION "slotdef" [6016-6996] -->
294 <h3><a name="footprint" id="footprint">footprint</a></h3>
295 <div class="level3">
298 <strong>footprint</strong>=package name should exist somewhere in the symbol and be made invisible. This attribute is used by gnetlist and primarily for the PCB package.<br/>
299 Attach this attribute just like the <a href="#device" title="geda:master_attributes_list &crarr;" class="wikilink1">device</a>= attribute. This is a free standing or floating attribute.<br/>
300 package name is the pcb footprint or package type like DIP14 or DIP40. Although this attribute in principle is pcb package dependent, gEDA/gaf conventions exist to make this attribute as portable as possible, allowing for easy collaboration and sharing between users. See the <a href="http://geda.seul.org/wiki/geda:scg#footprint_naming_conventions" class="wikilink1" title="geda:scg">Footprint naming conventions in the Symbol Creation Guide</a>.<br/>
301 If the symbol does not have a footprint, then the value of <strong>footprint</strong>= should be set to none. If the footprint must be overridden in a schematic, then the value of <strong>footprint</strong>= should be set to none. If the footprint is not known, then the value of footprint= should be set to unknown.
302 </p>
304 </div>
305 <!-- SECTION "footprint" [6997-7955] -->
306 <h3><a name="documentation" id="documentation">documentation</a></h3>
307 <div class="level3">
310 <strong>documentation</strong>=documentation_locator may exist somewhere in the symbol and be made invisible. This attribute is used by gschemdoc to find relevant documentation for the symbol, or rather, the device or component associated with the symbol.<br/>
311 Attach this attribute just like the <a href="#device" title="geda:master_attributes_list &crarr;" class="wikilink1">device</a>= attribute. This is a freestanding or floating attribute.<br/>
312 documentation_locator is either the base filename of the documentation, or it is the complete Internet <acronym title="Uniform Resource Locator">URL</acronym> (Uniform Resource Locator). If it is the filename, an attempt will be made to search for it in the local gEDA share directory named <strong>documentation</strong>.<br/>
313 Filename example: <code>documentation=sn74ls00.pdf</code><br/>
314 <acronym title="Uniform Resource Locator">URL</acronym> example: <code>documentation=<a href="http://www-s.ti.com/sc/ds/sn74ls00.pdf" class="urlextern" title="http://www-s.ti.com/sc/ds/sn74ls00.pdf" rel="nofollow">http://www-s.ti.com/sc/ds/sn74ls00.pdf</a></code>
315 </p>
317 </div>
318 <!-- SECTION "documentation" [7956-8714] -->
319 <h2><a name="schematic_only_attributes" id="schematic_only_attributes">Schematic only Attributes</a></h2>
320 <div class="level2">
322 </div>
323 <!-- SECTION "Schematic only Attributes" [8715-8752] -->
324 <h3><a name="netname" id="netname">netname</a></h3>
325 <div class="level3">
328 This attribute should be attached to a net object to give it a name. Multiple net names for connected net segments is discouraged. All nets which have the same value are considered electrically connected. This attribute is not valid inside symbols (as you cannot have nets inside of symbols).<br/>
329 Examples: <code>netname=DATA0 H netname=CLK L</code><br/>
331 </p>
333 </div>
334 <!-- SECTION "netname" [8753-9112] -->
335 <h3><a name="source" id="source">source</a></h3>
336 <div class="level3">
339 The source= attribute is used to specify that a symbol has underlying schematics. This attribute is attached directly to a component.<br/>
340 This attribute should only be attached to instantiated components in schematics. Attach the attribute to a component and specify the filename (not the path) of the underlying schematic (like block.sch) for the value. The specified schematic must be in a source-library path. This attribute can be attached multiple times with difierent values which basically means that there are multiple underlying schematics.<br/>
341 Examples: <code>source=underlying.sch source=memory.sch</code>
342 </p>
344 </div>
345 <!-- SECTION "source" [9113-9734] -->
346 <h2><a name="symbol_and_schematic_attributes" id="symbol_and_schematic_attributes">Symbol and Schematic Attributes</a></h2>
347 <div class="level2">
349 </div>
350 <!-- SECTION "Symbol and Schematic Attributes" [9735-9779] -->
351 <h3><a name="refdes" id="refdes">refdes</a></h3>
352 <div class="level3">
355 This attribute is used to specify the reference designator to a particular instantiated component. It must be on ALL components which have some sort of electrical significance. This attribute can also be on the inside of a symbol (it will be promoted, i.e. attached to the outside of the symbol, if it is visible) to provide a default refdes value (such as U?). Usually this attribute is composed by a prefix (‘U’ for example) and a number (different for each component).<br/>
356 Examples: <code>refdes=U1 refdes=R10 refdes=CONN1</code><br/>
357 There is a convention of the reference designator used for each kind of component. Here are some of them (substitute a cardinal value for &lt;n&gt;):
358 </p>
359 <table class="inline">
360 <tr>
361 <th> Prefix </th><th> Component type</th>
362 </tr>
363 <tr>
364 <td class="leftalign"> R&lt;n&gt; </td><td>Resistor</td>
365 </tr>
366 <tr>
367 <td class="leftalign"> RN&lt;n&gt; </td><td>Resistor Network</td>
368 </tr>
369 <tr>
370 <td class="leftalign"> FB&lt;n&gt; </td><td>Ferrite Bead</td>
371 </tr>
372 <tr>
373 <td class="leftalign"> L&lt;n&gt; </td><td>Inductor</td>
374 </tr>
375 <tr>
376 <td class="leftalign"> C&lt;n&gt; </td><td>Capacitor</td>
377 </tr>
378 <tr>
379 <td class="leftalign"> B&lt;n&gt; </td><td>Battery </td>
380 </tr>
381 <tr>
382 <td class="leftalign"> F&lt;n&gt; </td><td class="leftalign">Fuse </td>
383 </tr>
384 <tr>
385 <td class="leftalign"> J&lt;n&gt; </td><td>Connector</td>
386 </tr>
387 <tr>
388 <td class="leftalign"> P&lt;n&gt; </td><td>Connector (usually plugs that mate with J&lt;n&gt;)</td>
389 </tr>
390 <tr>
391 <td class="leftalign"> K&lt;n&gt; </td><td>Relay</td>
392 </tr>
393 <tr>
394 <td class="leftalign"> S&lt;n&gt; </td><td>Switch</td>
395 </tr>
396 <tr>
397 <td class="leftalign"> T&lt;n&gt; </td><td>Transformer</td>
398 </tr>
399 <tr>
400 <td class="leftalign"> TP&lt;n&gt; </td><td>Testpoint</td>
401 </tr>
402 <tr>
403 <td class="leftalign"> M&lt;n&gt; </td><td>Motor</td>
404 </tr>
405 <tr>
406 <td class="leftalign"> D&lt;n&gt; </td><td>Diode</td>
407 </tr>
408 <tr>
409 <td class="leftalign"> Q&lt;n&gt; </td><td>Transistor</td>
410 </tr>
411 <tr>
412 <td class="leftalign"> U&lt;n&gt; </td><td>IC</td>
413 </tr>
414 <tr>
415 <td class="leftalign"> X&lt;n&gt; </td><td>Crystal</td>
416 </tr>
417 </table>
419 </div>
420 <!-- SECTION "refdes" [9780-10891] -->
421 <h3><a name="slot" id="slot">slot</a></h3>
422 <div class="level3">
425 This attribute is used to specify a slot for a slotted component. It should be attached to an instantiated component. This attribute can also be on the inside of a symbol (it will be promoted, i.e. attached to the outside of the symbol, if it is visible) to provide a default slot.
426 </p>
428 </div>
429 <!-- SECTION "slot" [10892-11189] -->
430 <h3><a name="net" id="net">net</a></h3>
431 <div class="level3">
434 The <strong>net</strong>= attribute is used to create power/ground and arbitrary nets. Please see the <a href="http://geda.seul.org/wiki/geda:na_howto" class="wikilink1" title="geda:na_howto">net= attribute mini-HOWTO</a> for more info. When this attribute is inside a symbol, it is used to create nets. When this attribute is attached to an instantiated component (in a schematic), then the <strong>net</strong>= can also be used to create new nets and can used to override existing nets.
435 </p>
437 </div>
438 <!-- SECTION "net" [11190-11593] -->
439 <h3><a name="value" id="value">value</a></h3>
440 <div class="level3">
443 Used mainly in the spice backend netlister to specify the value of the various elements. No translation is done on this, and it is placed as is into the netlist.<br/>
444 Examples: <code>value=1K value=10V</code><br/>
446 </p>
448 </div>
449 <!-- SECTION "value" [11594-11809] -->
450 <h3><a name="symversion" id="symversion">symversion</a></h3>
451 <div class="level3">
454 The <strong>symversion</strong>= attribute is used to version the contents of symbols. Normally this attribute is not present, but once a symbol has been accepted into the main gEDA symbol library and there are changes to it, this attribute must be placed into the symbol file and properly incremented. The value of this attribute takes the following form:<br/>
455 <strong>major.minor</strong>
456 </p>
459 where major and minor are just plain integers (separated by a period). The major number is incremented when a symbol has some sort of a change which will break or might break an existing schematic. The minor number is only incremented when a cosmetic or very minor change is made to the symbol. The major and minor numbers are not coupled in any way, however, when making major version changes, the minor version number can be reset to zero.<br/>
460 If this attribute is inside of a symbol and that symbol is placed onto a schematic, then the <strong>symversion</strong>= attribute will be automatically promoted and attached to the outside of the symbol. During the load of the symbol from disk, the value of the <strong>symversion</strong>= inside the symbol file (if any) and the <strong>symversion</strong>= attached to the symbol (if any) are compared. If the values are the same then the placed symbol matches the disk symbol file, however if the values do not match, then libgeda will output a warning/error message (based on whether it is a major or minor version change).<br/>
461 New symbols should not receive this attribute at all. Only when the symbol is change should this attribute be placed into the symbol file and maintained. Users should not attach this attribute manually to instantiated symbols. This attribute should normally be made invisible when placed inside of a symbol file. This attribute is always promoted when it is found inside of a symbol (during component placement).<br/>
462 Examples: <code>symversion=1.1</code><br/>
464 </p>
466 </div>
467 <!-- SECTION "symversion" [11810-13678] -->
468 <h2><a name="obsolete_attributes" id="obsolete_attributes">Obsolete Attributes</a></h2>
469 <div class="level2">
471 </div>
472 <!-- SECTION "Obsolete Attributes" [13679-13710] -->
473 <h3><a name="uref" id="uref">uref</a></h3>
474 <div class="level3">
477 The uref= attribute is obsolete and cannot not be used. It was used to provide the same information as <a href="#refdes" title="geda:master_attributes_list &crarr;" class="wikilink1">refdes</a>.
478 </p>
480 </div>
481 <!-- SECTION "uref" [13711-13842] -->
482 <h3><a name="name" id="name">name</a></h3>
483 <div class="level3">
486 The <strong>name</strong>= attribute should not be attached or appear in any symbol. It is considered ambiguous. <strong>name</strong>= was never used by gEDA/gaf.
487 </p>
489 </div>
490 <!-- SECTION "name" [13843-13996] -->
491 <h3><a name="label" id="label">label</a></h3>
492 <div class="level3">
495 The <strong>label</strong>= attribute is obsolete and cannot be used. It was used to give nets names/labels and to label pins. The replacement attributes for this are <a href="#netname" title="geda:master_attributes_list &crarr;" class="wikilink1">netname</a> and <a href="#pinlabel" title="geda:master_attributes_list &crarr;" class="wikilink1">pinlabel</a> respectively.
496 </p>
498 </div>
499 <!-- SECTION "label" [13997-14212] -->
500 <h3><a name="pin" id="pin">pin#</a></h3>
501 <div class="level3">
504 The <strong>pin#</strong>=# attribute is obsolete and cannot be used. It was used to provide sequence and number information to pins. The replacement attributes for this are <a href="#pinseq" title="geda:master_attributes_list &crarr;" class="wikilink1">pinseq</a> and <a href="#pinnumber" title="geda:master_attributes_list &crarr;" class="wikilink1">pinnumber</a>.
505 </p>
507 </div>
508 <!-- SECTION "pin#" [14213-14421] -->
509 <h3><a name="slot1" id="slot1">slot#</a></h3>
510 <div class="level3">
513 The <strong>slot#</strong>=# attribute is obsolete and cannot be used. It was used to provide slotting information to components. The replacement attribute for this is <a href="#slotdef" title="geda:master_attributes_list &crarr;" class="wikilink1">slotdef</a>.
514 </p>
516 </div>
517 <!-- SECTION "slot#" [14422-14607] -->
518 <h3><a name="type" id="type">type</a></h3>
519 <div class="level3">
522 The <strong>type</strong>= attribute is obsolete and cannot be used. It was used to provide type information on pins. The replacement attribute for this is <a href="#pintype" title="geda:master_attributes_list &crarr;" class="wikilink1">pintype</a>.
523 </p>
525 </div>
526 <!-- SECTION "type" [14608-14780] -->
527 <h3><a name="email" id="email">email</a></h3>
528 <div class="level3">
531 The information in this attribute has been merged with <a href="#author" title="geda:master_attributes_list &crarr;" class="wikilink1">author</a>.
532 </p>
534 </div>
535 <!-- SECTION "email" [14781-14865] -->
536 <h2><a name="document_revision_history" id="document_revision_history">Document Revision History</a></h2>
537 <div class="level2">
538 <table class="inline">
539 <tr>
540 <td>July 14th, 2002</td><td>Created attributes.tex from attributes.txt.</td>
541 </tr>
542 <tr>
543 <td>July 14th, 2002</td><td>Updated doc to be in sync with post-20020527.</td>
544 </tr>
545 <tr>
546 <td>August 25th, 2002</td><td>Added obsolete type= attribute.</td>
547 </tr>
548 <tr>
549 <td>September 14, 2002</td><td>Added description= attribute. Minor \fxes</td>
550 </tr>
551 <tr>
552 <td>October 7, 2002</td><td>Added doc= attribute; Egil Kvaleberg.</td>
553 </tr>
554 <tr>
555 <td>February 11, 2003</td><td>Added reference to footprint conventions.</td>
556 </tr>
557 <tr>
558 <td>February 23, 2003</td><td>Added author=, email=, and comment= attributes.</td>
559 </tr>
560 <tr>
561 <td>July 6th, 2004</td><td>Added symversion= attributes.</td>
562 </tr>
563 </table>
565 </div>
566 <!-- SECTION "Document Revision History" [14866-] --></div>
567 </body>
568 </html>