docs/wiki/geda-master_attributes_list.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html>
   4 <head>
   5   <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
   6   <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
   7   <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
   8
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  10 </head>
  11 <body>
  12
  13 <p>
  14 <em>Translations of this page are also available in the following languages:</em> <a href="geda-master_attributes_list.ru.html" class="wikilink1" title="geda-master_attributes_list.ru.html">Русский</a>.
  15 </p>
  16
  17 <h1 class="sectionedit1" id="geda_gaf_master_attribute_document">gEDA/gaf Master Attribute Document</h1>
  18 <div class="level1">
  19
  20 <p>
  21 by: Ales Hvezda, ahvezda@geda.seul.org
  22 </p>
  23
  24 <p>
  25 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>
  26 </p>
  27
  28 <p>
  29 July 10th, 2007
  30 </p>
  31
  32 </div>
  33 <!-- EDIT1 SECTION "gEDA/gaf Master Attribute Document" [125-309] -->
  34 <h2 class="sectionedit2" id="overview">Overview</h2>
  35 <div class="level2">
  36
  37 <p>
  38 This document describes all the attributes used in in gEDA/gaf (<abbr title="GNU General Public License">GPL</abbr>&#039;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
  39 attributes which are obsolete or deprecated.<br/>
  40
  41 In this document, attribute names are in <strong>bold</strong> and examples are in the <code>typewriter</code> font.
  42 </p>
  43
  44 </div>
  45 <!-- EDIT2 SECTION "Overview" [310-776] -->
  46 <h2 class="sectionedit3" id="what_are_attributes">What are Attributes?</h2>
  47 <div class="level2">
  48
  49 <p>
  50 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&#039;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/>
  51
  52 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
  53 floating. Free standing attributes just exist in the symbol file as text items which take on the form <strong>name</strong>=value.
  54 </p>
  55
  56 </div>
  57 <!-- EDIT3 SECTION "What are Attributes?" [777-1546] -->
  58 <h2 class="sectionedit4" id="symbol_only_attributes">Symbol only Attributes</h2>
  59 <div class="level2">
  60
  61 </div>
  62 <!-- EDIT4 SECTION "Symbol only Attributes" [1547-1582] -->
  63 <h3 class="sectionedit5" id="device">device</h3>
  64 <div class="level3">
  65
  66 <p>
  67 <strong>device</strong>= is the device name of the symbol<br/>
  68
  69 <strong>device</strong>= should be placed somewhere in the symbol and made invisible. This is a free standing or
  70 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.txt ↵" 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/>
  71
  72 <em>Examples:</em><br/>
  73 <code>device=7400</code><br/>
  74 <code>device=CONNECTOR_10</code><br/>
  75 <code>device=NPN_TRANSISTOR</code>
  76 </p>
  77
  78 </div>
  79 <!-- EDIT5 SECTION "device" [1583-2214] -->
  80 <h3 class="sectionedit6" id="graphical">graphical</h3>
  81 <div class="level3">
  82
  83 <p>
  84 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/>
  85
  86 <strong>graphical</strong>=1 should exist somewhere in the symbol and made invisible. This is a free standing or
  87 floating attribute. Don&#039;t forget to set <a href="#device" title=":geda:master_attributes_list.txt ↵" class="wikilink1">device</a>=none.<br/>
  88
  89 <em>Example:</em><br/>
  90 <code>graphical=1</code>
  91 </p>
  92
  93 </div>
  94 <!-- EDIT6 SECTION "graphical" [2215-2634] -->
  95 <h3 class="sectionedit7" id="description">description</h3>
  96 <div class="level3">
  97
  98 <p>
  99 The <strong>description</strong> attribute provides a simple one line description of what the symbol is supposed to represent.<br/>
 100
 101 <em>Example:</em><br/>
 102 <code>description=4 NAND gates with 2 inputs</code>
 103 </p>
 104
 105 </div>
 106 <!-- EDIT7 SECTION "description" [2635-2831] -->
 107 <h3 class="sectionedit8" id="author">author</h3>
 108 <div class="level3">
 109
 110 <p>
 111 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&#039;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/>
 112
 113 <em>Example:</em><br/>
 114 <code>author=Ales Hvezda ahvezdaATgeda.seul.org</code>
 115 </p>
 116
 117 </div>
 118 <!-- EDIT8 SECTION "author" [2832-3434] -->
 119 <h3 class="sectionedit9" id="comment">comment</h3>
 120 <div class="level3">
 121
 122 <p>
 123 The <strong>comment</strong> 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/>
 124
 125 <em>Example:</em><br/>
 126 <code>comment=This is a comment inside a symbol</code>
 127 </p>
 128
 129 </div>
 130 <!-- EDIT9 SECTION "comment" [3435-3714] -->
 131 <h3 class="sectionedit10" id="pinseq">pinseq</h3>
 132 <div class="level3">
 133
 134 <p>
 135 This attribute is used to give each pin a 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/>
 136
 137 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.txt ↵" class="wikilink1">pinnumber</a> attribute.<br/>
 138
 139 <em>Examples:</em><br/>
 140 <code>pinseq=1</code><br/>
 141 <code>pinseq=2</code><br/>
 142 <code>pinseq=3</code>
 143 </p>
 144
 145 <p>
 146 This attribute replaces the obsolete <strong>pin#</strong>=# attribute.
 147 </p>
 148
 149 </div>
 150 <!-- EDIT10 SECTION "pinseq" [3715-4422] -->
 151 <h3 class="sectionedit11" id="pinnumber">pinnumber</h3>
 152 <div class="level3">
 153
 154 <p>
 155 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/>
 156
 157 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.txt ↵" class="wikilink1">pinseq</a> attribute.<br/>
 158
 159 <em>Examples:</em><br/>
 160 <code>pinnumber=1</code><br/>
 161 <code>pinnumber=13</code><br/>
 162 <code>pinnumber=A0</code>
 163 </p>
 164
 165 <p>
 166 This attribute replaces the obsolete <strong>pin#</strong>=# attribute.
 167 </p>
 168
 169 </div>
 170 <!-- EDIT11 SECTION "pinnumber" [4423-4865] -->
 171 <h3 class="sectionedit12" id="pintype">pintype</h3>
 172 <div class="level3">
 173
 174 <p>
 175 Each pin must have a <strong>pintype</strong>=value attribute attached to it and should be made hidden. Table 1 shows valid values for this attribute.<br/>
 176
 177 This attribute is not used extensively in the symbol library, but it will be used for DRC and netlisting. Use “Passive” if no other type matches.<br/>
 178
 179 <em>Examples:</em><br/>
 180 <code>pintype=clk</code><br/>
 181 <code>pintype=in</code><br/>
 182 <code>pintype=pas</code>
 183 </p>
 184 <div class="table sectionedit13"><table class="inline">
 185         <tr class="row0">
 186                 <td class="col0">in</td><td class="col1">Input</td>
 187         </tr>
 188         <tr class="row1">
 189                 <td class="col0">out</td><td class="col1">Output</td>
 190         </tr>
 191         <tr class="row2">
 192                 <td class="col0">io</td><td class="col1">Input/Output</td>
 193         </tr>
 194         <tr class="row3">
 195                 <td class="col0">oc</td><td class="col1">Open collector</td>
 196         </tr>
 197         <tr class="row4">
 198                 <td class="col0">oe</td><td class="col1">Open emitter</td>
 199         </tr>
 200         <tr class="row5">
 201                 <td class="col0">pas</td><td class="col1">Passive</td>
 202         </tr>
 203         <tr class="row6">
 204                 <td class="col0">tp</td><td class="col1">Totem pole</td>
 205         </tr>
 206         <tr class="row7">
 207                 <td class="col0">tri</td><td class="col1">Tristate (high impedance)</td>
 208         </tr>
 209         <tr class="row8">
 210                 <td class="col0">clk</td><td class="col1">Clock</td>
 211         </tr>
 212         <tr class="row9">
 213                 <td class="col0">pwr</td><td class="col1">Power/Ground</td>
 214         </tr>
 215         <tr class="row10">
 216                 <td class="col0 centeralign" colspan="2">  <strong>Table 1:</strong> pintype values  </td>
 217         </tr>
 218 </table></div>
 219 <!-- EDIT13 TABLE [5240-5447] -->
 220 </div>
 221 <!-- EDIT12 SECTION "pintype" [4866-5448] -->
 222 <h3 class="sectionedit14" id="pinlabel">pinlabel</h3>
 223 <div class="level3">
 224
 225 <p>
 226 This attribute labels a pin object. This attribute is primarily used by gnetlist to support hierarchical designs.<br/>
 227
 228 This attribute must be attached to the pin and be left visible. Please make this attribute green (instead of the default attribute yellow).<br/>
 229
 230 <em>Examples:</em><br/>
 231 <code>pinlabel=A0</code><br/>
 232 <code>pinlabel=DATA1</code><br/>
 233 <code>pinlabel=CLK</code>
 234 </p>
 235
 236 </div>
 237 <!-- EDIT14 SECTION "pinlabel" [5449-5798] -->
 238 <h3 class="sectionedit15" id="numslots">numslots</h3>
 239 <div class="level3">
 240
 241 <p>
 242 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/>
 243
 244 <em>Example:</em><br/>
 245 <code>numslots=4</code>
 246 </p>
 247
 248 </div>
 249 <!-- EDIT15 SECTION "numslots" [5799-6268] -->
 250 <h3 class="sectionedit16" id="slotdef">slotdef</h3>
 251 <div class="level3">
 252
 253 <p>
 254 If a component has multiple slots in a physical package then you must attach a <strong>slotdef</strong>=slotnumber:#,#,#… for every device inside the physical package.<br/>
 255
 256 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:…, <strong>slotdef</strong>=2:…, <strong>slotdef</strong>=3:…, and <strong>slotdef</strong>=4:… attributes somewhere in the symbol and be made invisible. This is a free standing or
 257 floating attribute.<br/>
 258
 259 The #&#039;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/>
 260
 261 It is recommended that all symbols which have slots have a <a href="#slot" title=":geda:master_attributes_list.txt ↵" class="wikilink1">slot</a>=1 attribute attached in the same fashion as the <a href="#device" title=":geda:master_attributes_list.txt ↵" class="wikilink1">device</a>= attribute.<br/>
 262
 263 See 7400-1.sym as a concrete example.<br/>
 264
 265 <em>Examples:</em><br/>
 266 <code>slotdef=1:1,2,3</code><br/>
 267 <code>slotdef=2:4,5,6</code><br/>
 268 <code>slotdef=3:7,8,9</code>
 269 </p>
 270
 271 <p>
 272 This attribute replaces the obsolete <strong>slot#</strong>=# attribute.
 273 </p>
 274
 275 </div>
 276 <!-- EDIT16 SECTION "slotdef" [6269-7269] -->
 277 <h3 class="sectionedit17" id="footprint">footprint</h3>
 278 <div class="level3">
 279
 280 <p>
 281 <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/>
 282
 283 Attach this attribute just like the <a href="#device" title=":geda:master_attributes_list.txt ↵" class="wikilink1">device</a>= attribute. This is a free standing or floating attribute.<br/>
 284
 285 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="geda-pcb_footprint_naming_conventions.html" class="wikilink1" title="geda-pcb_footprint_naming_conventions.html">Footprint naming conventions</a>.<br/>
 286
 287 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 <strong>footprint</strong>= should be set to unknown.
 288 </p>
 289
 290 </div>
 291 <!-- EDIT17 SECTION "footprint" [7270-8203] -->
 292 <h3 class="sectionedit18" id="documentation">documentation</h3>
 293 <div class="level3">
 294
 295 <p>
 296 <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/>
 297
 298 Attach this attribute just like the <a href="#device" title=":geda:master_attributes_list.txt ↵" class="wikilink1">device</a>= attribute. This is a freestanding or floating attribute.<br/>
 299
 300 documentation_locator is either the base filename of the documentation, or it is the complete Internet <abbr title="Uniform Resource Locator">URL</abbr> (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/>
 301
 302 <em>Filename example:</em><br/>
 303 <code>documentation=sn74ls00.pdf</code><br/>
 304
 305 <em><abbr title="Uniform Resource Locator">URL</abbr> example:</em><br/>
 306 <code>documentation=http://www-s.ti.com/sc/ds/sn74ls00.pdf</code>
 307 </p>
 308
 309 </div>
 310 <!-- EDIT18 SECTION "documentation" [8204-8978] -->
 311 <h2 class="sectionedit19" id="schematic_only_attributes">Schematic only Attributes</h2>
 312 <div class="level2">
 313
 314 </div>
 315 <!-- EDIT19 SECTION "Schematic only Attributes" [8979-9016] -->
 316 <h3 class="sectionedit20" id="netname">netname</h3>
 317 <div class="level3">
 318
 319 <p>
 320 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/>
 321
 322 <em>Examples:</em><br/>
 323 <code>netname=DATA0_H</code><br/>
 324 <code>netname=CLK_L</code>
 325 </p>
 326
 327 </div>
 328 <!-- EDIT20 SECTION "netname" [9017-9386] -->
 329 <h3 class="sectionedit21" id="source">source</h3>
 330 <div class="level3">
 331
 332 <p>
 333 The <strong>source</strong>= attribute is used to specify that a symbol has underlying schematics. This attribute is attached directly to a component.<br/>
 334
 335 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 different values which basically means that there are multiple underlying schematics.<br/>
 336
 337 <em>Examples:</em><br/>
 338 <code>source=underlying.sch</code><br/>
 339 <code>source=memory.sch</code>
 340 </p>
 341
 342 </div>
 343 <!-- EDIT21 SECTION "source" [9387-10024] -->
 344 <h2 class="sectionedit22" id="symbol_and_schematic_attributes">Symbol and Schematic Attributes</h2>
 345 <div class="level2">
 346
 347 </div>
 348 <!-- EDIT22 SECTION "Symbol and Schematic Attributes" [10025-10069] -->
 349 <h3 class="sectionedit23" id="refdes">refdes</h3>
 350 <div class="level3">
 351
 352 <p>
 353 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 (&#039;U&#039; for example) and a number (different for each component).<br/>
 354
 355 <em>Examples:</em><br/>
 356 <code>refdes=U1</code><br/>
 357 <code>refdes=R10</code><br/>
 358 <code>refdes=CONN1</code>
 359 </p>
 360
 361 </div>
 362
 363 <h4 id="refdes_naming_restrictions">refdes naming restrictions</h4>
 364 <div class="level4">
 365
 366 <p>
 367 Gschem will accept any string as a value for the refdes. However, some back-ends to gnetlist impose restrictions on the allowed syntax.
 368 </p>
 369
 370 <p>
 371 Specifically, <a href="geda-faq-gsch2pcb.html" class="wikilink1" title="geda-faq-gsch2pcb.html">gsch2pcb</a> requires:
 372 </p>
 373 <ul>
 374 <li class="level1"><div class="li"> No spaces</div>
 375 </li>
 376 <li class="level1"><div class="li"> No hyphens. This might upset the M4 macro language potentially used to generate footprints. “_” is ok.</div>
 377 </li>
 378 <li class="level1"><div class="li"> Any lower case suffix is ignored. This is so you can, place four discrete NAND gates on the schematic called U1a, U1b, U1c and U1d. They will netlist into a single footprint named U1.</div>
 379 </li>
 380 <li class="level1"><div class="li"> Non-<abbr title="American Standard Code for Information Interchange">ASCII</abbr> characters like üöäß will not print in pcb</div>
 381 </li>
 382 </ul>
 383
 384 </div>
 385
 386 <h4 id="refdes_naming_conventions">refdes naming conventions</h4>
 387 <div class="level4">
 388
 389 <p>
 390 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;):
 391 </p>
 392 <div class="table sectionedit24"><table class="inline">
 393         <thead>
 394         <tr class="row0">
 395                 <th class="col0"> Prefix </th><th class="col1"> Component type</th>
 396         </tr>
 397         </thead>
 398         <tr class="row1">
 399                 <td class="col0 leftalign"> R&lt;n&gt;   </td><td class="col1">Resistor</td>
 400         </tr>
 401         <tr class="row2">
 402                 <td class="col0 leftalign"> RN&lt;n&gt;  </td><td class="col1">Resistor Network</td>
 403         </tr>
 404         <tr class="row3">
 405                 <td class="col0 leftalign"> FB&lt;n&gt;  </td><td class="col1">Ferrite Bead</td>
 406         </tr>
 407         <tr class="row4">
 408                 <td class="col0 leftalign"> L&lt;n&gt;   </td><td class="col1">Inductor</td>
 409         </tr>
 410         <tr class="row5">
 411                 <td class="col0 leftalign"> C&lt;n&gt;   </td><td class="col1">Capacitor</td>
 412         </tr>
 413         <tr class="row6">
 414                 <td class="col0 leftalign"> B&lt;n&gt;   </td><td class="col1">Battery </td>
 415         </tr>
 416         <tr class="row7">
 417                 <td class="col0 leftalign"> F&lt;n&gt;   </td><td class="col1 leftalign">Fuse    </td>
 418         </tr>
 419         <tr class="row8">
 420                 <td class="col0 leftalign"> J&lt;n&gt;   </td><td class="col1">Connector</td>
 421         </tr>
 422         <tr class="row9">
 423                 <td class="col0 leftalign"> P&lt;n&gt;   </td><td class="col1">Connector (usually plugs that mate with J&lt;n&gt;)</td>
 424         </tr>
 425         <tr class="row10">
 426                 <td class="col0 leftalign"> K&lt;n&gt;   </td><td class="col1">Relay</td>
 427         </tr>
 428         <tr class="row11">
 429                 <td class="col0 leftalign"> S&lt;n&gt;   </td><td class="col1">Switch</td>
 430         </tr>
 431         <tr class="row12">
 432                 <td class="col0 leftalign"> T&lt;n&gt;   </td><td class="col1">Transformer</td>
 433         </tr>
 434         <tr class="row13">
 435                 <td class="col0 leftalign"> TP&lt;n&gt;  </td><td class="col1">Testpoint</td>
 436         </tr>
 437         <tr class="row14">
 438                 <td class="col0 leftalign"> M&lt;n&gt;   </td><td class="col1">Motor</td>
 439         </tr>
 440         <tr class="row15">
 441                 <td class="col0 leftalign"> D&lt;n&gt;   </td><td class="col1">Diode</td>
 442         </tr>
 443         <tr class="row16">
 444                 <td class="col0 leftalign"> Q&lt;n&gt;   </td><td class="col1">Transistor</td>
 445         </tr>
 446         <tr class="row17">
 447                 <td class="col0 leftalign"> U&lt;n&gt;   </td><td class="col1">IC</td>
 448         </tr>
 449         <tr class="row18">
 450                 <td class="col0 leftalign"> X&lt;n&gt;   </td><td class="col1">Crystal</td>
 451         </tr>
 452 </table></div>
 453 <!-- EDIT24 TABLE [11405-11830] -->
 454 </div>
 455 <!-- EDIT23 SECTION "refdes" [10070-11831] -->
 456 <h3 class="sectionedit25" id="slot">slot</h3>
 457 <div class="level3">
 458
 459 <p>
 460 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.
 461 </p>
 462
 463 </div>
 464 <!-- EDIT25 SECTION "slot" [11832-12129] -->
 465 <h3 class="sectionedit26" id="net">net</h3>
 466 <div class="level3">
 467
 468 <p>
 469 The <strong>net</strong>= attribute is used to create power/ground and arbitrary nets. Please see the  <a href="geda-na_howto.html" class="wikilink1" title="geda-na_howto.html">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 be used to override existing nets.
 470 </p>
 471
 472 </div>
 473 <!-- EDIT26 SECTION "net" [12130-12536] -->
 474 <h3 class="sectionedit27" id="value">value</h3>
 475 <div class="level3">
 476
 477 <p>
 478 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/>
 479
 480 <em>Examples:</em><br/>
 481 <code>value=1K</code><br/>
 482 <code>value=10V</code>
 483 </p>
 484
 485 </div>
 486 <!-- EDIT27 SECTION "value" [12537-12762] -->
 487 <h3 class="sectionedit28" id="symversion">symversion</h3>
 488 <div class="level3">
 489
 490 <p>
 491 The <strong>symversion</strong>= attribute is used to version the contents of symbols.
 492 Because symbols are, by default, referenced from the schematic and not
 493 embedded within it, problems can occur in a schematic using a
 494 particular symbol if that symbol file is modified.  For instance, if
 495 pins are moved in the symbol, the schematic net lines will no longer
 496 connect to the correct pins.  The <strong>symversion</strong>= attribute allows
 497 tracking such breaking changes to symbols and notifying the user of
 498 potential problems when a schematic is loaded.
 499 </p>
 500
 501 <p>
 502 This attribute is optional, but if present it must take the following
 503 form:<br/>
 504
 505 <strong>major.minor</strong>
 506 </p>
 507
 508 <p>
 509 where major and minor are integers.  The major number is incremented
 510 when a change is made to a symbol that might break an existing
 511 schematic using the prior version of symbol when the new version is
 512 introduced.  The minor number is only incremented when a minor change
 513 is made (a change that cannot break an existing schematic, such as
 514 cosmetic changes while retaining structure such as location of the
 515 pins).
 516 </p>
 517
 518 <p>
 519 If this attribute is inside a symbol and that symbol is placed onto a
 520 schematic, the <strong>symversion</strong>= attribute will be automatically “promoted”,
 521 causing a copy of the <strong>symversion</strong>=M.N attribute to be stored on the
 522 symbol instance in the schematic itself.  When a symbol is loaded from
 523 disk, the value of the <strong>symversion</strong>= inside the symbol file (if any) and
 524 the symversion value attached to the symbol instance on the schematic
 525 are compared.  If the values differ, then libgeda will output a warning
 526 message (for minor version changes) or an error message (for major
 527 version changes).
 528 </p>
 529
 530 <p>
 531 This attribute should normally be made invisible when placed inside a
 532 symbol file.  This attribute is always promoted when it is found inside
 533 a symbol during component placement.  Users should not attach this
 534 attribute manually to instantiated symbols in a schematic.<br/>
 535
 536 <em>Examples:</em><br/>
 537 <code>symversion=1.1</code><br/>
 538 <code>symversion=2.0</code>
 539 </p>
 540
 541 </div>
 542 <!-- EDIT28 SECTION "symversion" [12763-14739] -->
 543 <h3 class="sectionedit29" id="dist-license">dist-license</h3>
 544 <div class="level3">
 545
 546 <p>
 547 The <strong>dist-license</strong> attribute is used to specify the redistribution license for the symbol or schematic.  It should be the name of a known license.  Some examples values are:  <abbr title="GNU General Public License">GPL</abbr>, <abbr title="GNU General Public License">GPL</abbr> version 2 only, <abbr title="GNU General Public License">GPL</abbr> version 3 only, public domain, Apache version 2, Modified BSD, X11, etc.  <br/>
 548
 549 <br/>
 550
 551 For a list of licenses see: <a href="http://www.gnu.org/philosophy/license-list.html" class="urlextern" title="http://www.gnu.org/philosophy/license-list.html" rel="nofollow">FSF License List</a> and
 552 <a href="http://www.opensource.org/licenses/category" class="urlextern" title="http://www.opensource.org/licenses/category" rel="nofollow">OSI License List</a>
 553 </p>
 554
 555 </div>
 556 <!-- EDIT29 SECTION "dist-license" [14740-15219] -->
 557 <h3 class="sectionedit30" id="use-license">use-license</h3>
 558 <div class="level3">
 559
 560 <p>
 561 The <strong>use-license</strong> attribute is used to specify the license for how the symbol or schematic can be used by other people in their own circuits or boards.  Some example values are: unlimited, personal use only, not for sale, etc.<br/>
 562
 563 <br/>
 564
 565 <img src="images/smileys/fixme.gif" align="middle" alt="FIXME" /> put a better list of examples here.
 566 </p>
 567
 568 </div>
 569 <!-- EDIT30 SECTION "use-license" [15220-15519] -->
 570 <h2 class="sectionedit31" id="obsolete_attributes">Obsolete Attributes</h2>
 571 <div class="level2">
 572
 573 </div>
 574 <!-- EDIT31 SECTION "Obsolete Attributes" [15520-15551] -->
 575 <h3 class="sectionedit32" id="uref">uref</h3>
 576 <div class="level3">
 577
 578 <p>
 579 The <strong>uref</strong>= 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.txt ↵" class="wikilink1">refdes</a>.
 580 </p>
 581
 582 </div>
 583 <!-- EDIT32 SECTION "uref" [15552-15687] -->
 584 <h3 class="sectionedit33" id="name">name</h3>
 585 <div class="level3">
 586
 587 <p>
 588 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.
 589 </p>
 590
 591 </div>
 592 <!-- EDIT33 SECTION "name" [15688-15841] -->
 593 <h3 class="sectionedit34" id="label">label</h3>
 594 <div class="level3">
 595
 596 <p>
 597 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.txt ↵" class="wikilink1">netname</a> and <a href="#pinlabel" title=":geda:master_attributes_list.txt ↵" class="wikilink1">pinlabel</a> respectively.
 598 </p>
 599
 600 </div>
 601 <!-- EDIT34 SECTION "label" [15842-16057] -->
 602 <h3 class="sectionedit35" id="pin">pin#</h3>
 603 <div class="level3">
 604
 605 <p>
 606 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.txt ↵" class="wikilink1">pinseq</a> and <a href="#pinnumber" title=":geda:master_attributes_list.txt ↵" class="wikilink1">pinnumber</a>.
 607 </p>
 608
 609 </div>
 610 <!-- EDIT35 SECTION "pin#" [16058-16266] -->
 611 <h3 class="sectionedit36" id="slot1">slot#</h3>
 612 <div class="level3">
 613
 614 <p>
 615 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.txt ↵" class="wikilink1">slotdef</a>.
 616 </p>
 617
 618 </div>
 619 <!-- EDIT36 SECTION "slot#" [16267-16452] -->
 620 <h3 class="sectionedit37" id="type">type</h3>
 621 <div class="level3">
 622
 623 <p>
 624 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.txt ↵" class="wikilink1">pintype</a>.
 625 </p>
 626
 627 </div>
 628 <!-- EDIT37 SECTION "type" [16453-16625] -->
 629 <h3 class="sectionedit38" id="email">email</h3>
 630 <div class="level3">
 631
 632 <p>
 633 The information in this attribute has been merged with <a href="#author" title=":geda:master_attributes_list.txt ↵" class="wikilink1">author</a>.
 634 </p>
 635
 636 </div>
 637 <!-- EDIT38 SECTION "email" [16626-16710] -->
 638 <h2 class="sectionedit39" id="document_revision_history">Document Revision History</h2>
 639 <div class="level2">
 640 <div class="table sectionedit40"><table class="inline">
 641         <tr class="row0">
 642                 <td class="col0">July 14th, 2002</td><td class="col1">Created attributes.tex from attributes.txt.</td>
 643         </tr>
 644         <tr class="row1">
 645                 <td class="col0">July 14th, 2002</td><td class="col1">Updated doc to be in sync with post-20020527.</td>
 646         </tr>
 647         <tr class="row2">
 648                 <td class="col0">August 25th, 2002</td><td class="col1">Added obsolete type= attribute.</td>
 649         </tr>
 650         <tr class="row3">
 651                 <td class="col0">September 14, 2002</td><td class="col1">Added description= attribute. Minor fixes</td>
 652         </tr>
 653         <tr class="row4">
 654                 <td class="col0">October 7, 2002</td><td class="col1">Added doc= attribute; Egil Kvaleberg.</td>
 655         </tr>
 656         <tr class="row5">
 657                 <td class="col0">February 11, 2003</td><td class="col1">Added reference to footprint conventions.</td>
 658         </tr>
 659         <tr class="row6">
 660                 <td class="col0">February 23, 2003</td><td class="col1">Added author=, email=, and comment= attributes.</td>
 661         </tr>
 662         <tr class="row7">
 663                 <td class="col0">July 6th, 2004</td><td class="col1">Added symversion= attribute.</td>
 664         </tr>
 665         <tr class="row8">
 666                 <td class="col0">July 10th, 2007</td><td class="col1">Added dist-license= and use-license= attributes.</td>
 667         </tr>
 668 </table></div>
 669 <!-- EDIT40 TABLE [16749-17288] -->
 670 </div>
 671 <!-- EDIT39 SECTION "Document Revision History" [16711-] --></body>
 672 </html>