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   <title></title>
   6   <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
   7   <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
   8   <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
   9
  10   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  11 </head>
  12 <body>
  13
  14
  15 <h1 class="sectionedit1210"><a name="geda_gaf_master_attribute_document" id="geda_gaf_master_attribute_document">gEDA/gaf Master Attribute Document</a></h1>
  16 <div class="level1">
  17
  18 <p>
  19 by: Ales Hvezda, ahvezda@geda.seul.org
  20 </p>
  21
  22 <p>
  23 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>
  24 </p>
  25
  26 <p>
  27 July 10th, 2007
  28 </p>
  29
  30 </div>
  31 <!-- EDIT1210 SECTION "gEDA/gaf Master Attribute Document" [1-185] -->
  32 <h2 class="sectionedit1211"><a name="overview" id="overview">Overview</a></h2>
  33 <div class="level2">
  34
  35 <p>
  36 This document describes all the attributes used in in gEDA/gaf (<acronym title="GNU General Public License">GPL</acronym>&#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
  37 attributes which are obsolete or deprecated.<br/>
  38
  39 In this document, attribute names are in <strong>bold</strong> and examples are in the <code>typewriter</code> font.
  40 </p>
  41
  42 </div>
  43 <!-- EDIT1211 SECTION "Overview" [186-652] -->
  44 <h2 class="sectionedit1212"><a name="what_are_attributes" id="what_are_attributes">What are Attributes?</a></h2>
  45 <div class="level2">
  46
  47 <p>
  48 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/>
  49
  50 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
  51 floating. Free standing attributes just exist in the symbol file as text items which take on the form <strong>name</strong>=value.
  52 </p>
  53
  54 </div>
  55 <!-- EDIT1212 SECTION "What are Attributes?" [653-1423] -->
  56 <h2 class="sectionedit1213"><a name="symbol_only_attributes" id="symbol_only_attributes">Symbol only Attributes</a></h2>
  57 <div class="level2">
  58
  59 </div>
  60 <!-- EDIT1213 SECTION "Symbol only Attributes" [1424-1459] -->
  61 <h3 class="sectionedit1214"><a name="device" id="device">device</a></h3>
  62 <div class="level3">
  63
  64 <p>
  65 <strong>device</strong>= is the device name of the symbol<br/>
  66
  67 <strong>device</strong>= should be placed somewhere in the symbol and made invisible. This is a free standing or
  68 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 &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/>
  69
  70 Examples: <code>device=7400 device=CONNECTOR 10 device=NPN TRANSISTOR</code>
  71 </p>
  72
  73 </div>
  74 <!-- EDIT1214 SECTION "device" [1460-2074] -->
  75 <h3 class="sectionedit1215"><a name="graphical" id="graphical">graphical</a></h3>
  76 <div class="level3">
  77
  78 <p>
  79 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/>
  80
  81 <strong>graphical</strong>=1 should exist somewhere in the symbol and made invisible. This is a free standing or
  82 floating attribute. Don&#039;t forget to set <a href="#device" title=":geda:master_attributes_list.txt &crarr;" class="wikilink1">device</a>=none.<br/>
  83
  84 Example: <code>graphical=1</code>
  85 </p>
  86
  87 </div>
  88 <!-- EDIT1215 SECTION "graphical" [2075-2489] -->
  89 <h3 class="sectionedit1216"><a name="description" id="description">description</a></h3>
  90 <div class="level3">
  91
  92 <p>
  93 The <strong>description</strong> attribute provides a simple one line description of what the symbol is supposed to represent.<br/>
  94
  95 Example: <code>description=4 NAND gates with 2 inputs</code>
  96 </p>
  97
  98 </div>
  99 <!-- EDIT1216 SECTION "description" [2490-2680] -->
 100 <h3 class="sectionedit1217"><a name="author" id="author">author</a></h3>
 101 <div class="level3">
 102
 103 <p>
 104 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/>
 105
 106 Example: <code>author=Ales Hvezda ahvezdaATgeda.seul.org</code>
 107 </p>
 108
 109 </div>
 110 <!-- EDIT1217 SECTION "author" [2681-3277] -->
 111 <h3 class="sectionedit1218"><a name="comment" id="comment">comment</a></h3>
 112 <div class="level3">
 113
 114 <p>
 115 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/>
 116
 117 Example: <code>comment=This is a comment inside a symbol</code>
 118 </p>
 119
 120 </div>
 121 <!-- EDIT1218 SECTION "comment" [3278-3551] -->
 122 <h3 class="sectionedit1219"><a name="pinseq" id="pinseq">pinseq</a></h3>
 123 <div class="level3">
 124
 125 <p>
 126 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/>
 127
 128 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 &crarr;" class="wikilink1">pinnumber</a> attribute.<br/>
 129
 130 Examples: <code>pinseq=1 pinseq=2 pinseq=3</code><br/>
 131
 132 </p>
 133
 134 <p>
 135 This attribute replaces the obsolete <strong>pin#</strong>=# attribute.
 136 </p>
 137
 138 </div>
 139 <!-- EDIT1219 SECTION "pinseq" [3552-4244] -->
 140 <h3 class="sectionedit1220"><a name="pinnumber" id="pinnumber">pinnumber</a></h3>
 141 <div class="level3">
 142
 143 <p>
 144 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/>
 145
 146 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 &crarr;" class="wikilink1">pinseq</a> attribute.<br/>
 147
 148 Examples: <code>pinnumber=1 pinnumber=13 pinnumber=A0</code><br/>
 149
 150 </p>
 151
 152 <p>
 153 This attribute replaces the obsolete pin#=# attribute.
 154 </p>
 155
 156 </div>
 157 <!-- EDIT1220 SECTION "pinnumber" [4245-4667] -->
 158 <h3 class="sectionedit1221"><a name="pintype" id="pintype">pintype</a></h3>
 159 <div class="level3">
 160
 161 <p>
 162 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/>
 163
 164 This attribute is not used extensively in the symbol library, but it will be used for DRC and netlisting.<br/>
 165
 166 Examples: <code>pintype=clk pintype=in pintype=pas</code><br/>
 167
 168
 169 </p>
 170 <div class="table sectionedit1222"><table class="inline">
 171         <tr class="row0">
 172                 <td class="col0">in</td><td class="col1">Input</td>
 173         </tr>
 174         <tr class="row1">
 175                 <td class="col0">out</td><td class="col1">Output</td>
 176         </tr>
 177         <tr class="row2">
 178                 <td class="col0">io</td><td class="col1">Input/Output</td>
 179         </tr>
 180         <tr class="row3">
 181                 <td class="col0">oc</td><td class="col1">Open collector</td>
 182         </tr>
 183         <tr class="row4">
 184                 <td class="col0">oe</td><td class="col1">Open emitter</td>
 185         </tr>
 186         <tr class="row5">
 187                 <td class="col0">pas</td><td class="col1">Passive</td>
 188         </tr>
 189         <tr class="row6">
 190                 <td class="col0">tp</td><td class="col1">Totem pole</td>
 191         </tr>
 192         <tr class="row7">
 193                 <td class="col0">tri</td><td class="col1">Tristate (high impedance)</td>
 194         </tr>
 195         <tr class="row8">
 196                 <td class="col0">clk</td><td class="col1">Clock</td>
 197         </tr>
 198         <tr class="row9">
 199                 <td class="col0">pwr</td><td class="col1">Power/Ground</td>
 200         </tr>
 201         <tr class="row10">
 202                 <td class="col0" colspan="2">Table 1: pintype values</td>
 203         </tr>
 204 </table></div>
 205 <!-- EDIT1222 TABLE [4986-5185] -->
 206 </div>
 207 <!-- EDIT1221 SECTION "pintype" [4668-5186] -->
 208 <h3 class="sectionedit1223"><a name="pinlabel" id="pinlabel">pinlabel</a></h3>
 209 <div class="level3">
 210
 211 <p>
 212 This attribute labels a pin object. This attribute is primarily used by gnetlist to support hierarchical designs.<br/>
 213
 214 This attribute must be attached to the pin and be left visible. Please make this attribute green (instead of the default attribute yellow).<br/>
 215
 216 Examples: <code>pinlabel=A0 pinlabel=DATA1 pinlabel=CLK</code><br/>
 217
 218 </p>
 219
 220 </div>
 221 <!-- EDIT1223 SECTION "pinlabel" [5187-5520] -->
 222 <h3 class="sectionedit1224"><a name="numslots" id="numslots">numslots</a></h3>
 223 <div class="level3">
 224
 225 <p>
 226 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/>
 227
 228 Example: <code>numslots=4</code>
 229 </p>
 230
 231 </div>
 232 <!-- EDIT1224 SECTION "numslots" [5521-5984] -->
 233 <h3 class="sectionedit1225"><a name="slotdef" id="slotdef">slotdef</a></h3>
 234 <div class="level3">
 235
 236 <p>
 237 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/>
 238
 239 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 slotdef=4:… attributes somewhere in the symbol and be made invisible. This is a free standing or
 240 floating attribute.<br/>
 241
 242 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/>
 243
 244 It is recommended that all symbols which have slots have a <a href="#slot" title=":geda:master_attributes_list.txt &crarr;" class="wikilink1">slot</a>=1 attribute attached in the same fashion as the <a href="#device" title=":geda:master_attributes_list.txt &crarr;" class="wikilink1">device</a>= attribute.<br/>
 245
 246 See 7400-1.sym as a concrete example.<br/>
 247
 248 Examples: <code>slotdef=1:1,2,3 slotdef=2:4,5,6 slotdef=3:7,8,9</code><br/>
 249
 250 This attribute replaces the obsolete <strong>slot</strong>#=# attribute.
 251 </p>
 252
 253 </div>
 254 <!-- EDIT1225 SECTION "slotdef" [5985-6965] -->
 255 <h3 class="sectionedit1226"><a name="footprint" id="footprint">footprint</a></h3>
 256 <div class="level3">
 257
 258 <p>
 259 <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/>
 260
 261 Attach this attribute just like the <a href="#device" title=":geda:master_attributes_list.txt &crarr;" class="wikilink1">device</a>= attribute. This is a free standing or floating attribute.<br/>
 262
 263 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-scg.html#footprint_naming_conventions" class="wikilink1" title="geda-scg.html">Footprint naming conventions in the Symbol Creation Guide</a>.<br/>
 264
 265 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.
 266 </p>
 267
 268 </div>
 269 <!-- EDIT1226 SECTION "footprint" [6966-7924] -->
 270 <h3 class="sectionedit1227"><a name="documentation" id="documentation">documentation</a></h3>
 271 <div class="level3">
 272
 273 <p>
 274 <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/>
 275
 276 Attach this attribute just like the <a href="#device" title=":geda:master_attributes_list.txt &crarr;" class="wikilink1">device</a>= attribute. This is a freestanding or floating attribute.<br/>
 277
 278 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/>
 279
 280 Filename example: <code>documentation=sn74ls00.pdf</code><br/>
 281
 282 <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>
 283 </p>
 284
 285 </div>
 286 <!-- EDIT1227 SECTION "documentation" [7925-8683] -->
 287 <h2 class="sectionedit1228"><a name="schematic_only_attributes" id="schematic_only_attributes">Schematic only Attributes</a></h2>
 288 <div class="level2">
 289
 290 </div>
 291 <!-- EDIT1228 SECTION "Schematic only Attributes" [8684-8721] -->
 292 <h3 class="sectionedit1229"><a name="netname" id="netname">netname</a></h3>
 293 <div class="level3">
 294
 295 <p>
 296 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/>
 297
 298 Examples: <code>netname=DATA0 H netname=CLK L</code><br/>
 299
 300 </p>
 301
 302 </div>
 303 <!-- EDIT1229 SECTION "netname" [8722-9081] -->
 304 <h3 class="sectionedit1230"><a name="source" id="source">source</a></h3>
 305 <div class="level3">
 306
 307 <p>
 308 The source= attribute is used to specify that a symbol has underlying schematics. This attribute is attached directly to a component.<br/>
 309
 310 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/>
 311
 312 Examples: <code>source=underlying.sch source=memory.sch</code>
 313 </p>
 314
 315 </div>
 316 <!-- EDIT1230 SECTION "source" [9082-9703] -->
 317 <h2 class="sectionedit1231"><a name="symbol_and_schematic_attributes" id="symbol_and_schematic_attributes">Symbol and Schematic Attributes</a></h2>
 318 <div class="level2">
 319
 320 </div>
 321 <!-- EDIT1231 SECTION "Symbol and Schematic Attributes" [9704-9748] -->
 322 <h3 class="sectionedit1232"><a name="refdes" id="refdes">refdes</a></h3>
 323 <div class="level3">
 324
 325 <p>
 326 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/>
 327
 328 Examples: <code>refdes=U1 refdes=R10 refdes=CONN1</code><br/>
 329
 330 </p>
 331
 332 </div>
 333
 334 <h4><a name="refdes_naming_restrictions" id="refdes_naming_restrictions">refdes naming restrictions</a></h4>
 335 <div class="level4">
 336
 337 <p>
 338 Gschem will accept any string as a value for the refdes. However, some back-ends to gnetlist impose restrictions on the allowed syntax.
 339 </p>
 340
 341 <p>
 342 Specifically, <a href="geda-faq-gsch2pcb.html" class="wikilink1" title="geda-faq-gsch2pcb.html">gsch2pcb</a> requires:
 343 </p>
 344 <ul>
 345 <li class="level1"><div class="li"> No spaces</div>
 346 </li>
 347 <li class="level1"><div class="li"> No hyphens. This might upset the M4 macro language potentially used to generate footprints. “_” is ok.</div>
 348 </li>
 349 <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>
 350 </li>
 351 <li class="level1"><div class="li"> Non-<acronym title="American Standard Code for Information Interchange">ASCII</acronym> characters like like üöäß will not print in pcb</div>
 352 </li>
 353 </ul>
 354
 355 </div>
 356
 357 <h4><a name="refdes_naming_conventiions" id="refdes_naming_conventiions">refdes naming conventiions</a></h4>
 358 <div class="level4">
 359
 360 <p>
 361 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;):
 362 </p>
 363 <div class="table sectionedit1233"><table class="inline">
 364         <tr class="row0">
 365                 <th class="col0"> Prefix </th><th class="col1"> Component type</th>
 366         </tr>
 367         <tr class="row1">
 368                 <td class="col0 leftalign"> R&lt;n&gt;   </td><td class="col1">Resistor</td>
 369         </tr>
 370         <tr class="row2">
 371                 <td class="col0 leftalign"> RN&lt;n&gt;  </td><td class="col1">Resistor Network</td>
 372         </tr>
 373         <tr class="row3">
 374                 <td class="col0 leftalign"> FB&lt;n&gt;  </td><td class="col1">Ferrite Bead</td>
 375         </tr>
 376         <tr class="row4">
 377                 <td class="col0 leftalign"> L&lt;n&gt;   </td><td class="col1">Inductor</td>
 378         </tr>
 379         <tr class="row5">
 380                 <td class="col0 leftalign"> C&lt;n&gt;   </td><td class="col1">Capacitor</td>
 381         </tr>
 382         <tr class="row6">
 383                 <td class="col0 leftalign"> B&lt;n&gt;   </td><td class="col1">Battery </td>
 384         </tr>
 385         <tr class="row7">
 386                 <td class="col0 leftalign"> F&lt;n&gt;   </td><td class="col1 leftalign">Fuse    </td>
 387         </tr>
 388         <tr class="row8">
 389                 <td class="col0 leftalign"> J&lt;n&gt;   </td><td class="col1">Connector</td>
 390         </tr>
 391         <tr class="row9">
 392                 <td class="col0 leftalign"> P&lt;n&gt;   </td><td class="col1">Connector (usually plugs that mate with J&lt;n&gt;)</td>
 393         </tr>
 394         <tr class="row10">
 395                 <td class="col0 leftalign"> K&lt;n&gt;   </td><td class="col1">Relay</td>
 396         </tr>
 397         <tr class="row11">
 398                 <td class="col0 leftalign"> S&lt;n&gt;   </td><td class="col1">Switch</td>
 399         </tr>
 400         <tr class="row12">
 401                 <td class="col0 leftalign"> T&lt;n&gt;   </td><td class="col1">Transformer</td>
 402         </tr>
 403         <tr class="row13">
 404                 <td class="col0 leftalign"> TP&lt;n&gt;  </td><td class="col1">Testpoint</td>
 405         </tr>
 406         <tr class="row14">
 407                 <td class="col0 leftalign"> M&lt;n&gt;   </td><td class="col1">Motor</td>
 408         </tr>
 409         <tr class="row15">
 410                 <td class="col0 leftalign"> D&lt;n&gt;   </td><td class="col1">Diode</td>
 411         </tr>
 412         <tr class="row16">
 413                 <td class="col0 leftalign"> Q&lt;n&gt;   </td><td class="col1">Transistor</td>
 414         </tr>
 415         <tr class="row17">
 416                 <td class="col0 leftalign"> U&lt;n&gt;   </td><td class="col1">IC</td>
 417         </tr>
 418         <tr class="row18">
 419                 <td class="col0 leftalign"> X&lt;n&gt;   </td><td class="col1">Crystal</td>
 420         </tr>
 421 </table></div>
 422 <!-- EDIT1233 TABLE [11074-11499] -->
 423 </div>
 424 <!-- EDIT1232 SECTION "refdes" [9749-11500] -->
 425 <h3 class="sectionedit1234"><a name="slot" id="slot">slot</a></h3>
 426 <div class="level3">
 427
 428 <p>
 429 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.
 430 </p>
 431
 432 </div>
 433 <!-- EDIT1234 SECTION "slot" [11501-11798] -->
 434 <h3 class="sectionedit1235"><a name="net" id="net">net</a></h3>
 435 <div class="level3">
 436
 437 <p>
 438 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 used to override existing nets.
 439 </p>
 440
 441 </div>
 442 <!-- EDIT1235 SECTION "net" [11799-12202] -->
 443 <h3 class="sectionedit1236"><a name="value" id="value">value</a></h3>
 444 <div class="level3">
 445
 446 <p>
 447 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/>
 448
 449 Examples: <code>value=1K value=10V</code><br/>
 450
 451 </p>
 452
 453 </div>
 454 <!-- EDIT1236 SECTION "value" [12203-12418] -->
 455 <h3 class="sectionedit1237"><a name="symversion" id="symversion">symversion</a></h3>
 456 <div class="level3">
 457
 458 <p>
 459 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/>
 460
 461 <strong>major.minor</strong>
 462 </p>
 463
 464 <p>
 465 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/>
 466
 467 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/>
 468
 469 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/>
 470
 471 Examples: <code>symversion=1.1</code><br/>
 472
 473 </p>
 474
 475 </div>
 476 <!-- EDIT1237 SECTION "symversion" [12419-14287] -->
 477 <h3 class="sectionedit1238"><a name="dist-license" id="dist-license">dist-license</a></h3>
 478 <div class="level3">
 479
 480 <p>
 481
 482 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:  <acronym title="GNU General Public License">GPL</acronym>, <acronym title="GNU General Public License">GPL</acronym> version 2 only, <acronym title="GNU General Public License">GPL</acronym> version 3 only, public domain, Apache version 2, Modified BSD, X11, etc.  <br/>
 483
 484 <br/>
 485
 486 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
 487 <a href="http://www.opensource.org/licenses/category" class="urlextern" title="http://www.opensource.org/licenses/category"  rel="nofollow">OSI License List</a>
 488 </p>
 489
 490 </div>
 491 <!-- EDIT1238 SECTION "dist-license" [14288-14768] -->
 492 <h3 class="sectionedit1239"><a name="use-license" id="use-license">use-license</a></h3>
 493 <div class="level3">
 494
 495 <p>
 496
 497 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/>
 498
 499 <br/>
 500
 501 <img src="images/smileys/fixme.gif" align="middle" alt="FIXME" /> put a better list of examples here.
 502 </p>
 503
 504 </div>
 505 <!-- EDIT1239 SECTION "use-license" [14769-15068] -->
 506 <h2 class="sectionedit1240"><a name="obsolete_attributes" id="obsolete_attributes">Obsolete Attributes</a></h2>
 507 <div class="level2">
 508
 509 </div>
 510 <!-- EDIT1240 SECTION "Obsolete Attributes" [15069-15100] -->
 511 <h3 class="sectionedit1241"><a name="uref" id="uref">uref</a></h3>
 512 <div class="level3">
 513
 514 <p>
 515 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.txt &crarr;" class="wikilink1">refdes</a>.
 516 </p>
 517
 518 </div>
 519 <!-- EDIT1241 SECTION "uref" [15101-15232] -->
 520 <h3 class="sectionedit1242"><a name="name" id="name">name</a></h3>
 521 <div class="level3">
 522
 523 <p>
 524 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.
 525 </p>
 526
 527 </div>
 528 <!-- EDIT1242 SECTION "name" [15233-15386] -->
 529 <h3 class="sectionedit1243"><a name="label" id="label">label</a></h3>
 530 <div class="level3">
 531
 532 <p>
 533 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 &crarr;" class="wikilink1">netname</a> and <a href="#pinlabel" title=":geda:master_attributes_list.txt &crarr;" class="wikilink1">pinlabel</a> respectively.
 534 </p>
 535
 536 </div>
 537 <!-- EDIT1243 SECTION "label" [15387-15602] -->
 538 <h3 class="sectionedit1244"><a name="pin" id="pin">pin#</a></h3>
 539 <div class="level3">
 540
 541 <p>
 542 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 &crarr;" class="wikilink1">pinseq</a> and <a href="#pinnumber" title=":geda:master_attributes_list.txt &crarr;" class="wikilink1">pinnumber</a>.
 543 </p>
 544
 545 </div>
 546 <!-- EDIT1244 SECTION "pin#" [15603-15811] -->
 547 <h3 class="sectionedit1245"><a name="slot1" id="slot1">slot#</a></h3>
 548 <div class="level3">
 549
 550 <p>
 551 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 &crarr;" class="wikilink1">slotdef</a>.
 552 </p>
 553
 554 </div>
 555 <!-- EDIT1245 SECTION "slot#" [15812-15997] -->
 556 <h3 class="sectionedit1246"><a name="type" id="type">type</a></h3>
 557 <div class="level3">
 558
 559 <p>
 560 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 &crarr;" class="wikilink1">pintype</a>.
 561 </p>
 562
 563 </div>
 564 <!-- EDIT1246 SECTION "type" [15998-16170] -->
 565 <h3 class="sectionedit1247"><a name="email" id="email">email</a></h3>
 566 <div class="level3">
 567
 568 <p>
 569 The information in this attribute has been merged with <a href="#author" title=":geda:master_attributes_list.txt &crarr;" class="wikilink1">author</a>.
 570 </p>
 571
 572 </div>
 573 <!-- EDIT1247 SECTION "email" [16171-16255] -->
 574 <h2 class="sectionedit1248"><a name="document_revision_history" id="document_revision_history">Document Revision History</a></h2>
 575 <div class="level2">
 576 <div class="table sectionedit1249"><table class="inline">
 577         <tr class="row0">
 578                 <td class="col0">July 14th, 2002</td><td class="col1">Created attributes.tex from attributes.txt.</td>
 579         </tr>
 580         <tr class="row1">
 581                 <td class="col0">July 14th, 2002</td><td class="col1">Updated doc to be in sync with post-20020527.</td>
 582         </tr>
 583         <tr class="row2">
 584                 <td class="col0">August 25th, 2002</td><td class="col1">Added obsolete type= attribute.</td>
 585         </tr>
 586         <tr class="row3">
 587                 <td class="col0">September 14, 2002</td><td class="col1">Added description= attribute. Minor \fxes</td>
 588         </tr>
 589         <tr class="row4">
 590                 <td class="col0">October 7, 2002</td><td class="col1">Added doc= attribute; Egil Kvaleberg.</td>
 591         </tr>
 592         <tr class="row5">
 593                 <td class="col0">February 11, 2003</td><td class="col1">Added reference to footprint conventions.</td>
 594         </tr>
 595         <tr class="row6">
 596                 <td class="col0">February 23, 2003</td><td class="col1">Added author=, email=, and comment= attributes.</td>
 597         </tr>
 598         <tr class="row7">
 599                 <td class="col0">July 6th, 2004</td><td class="col1">Added symversion= attributes.</td>
 600         </tr>
 601         <tr class="row8">
 602                 <td class="col0">July 10th, 2007</td><td class="col1">Added dist-license= and use-license= attributes.</td>
 603         </tr>
 604 </table></div>
 605 <!-- EDIT1249 TABLE [16294-16833] -->
 606 </div>
 607 <!-- EDIT1248 SECTION "Document Revision History" [16256-] --></body>
 608 </html>