docs/wiki/geda_file_format_spec.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 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:file_format_spec</title>
   8 <meta name="generator" content="DokuWiki Release rc2007-05-24" />
   9 <meta name="robots" content="index,follow" />
  10 <meta name="date" content="2007-07-08T20:51:33-0400" />
  11 <meta name="keywords" content="geda,file_format_spec" />
  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:file_format_spec?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:file_format_spec" />
  18 <link rel="alternate" type="text/plain" title="Wiki Markup" href="http://geda.seul.org/wiki/_export/raw/geda:file_format_spec" />
  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">
  28
  29 <ul class="toc">
  30 <li class="level1"><div class="li"><span class="li"><a href="#geda_gaf_file_format_document" class="toc">gEDA/gaf File Format 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="#coordinate_space" class="toc">Coordinate Space</a></span></div></li>
  34 <li class="level2"><div class="li"><span class="li"><a href="#filenames" class="toc">Filenames</a></span></div></li>
  35 <li class="level2"><div class="li"><span class="li"><a href="#object_types" class="toc">Object types</a></span></div>
  36 <ul class="toc">
  37 <li class="level3"><div class="li"><span class="li"><a href="#version" class="toc">version</a></span></div></li>
  38 <li class="level3"><div class="li"><span class="li"><a href="#line" class="toc">line</a></span></div></li>
  39 <li class="level3"><div class="li"><span class="li"><a href="#picture" class="toc">picture</a></span></div></li>
  40 <li class="level3"><div class="li"><span class="li"><a href="#box" class="toc">box</a></span></div></li>
  41 <li class="level3"><div class="li"><span class="li"><a href="#circle" class="toc">circle</a></span></div></li>
  42 <li class="level3"><div class="li"><span class="li"><a href="#arc" class="toc">arc</a></span></div></li>
  43 <li class="level3"><div class="li"><span class="li"><a href="#text" class="toc">text</a></span></div></li>
  44 <li class="level3"><div class="li"><span class="li"><a href="#net" class="toc">net</a></span></div></li>
  45 <li class="level3"><div class="li"><span class="li"><a href="#bus" class="toc">bus</a></span></div></li>
  46 <li class="level3"><div class="li"><span class="li"><a href="#pin" class="toc">pin</a></span></div></li>
  47 <li class="level3"><div class="li"><span class="li"><a href="#component" class="toc">component</a></span></div></li>
  48 <li class="level3"><div class="li"><span class="li"><a href="#font" class="toc">font</a></span></div></li>
  49 </ul>
  50 </li>
  51 <li class="level2"><div class="li"><span class="li"><a href="#colors" class="toc">Colors</a></span></div></li>
  52 <li class="level2"><div class="li"><span class="li"><a href="#attributes" class="toc">Attributes</a></span></div></li>
  53 <li class="level2"><div class="li"><span class="li"><a href="#embedded_components" class="toc">Embedded Components</a></span></div></li>
  54 <li class="level2"><div class="li"><span class="li"><a href="#document_revision_history" class="toc">Document Revision History</a></span></div></li></ul>
  55 </li></ul>
  56 </div>
  57 </div>
  58
  59
  60
  61 <h1><a name="geda_gaf_file_format_document" id="geda_gaf_file_format_document">gEDA/gaf File Format Document</a></h1>
  62 <div class="level1">
  63
  64 <p>
  65 by: Ales V. Hvezda, ahvezda@geda.seul.org
  66 </p>
  67
  68 <p>
  69 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>
  70 </p>
  71
  72 <p>
  73 December 31st, 2003
  74 </p>
  75
  76 </div>
  77 <!-- SECTION "gEDA/gaf File Format Document" [1-187] -->
  78 <h2><a name="overview" id="overview">Overview</a></h2>
  79 <div class="level2">
  80
  81 <p>
  82 This file is the official documentation for the file formats in gEDA/gaf (gschem And Friends). The primary file format used in gEDA/gaf is the schematic/symbol format. Files which end with .sch or .sym are schematics or symbol files. Until there is another file type in gEDA/gaf, then this document will only cover the symbol/schematic file format.<br/>
  83  This file format document is current as of gEDA/gaf version 20040111. This document covers file format version 1.<br/>
  84  Note, this file format and any other file formats associated with gEDA are placed under the General Public License (<acronym title="GNU General Public License">GPL</acronym>) version 2.0. The gEDA/gaf symbol and schematic file format is Copyright (C) 1998-2004 Ales Hvezda.
  85 </p>
  86
  87 </div>
  88 <!-- SECTION "Overview" [188-896] -->
  89 <h2><a name="coordinate_space" id="coordinate_space">Coordinate Space</a></h2>
  90 <div class="level2">
  91
  92 <p>
  93 All coordinates are in mils (1/1000 or an inch). This is an arbitrary decision. Remember in there is no concept of physical lengths/dimensions in schematics and symbols (for schematic capture only).<br/>
  94
  95 </p>
  96 <ul>
  97 <li class="level1"><div class="li"> Origin is in lower left hand corner.</div>
  98 </li>
  99 <li class="level1"><div class="li"> The size of the coordinate space is unlimited, but it is recommended that all objects stay within (120.0, 90.0) (x, y inches).</div>
 100 </li>
 101 <li class="level1"><div class="li"> It is generally advisable to have positive x and y coordinates, however, negative coordinates work too, but not recommended.</div>
 102 </li>
 103 </ul>
 104
 105 <p>
 106  The following figure shows how the coordinate space is setup:
 107 </p>
 108 <table class="inline">
 109         <tr>
 110                 <td><a href="_detail/geda_coordinatespace.html" class="media" title="geda:coordinatespace.jpg"><img src="_media/geda_coordinatespace.jpg" class="mediaright" title=":geda:coordinatespace.jpg " alt=":geda:coordinatespace.jpg " /></a></td>
 111         </tr>
 112 </table>
 113
 114 <p>
 115  X axis increases going to the right. Y axis increase going up. Coordinate system is landscape and corresponds to a sheet of paper turned on its side.
 116 </p>
 117
 118 </div>
 119 <!-- SECTION "Coordinate Space" [897-1703] -->
 120 <h2><a name="filenames" id="filenames">Filenames</a></h2>
 121 <div class="level2">
 122
 123 <p>
 124 Symbols end in .sym. The only symbol filename convention that is used in gEDA/gaf is that if there are multiple instances of a symbol with the same name (like a 7400), then a -1, -2, -3, &hellip; -N suffix is added to the end of the filename. Example: 7400-1.sym, 7400-2.sym, 7400-3.sym&hellip;<br/>
 125  Schematics end in .sch. There used to be a schematic filename convention (adding a -1 .. -N to the end of the basename), but this convention is now obsolete. Schematic filenames can be anything that makes sense to the creator.
 126 </p>
 127
 128 </div>
 129 <!-- SECTION "Filenames" [1704-2240] -->
 130 <h2><a name="object_types" id="object_types">Object types</a></h2>
 131 <div class="level2">
 132
 133 <p>
 134 A schematic/symbol file for gEDA/gaf consists of:
 135 </p>
 136 <ul>
 137 <li class="level1"><div class="li"> A version (v) as the first item in the file. This is required.</div>
 138 </li>
 139 <li class="level1"><div class="li"> Any number of objects and the correct data. Objects are specified by an “object type”</div>
 140 </li>
 141 <li class="level1"><div class="li"> Most objects are a single line, however text objects are two lines long.</div>
 142 </li>
 143 <li class="level1"><div class="li"> No blank lines at the end of the file (these are ignored by the tools)</div>
 144 </li>
 145 <li class="level1"><div class="li"> For all enumerated types in the gEDA/gaf file formats, the field takes on the numeric value.</div>
 146 </li>
 147 </ul>
 148
 149 <p>
 150  The “object type” id is a single letter and this id must start in the first column. The object type id is case sensitive.<br/>
 151  The schematic and symbol files share the same file layout. A symbol is nothing more than a collection of primitive objects (lines, boxes, circles, arcs, text, and pins). A schematic is a collection of symbols (components), nets, and buses.<br/>
 152  The following sections describe the specifics of each recognized object type. Each section has the name of the object, which file type (sch/sym) the object can appear in, the format of the data, a description of each individual field, details and caveats of the fields, and finally an example with description.<br/>
 153  For information on the color index (which is used in practically all objects), see the Color section.
 154 </p>
 155
 156 </div>
 157 <!-- SECTION "Object types" [2241-3508] -->
 158 <h3><a name="version" id="version">version</a></h3>
 159 <div class="level3">
 160
 161 <p>
 162 Valid in: Schematic and Symbol files<br/>
 163  <strong><code>type version</code></strong>
 164 </p>
 165 <table class="inline">
 166         <tr>
 167                 <th>Field</th><th>Type/unit</th><th>Description</th>
 168         </tr>
 169         <tr>
 170                 <td>type</td><td>char</td><td>v</td>
 171         </tr>
 172         <tr>
 173                 <td>version</td><td>int</td><td>version of gEDA/gaf that wrote this file</td>
 174         </tr>
 175         <tr>
 176                 <td>fileformat_version</td><td>int</td><td>gEDA/gaf file format version number</td>
 177         </tr>
 178 </table>
 179 <ul>
 180 <li class="level1"><div class="li"> The type is a lower case “v” (as in Victor).</div>
 181 </li>
 182 <li class="level1"><div class="li"> This object must be in every file used or created by the gEDA/gaf tools.</div>
 183 </li>
 184 <li class="level1"><div class="li"> The format of the first version field is YYYYMMDD.</div>
 185 </li>
 186 <li class="level1"><div class="li"> The version number is not an arbitrary timestamp. Do not make up a version number and expect the tools to behave properly.</div>
 187 </li>
 188 <li class="level1"><div class="li"> The “version of gEDA/gaf that wrote this file” was used in all versions of gEDA/gaf up to 20030921 as the file formats version. This field should no longer be used to determine the file format. It is used for information purposes only now.</div>
 189 </li>
 190 <li class="level1"><div class="li"> Starting at and after gEDA/gaf version 20031004, the fileformat version field is used to determine the file format version. All file format code should key off of this field.</div>
 191 </li>
 192 <li class="level1"><div class="li"> fileformat version increases when the file format changes.</div>
 193 </li>
 194 <li class="level1"><div class="li"> The starting point for fileformat version is 1.</div>
 195 </li>
 196 <li class="level1"><div class="li"> fileformat version is just an integer with no minor number.</div>
 197 </li>
 198 <li class="level1"><div class="li"> Development versions include: 19990601, 19990610, 19990705, 19990829, 19990919, 19991011, 20000220, 20000704, 20001006, 20001217, 20010304, 20010708, 20010722, 20020209, 20020414, 20020527, 20020825, 20021103, 20030223, 20030525, 20030901, 20040111, 20040710, 20041228, 20050313, 20050820, 20060123, 20060824, 20060906, 20061020, 20070216, 20070705, 20070708</div>
 199 </li>
 200 <li class="level1"><div class="li"> Stable versions include: 20070526, 20070626</div>
 201 </li>
 202 <li class="level1"><div class="li"> <acronym title="Concurrent Versions System">CVS</acronym> or test versions (should not be used): 20030921, 20031004, 20031019, 20031231, 20050814</div>
 203 </li>
 204 <li class="level1"><div class="li"> Keep in mind that each of the above listed versions might have had file format variations. This document only covers the last version’s file format.</div>
 205 </li>
 206 </ul>
 207
 208 <p>
 209  Example:<br/>
 210
 211 </p>
 212 <pre class="code">v 20040111 1</pre>
 213
 214 </div>
 215 <!-- SECTION "version" [3509-5357] -->
 216 <h3><a name="line" id="line">line</a></h3>
 217 <div class="level3">
 218
 219 <p>
 220 Valid in: Schematic and Symbol files<br/>
 221  <strong><code>type x1 y1 x2 y2 color width capstyle dashstyle dashlength dashspace</code></strong>
 222 </p>
 223 <table class="inline">
 224         <tr>
 225                 <th>Field</th><th>Type/unit</th><th>Description</th>
 226         </tr>
 227         <tr>
 228                 <td>type</td><td>char</td><td>L</td>
 229         </tr>
 230         <tr>
 231                 <td>x1</td><td>int/mils</td><td>First X coordinate</td>
 232         </tr>
 233         <tr>
 234                 <td>y1</td><td>int/mils</td><td>First Y coordinate</td>
 235         </tr>
 236         <tr>
 237                 <td>x2</td><td>int/mils</td><td>Second X coordinate</td>
 238         </tr>
 239         <tr>
 240                 <td>y2</td><td>int/mils</td><td>Second Y coordinate</td>
 241         </tr>
 242         <tr>
 243                 <td>color</td><td>int</td><td>Color index</td>
 244         </tr>
 245         <tr>
 246                 <td>width</td><td>int/mils</td><td>Width of line</td>
 247         </tr>
 248         <tr>
 249                 <td>capstyle</td><td>int</td><td>Line cap style</td>
 250         </tr>
 251         <tr>
 252                 <td>dashstyle</td><td>int</td><td>Type of dash style</td>
 253         </tr>
 254         <tr>
 255                 <td>dashlength</td><td>int</td><td>Length of dash</td>
 256         </tr>
 257         <tr>
 258                 <td>dashspace</td><td>int</td><td>Space inbetween dashes</td>
 259         </tr>
 260 </table>
 261 <ul>
 262 <li class="level1"><div class="li"> The capstyle is an enumerated type:</div>
 263 <ul>
 264 <li class="level2"><div class="li"> END NONE = 0</div>
 265 </li>
 266 <li class="level2"><div class="li"> END SQUARE = 1</div>
 267 </li>
 268 <li class="level2"><div class="li"> END ROUND = 2</div>
 269 </li>
 270 </ul>
 271 </li>
 272 <li class="level1"><div class="li"> The dashstyle is an enumerated type:</div>
 273 <ul>
 274 <li class="level2"><div class="li"> TYPE SOLID = 0</div>
 275 </li>
 276 <li class="level2"><div class="li"> TYPE DOTTED = 1</div>
 277 </li>
 278 <li class="level2"><div class="li"> TYPE DASHED = 2</div>
 279 </li>
 280 <li class="level2"><div class="li"> TYPE CENTER = 3</div>
 281 </li>
 282 <li class="level2"><div class="li"> TYPE PHANTOM = 4</div>
 283 </li>
 284 </ul>
 285 </li>
 286 <li class="level1"><div class="li"> The dashlength parameter is not used for TYPE SOLID and TYPE DOTTED. This parameter should take on a value of -1 in these cases.</div>
 287 </li>
 288 <li class="level1"><div class="li"> The dashspace paramater is not used for TYPE SOLID. This parameter should take on a value of -1 in these case.</div>
 289 </li>
 290 </ul>
 291
 292 <p>
 293  Example:<br/>
 294
 295 </p>
 296 <pre class="code">L 23000 69000 28000 69000 3 40 0 1 -1 75</pre>
 297
 298 <p>
 299 A line segment from (23000, 69000) to (28000, 69000) with color index 3, 40 mils thick, no cap, dotted line style, and with a spacing of 75 mils in between each dot.
 300 </p>
 301
 302 </div>
 303 <!-- SECTION "line" [5358-6592] -->
 304 <h3><a name="picture" id="picture">picture</a></h3>
 305 <div class="level3">
 306
 307 <p>
 308 Valid in: Schematic and Symbol files<br/>
 309  <strong><code>type x1 y1 width height angle ratio mirrored embedded<br/>
 310
 311 filename<br/>
 312
 313 [encoded picture data<br/>
 314
 315 encoded picture end]</code></strong>
 316 </p>
 317 <table class="inline">
 318         <tr>
 319                 <th>Field</th><th>Type/unit</th><th>Description</th>
 320         </tr>
 321         <tr>
 322                 <td>type</td><td>char</td><td>G</td>
 323         </tr>
 324         <tr>
 325                 <td>x</td><td>int/mils</td><td>Lower left X coordinate</td>
 326         </tr>
 327         <tr>
 328                 <td>y</td><td>int/mils</td><td>Lower left Y coordinate</td>
 329         </tr>
 330         <tr>
 331                 <td>width</td><td>int/mils</td><td>Width of the picture</td>
 332         </tr>
 333         <tr>
 334                 <td>height</td><td>int/mils</td><td>Height of the picture</td>
 335         </tr>
 336         <tr>
 337                 <td>angle</td><td>int/degrees</td><td>Angle of the picture</td>
 338         </tr>
 339         <tr>
 340                 <td>mirrored</td><td>char</td><td>Mirrored or normal picture</td>
 341         </tr>
 342         <tr>
 343                 <td>embedded</td><td>char</td><td>Embedded or link to the picture file</td>
 344         </tr>
 345         <tr>
 346                 <td>filename</td><td>string</td><td>path and filename of a not embedded picture</td>
 347         </tr>
 348         <tr>
 349                 <td>encoded picture data</td><td>string</td><td>Serialized picture encoded using base64</td>
 350         </tr>
 351         <tr>
 352                 <td>encoded picture end</td><td>string</td><td>A line containing only a dot character</td>
 353         </tr>
 354 </table>
 355 <ul>
 356 <li class="level1"><div class="li"> This object is a picture object. The first line contains all the picture parameters, and the second line is the path and filename of the picture. The filename is not used if the picture is embedded.</div>
 357 </li>
 358 <li class="level1"><div class="li"> The angle of the picture can only take on one of the following values: 0, 90, 180, 270.</div>
 359 </li>
 360 <li class="level1"><div class="li"> The mirrored field is an enumerated type:</div>
 361 <ul>
 362 <li class="level2"><div class="li"> NOT MIRRORED = 0</div>
 363 </li>
 364 <li class="level2"><div class="li"> MIRRORED = 1</div>
 365 </li>
 366 </ul>
 367 </li>
 368 <li class="level1"><div class="li"> The embedded field is an enumerated type:</div>
 369 <ul>
 370 <li class="level2"><div class="li"> NOT EMBEDDED = 0</div>
 371 </li>
 372 <li class="level2"><div class="li"> EMBEDDED = 1 (not yet supported)</div>
 373 </li>
 374 </ul>
 375 </li>
 376 <li class="level1"><div class="li"> The encoded picture and encoded picture end fields are only in the file if the picture is embedded in the schematic:</div>
 377 <ul>
 378 <li class="level2"><div class="li"> encoded picture data: This is a multiple line field. The picture is serialized and then encoded using base64. This way the encoded data uses only printable characters. This field is the result of these two operations.</div>
 379 </li>
 380 <li class="level2"><div class="li"> encoded picture end : A line containing only a single dot &#039;.&#039; character marks the end of the encoded picture data.</div>
 381 </li>
 382 </ul>
 383 </li>
 384 </ul>
 385
 386 <p>
 387  Example:<br/>
 388
 389 </p>
 390 <pre class="code">G 16900 35800 1400 2175 0 6.435331e-01 0 0
 391 ../bitmaps/logo.jpg</pre>
 392
 393 <p>
 394 A picture object with the lower left corner at (16900, 35800). The width of the image is 1400 mils, and its height is 2175 mils (i.e.: the ratio is 0.6353). The picture rotation is 0 degrees and the picture is not mirrored, neither embedded.<br/>
 395  The picture path and filename is showed in the second line.<br/>
 396  Example:<br/>
 397
 398 </p>
 399 <pre class="code">G 16900 35800 1400 2175 0 6.435331e-01 0 1
 400 ../bitmaps/logo.jpg
 401 AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
 402 BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
 403 .</pre>
 404
 405 <p>
 406 A picture object with the lower left corner at (16900, 35800). The width of the image is 1400 mils, and its height is 2175 mils (i.e.: the ratio is 0.6353).<br/>
 407  The picture rotation is 0 degrees, it is not mirrored, and it is embedded.<br/>
 408  The picture path and filename is showed in the second line. Since this is an embedded picture, the filename and path are not used.<br/>
 409  The encoded picture data is only an example (it is not real data). The last line containing a single dot &#039;.&#039; character marks the end of the encoded picture data.
 410 </p>
 411
 412 </div>
 413 <!-- SECTION "picture" [6593-9386] -->
 414 <h3><a name="box" id="box">box</a></h3>
 415 <div class="level3">
 416
 417 <p>
 418 Valid in: Schematic and Symbol files<br/>
 419  <strong><code>type x y width height color width capstyle dashtype dashlength dashspace
 420 filltype fillwidth angle1 pitch1 angle2 pitch2</code></strong>
 421 </p>
 422 <table class="inline">
 423         <tr>
 424                 <th>Field</th><th>Type/unit</th><th>Description</th>
 425         </tr>
 426         <tr>
 427                 <td>type</td><td>char</td><td>B</td>
 428         </tr>
 429         <tr>
 430                 <td>x</td><td>int/mils</td><td>Lower left hand X coordinate</td>
 431         </tr>
 432         <tr>
 433                 <td>y</td><td>int/mils</td><td>Lower left hand Y coordinate</td>
 434         </tr>
 435         <tr>
 436                 <td>width</td><td>int/mils</td><td>Width of the box (x direction)</td>
 437         </tr>
 438         <tr>
 439                 <td>height</td><td>int/mils</td><td>Height of the box (y direction)</td>
 440         </tr>
 441         <tr>
 442                 <td>color</td><td>int</td><td>Color index</td>
 443         </tr>
 444         <tr>
 445                 <td>width</td><td>int/mils</td><td>Width of lines</td>
 446         </tr>
 447         <tr>
 448                 <td>capstyle</td><td>int/mils</td><td>Line cap style</td>
 449         </tr>
 450         <tr>
 451                 <td>dashstyle</td><td>int</td><td>Type of dash style</td>
 452         </tr>
 453         <tr>
 454                 <td>dashlength</td><td>int/mils</td><td>Length of dash</td>
 455         </tr>
 456         <tr>
 457                 <td>dashspace</td><td>int/mils</td><td>Space inbetween dashes</td>
 458         </tr>
 459         <tr>
 460                 <td>filltype</td><td>int</td><td>Type of fill</td>
 461         </tr>
 462         <tr>
 463                 <td>fillwidth</td><td>int/mils</td><td>Width of the fill lines</td>
 464         </tr>
 465         <tr>
 466                 <td>angle1</td><td>int/degrees</td><td>First angle of fill</td>
 467         </tr>
 468         <tr>
 469                 <td>pitch1</td><td>int/mils</td><td>First pitch/spacing of fill</td>
 470         </tr>
 471         <tr>
 472                 <td>angle2</td><td>int/degrees</td><td>Second angle of fill</td>
 473         </tr>
 474         <tr>
 475                 <td>pitch2</td><td>int/mils</td><td>Second pitch/spacing of fill</td>
 476         </tr>
 477 </table>
 478 <ul>
 479 <li class="level1"><div class="li"> The capstyle is an enumerated type:</div>
 480 <ul>
 481 <li class="level2"><div class="li"> END NONE = 0</div>
 482 </li>
 483 <li class="level2"><div class="li"> END SQUARE = 1</div>
 484 </li>
 485 <li class="level2"><div class="li"> END ROUND = 2</div>
 486 </li>
 487 </ul>
 488 </li>
 489 <li class="level1"><div class="li"> The dashstyle is an enumerated type:</div>
 490 <ul>
 491 <li class="level2"><div class="li"> TYPE SOLID = 0</div>
 492 </li>
 493 <li class="level2"><div class="li"> TYPE DOTTED = 1</div>
 494 </li>
 495 <li class="level2"><div class="li"> TYPE DASHED = 2</div>
 496 </li>
 497 <li class="level2"><div class="li"> TYPE CENTER = 3</div>
 498 </li>
 499 <li class="level2"><div class="li"> TYPE PHANTOM = 4</div>
 500 </li>
 501 </ul>
 502 </li>
 503 <li class="level1"><div class="li"> The dashlength parameter is not used for TYPE SOLID and TYPE DOTTED. This parameter should take on a value of -1 in these cases.</div>
 504 </li>
 505 <li class="level1"><div class="li"> The dashspace paramater is not used for TYPE SOLID. This parameter should take on a value of -1 in these case.</div>
 506 </li>
 507 <li class="level1"><div class="li"> The filltype parameter is an enumerated type:</div>
 508 <ul>
 509 <li class="level2"><div class="li"> FILLING HOLLOW = 0</div>
 510 </li>
 511 <li class="level2"><div class="li"> FILLING FILL = 1</div>
 512 </li>
 513 <li class="level2"><div class="li"> FILLING MESH = 2</div>
 514 </li>
 515 <li class="level2"><div class="li"> FILLING HATCH = 3</div>
 516 </li>
 517 <li class="level2"><div class="li"> FILLING VOID = 4 unused</div>
 518 </li>
 519 </ul>
 520 </li>
 521 <li class="level1"><div class="li"> If the filltype is 0 (FILLING HOLLOW), then all the fill parameters should take on a value of -1.</div>
 522 </li>
 523 <li class="level1"><div class="li"> The fill type FILLING FILL is a solid color fill.</div>
 524 </li>
 525 <li class="level1"><div class="li"> The two pairs of pitch and spacing control the fill or hatch if the fill type is FILLING MESH.</div>
 526 </li>
 527 <li class="level1"><div class="li"> Only the first pair of pitch and spacing are used if the fill type is FILLING HATCH.</div>
 528 </li>
 529 </ul>
 530
 531 <p>
 532  Example:<br/>
 533
 534 </p>
 535 <pre class="code">B 33000 67300 2000 2000 3 60 0 2 75 50 0 -1 -1 -1 -1 -1</pre>
 536
 537 <p>
 538 A box with the lower left hand corner at (33000, 67300) and a width and height of (2000, 2000), color index 3, line width of 60 mils, no cap, dashed line type, dash length of 75 mils, dash spacing of 50 mils, no fill, rest parameters unset.
 539 </p>
 540
 541 </div>
 542 <!-- SECTION "box" [9387-11593] -->
 543 <h3><a name="circle" id="circle">circle</a></h3>
 544 <div class="level3">
 545
 546 <p>
 547 Valid in: Schematic and Symbol files<br/>
 548  <strong><code>type x y radius color width capstyle dashtype dashlength dashspace
 549 filltype fillwidth angle1 pitch1 angle2 pitch2</code></strong>
 550 </p>
 551 <table class="inline">
 552         <tr>
 553                 <th>Field</th><th>Type/unit</th><th>Description</th>
 554         </tr>
 555         <tr>
 556                 <td>type</td><td>char</td><td>V</td>
 557         </tr>
 558         <tr>
 559                 <td>x</td><td>int/mils</td><td>Center X coordinate</td>
 560         </tr>
 561         <tr>
 562                 <td>y</td><td>int/mils</td><td>Center Y coordinate</td>
 563         </tr>
 564         <tr>
 565                 <td>radius</td><td>int/mils</td><td>Radius of the circle</td>
 566         </tr>
 567         <tr>
 568                 <td>color</td><td>int</td><td>Color index</td>
 569         </tr>
 570         <tr>
 571                 <td>width</td><td>int/mils</td><td>Width of circle line</td>
 572         </tr>
 573         <tr>
 574                 <td>capstyle</td><td>int/mils</td><td>0 unused</td>
 575         </tr>
 576         <tr>
 577                 <td>dashstyle</td><td>int</td><td>Type of dash style</td>
 578         </tr>
 579         <tr>
 580                 <td>dashlength</td><td>int/mils</td><td>Length of dash</td>
 581         </tr>
 582         <tr>
 583                 <td>dashspace</td><td>int/mils</td><td>Space inbetween dashes</td>
 584         </tr>
 585         <tr>
 586                 <td>filltype</td><td>int</td><td>Type of fill</td>
 587         </tr>
 588         <tr>
 589                 <td>fillwidth</td><td>int/mils</td><td>Width of the fill lines</td>
 590         </tr>
 591         <tr>
 592                 <td>angle1</td><td>int/degrees</td><td>First angle of fill</td>
 593         </tr>
 594         <tr>
 595                 <td>pitch1</td><td>int/mils</td><td>First pitch/spacing of fill</td>
 596         </tr>
 597         <tr>
 598                 <td>angle2</td><td>int/degrees</td><td>Second angle of fill</td>
 599         </tr>
 600         <tr>
 601                 <td>pitch2</td><td>int/mils</td><td>Second pitch/spacing of fill</td>
 602         </tr>
 603 </table>
 604 <ul>
 605 <li class="level1"><div class="li"> The dashstyle is an enumerated type:</div>
 606 <ul>
 607 <li class="level2"><div class="li"> TYPE SOLID = 0</div>
 608 </li>
 609 <li class="level2"><div class="li"> TYPE DOTTED = 1</div>
 610 </li>
 611 <li class="level2"><div class="li"> TYPE DASHED = 2</div>
 612 </li>
 613 <li class="level2"><div class="li"> TYPE CENTER = 3</div>
 614 </li>
 615 <li class="level2"><div class="li"> TYPE PHANTOM = 4</div>
 616 </li>
 617 </ul>
 618 </li>
 619 <li class="level1"><div class="li"> The dashlength parameter is not used for TYPE SOLID and TYPE DOTTED. This parameter should take on a value of -1 in these cases.</div>
 620 </li>
 621 <li class="level1"><div class="li"> The dashspace paramater is not used for TYPE SOLID. This parameter should take on a value of -1 in these case.</div>
 622 </li>
 623 <li class="level1"><div class="li"> The filltype parameter is an enumerated type:</div>
 624 <ul>
 625 <li class="level2"><div class="li"> FILLING HOLLOW = 0</div>
 626 </li>
 627 <li class="level2"><div class="li"> FILLING FILL = 1</div>
 628 </li>
 629 <li class="level2"><div class="li"> FILLING MESH = 2</div>
 630 </li>
 631 <li class="level2"><div class="li"> FILLING HATCH = 3</div>
 632 </li>
 633 <li class="level2"><div class="li"> FILLING VOID = 4 unused</div>
 634 </li>
 635 </ul>
 636 </li>
 637 <li class="level1"><div class="li"> If the filltype is 0 (FILLING HOLLOW), then all the fill parameters should take on a value of -1.</div>
 638 </li>
 639 <li class="level1"><div class="li"> The fill type FILLING FILL is a solid color fill.</div>
 640 </li>
 641 <li class="level1"><div class="li"> The two pairs of pitch and spacing control the fill or hatch if the fill type is FILLING MESH.</div>
 642 </li>
 643 <li class="level1"><div class="li"> Only the first pair of pitch and spacing are used if the fill type is FILLING HATCH.</div>
 644 </li>
 645 </ul>
 646
 647 <p>
 648  Example:<br/>
 649
 650 </p>
 651 <pre class="code">V 38000 67000 900 3 0 0 2 75 50 2 10 20 30 90 50</pre>
 652
 653 <p>
 654 A circle with the center at (38000, 67000) and a radius of 900 mils, color index 3, line width of 0 mils (smallest size), no cap, dashed line type, dash length of 75 mils, dash spacing of 50 mils, mesh fill, 10 mils thick mesh lines, first mesh line: 20 degrees, with a spacing of 30 mils, second mesh line: 90 degrees, with a spacing of 50 mils.
 655 </p>
 656
 657 </div>
 658 <!-- SECTION "circle" [11594-13719] -->
 659 <h3><a name="arc" id="arc">arc</a></h3>
 660 <div class="level3">
 661
 662 <p>
 663 Valid in: Schematic and Symbol files<br/>
 664  <strong><code>type x y radius startangle sweepangle color width capstyle dashtype
 665 dashlength dashspace</code></strong>
 666 </p>
 667 <table class="inline">
 668         <tr>
 669                 <th>Field</th><th>Type/unit</th><th>Description</th>
 670         </tr>
 671         <tr>
 672                 <td>type</td><td>char</td><td>A</td>
 673         </tr>
 674         <tr>
 675                 <td>x</td><td>int/mils</td><td>Center X coordinate</td>
 676         </tr>
 677         <tr>
 678                 <td>y</td><td>int/mils</td><td>Center Y coordinate</td>
 679         </tr>
 680         <tr>
 681                 <td>radius</td><td>int/mils</td><td>Radius of the arc</td>
 682         </tr>
 683         <tr>
 684                 <td>startangle</td><td>int/degrees</td><td>Starting angle of the arc</td>
 685         </tr>
 686         <tr>
 687                 <td>sweepangle</td><td>int/degrees</td><td>Amount the arc sweeps</td>
 688         </tr>
 689         <tr>
 690                 <td>color</td><td>int</td><td>Color index</td>
 691         </tr>
 692         <tr>
 693                 <td>width</td><td>int/mils</td><td>Width of circle line</td>
 694         </tr>
 695         <tr>
 696                 <td>capstyle</td><td>int</td><td>Cap style</td>
 697         </tr>
 698         <tr>
 699                 <td>dashstyle</td><td>int</td><td>Type of dash style</td>
 700         </tr>
 701         <tr>
 702                 <td>dashlength</td><td>int/mils</td><td>Length of dash</td>
 703         </tr>
 704         <tr>
 705                 <td>dashspace</td><td>int/mils</td><td>Space inbetween dashes</td>
 706         </tr>
 707 </table>
 708 <ul>
 709 <li class="level1"><div class="li"> The startangle can be negative, but not recommended.</div>
 710 </li>
 711 <li class="level1"><div class="li"> The sweepangle can be negative, but not recommended.</div>
 712 </li>
 713 <li class="level1"><div class="li"> The capstyle is an enumerated type:</div>
 714 <ul>
 715 <li class="level2"><div class="li"> END NONE = 0</div>
 716 </li>
 717 <li class="level2"><div class="li"> END SQUARE = 1</div>
 718 </li>
 719 <li class="level2"><div class="li"> END ROUND = 2</div>
 720 </li>
 721 </ul>
 722 </li>
 723 <li class="level1"><div class="li"> The dashstyle is an enumerated type:</div>
 724 <ul>
 725 <li class="level2"><div class="li"> TYPE SOLID = 0</div>
 726 </li>
 727 <li class="level2"><div class="li"> TYPE DOTTED = 1</div>
 728 </li>
 729 <li class="level2"><div class="li"> TYPE DASHED = 2</div>
 730 </li>
 731 <li class="level2"><div class="li"> TYPE CENTER = 3</div>
 732 </li>
 733 <li class="level2"><div class="li"> TYPE PHANTOM = 4</div>
 734 </li>
 735 </ul>
 736 </li>
 737 <li class="level1"><div class="li"> The dashlength parameter is not used for TYPE SOLID and TYPE DOTTED. This parameter should take on a value of -1 in these cases.</div>
 738 </li>
 739 <li class="level1"><div class="li"> The dashspace paramater is not used for TYPE SOLID. This parameter should take on a value of -1 in these case.</div>
 740 </li>
 741 </ul>
 742
 743 <p>
 744  Example:<br/>
 745
 746 </p>
 747 <pre class="code">A 30600 75000 2000 0 45 3 0 0 3 75 50</pre>
 748
 749 <p>
 750  An arc with the center at (30600, 75000) and a radius of 2000 mils, a starting angle of 0, sweeping 45 degrees, color index 3, line width of 0 mils (smallest size), no cap, center line type, dash length of 75 mils, dash spacing of 50 mils.
 751 </p>
 752
 753 </div>
 754 <!-- SECTION "arc" [13720-15235] -->
 755 <h3><a name="text" id="text">text</a></h3>
 756 <div class="level3">
 757
 758 <p>
 759 Valid in: Schematic and Symbol files<br/>
 760  <strong><code>type x y color size visibility show_name_value angle alignment num_lines<br/>
 761
 762 string line 1<br/>
 763
 764 string line 2<br/>
 765
 766 string line 3<br/>
 767
 768 &hellip;<br/>
 769
 770 string line N</code></strong>
 771 </p>
 772 <table class="inline">
 773         <tr>
 774                 <th>Field</th><th>Type/unit</th><th>Description</th>
 775         </tr>
 776         <tr>
 777                 <td>type</td><td>char</td><td>T</td>
 778         </tr>
 779         <tr>
 780                 <td>x</td><td>int/mils</td><td>First X coordinate</td>
 781         </tr>
 782         <tr>
 783                 <td>y</td><td>int/mils</td><td>First Y coordinate</td>
 784         </tr>
 785         <tr>
 786                 <td>color</td><td>int</td><td>Color index</td>
 787         </tr>
 788         <tr>
 789                 <td>size</td><td>int/points</td><td>Size of text</td>
 790         </tr>
 791         <tr>
 792                 <td>visibility</td><td>int</td><td>Visibility of text</td>
 793         </tr>
 794         <tr>
 795                 <td>show_name_value</td><td>int</td><td>Attribute visibility control</td>
 796         </tr>
 797         <tr>
 798                 <td>angle</td><td>int/degrees</td><td>Angle of the text</td>
 799         </tr>
 800         <tr>
 801                 <td>alignment</td><td>int</td><td>Alignment/origin of the text</td>
 802         </tr>
 803         <tr>
 804                 <td>num_lines</td><td>int</td><td>Number of lines of text (1 based)</td>
 805         </tr>
 806         <tr>
 807                 <td>string line 1 &hellip; N</td><td>string</td><td>The text strings, on a seperate line</td>
 808         </tr>
 809 </table>
 810 <ul>
 811 <li class="level1"><div class="li"> This object is a multi line object. The first line contains all the text parameters and the subsequent lines are the text strings.</div>
 812 </li>
 813 <li class="level1"><div class="li"> There must be exactly num lines of text following the T &hellip; string.</div>
 814 </li>
 815 <li class="level1"><div class="li"> The maximum length of any single text string is 1024, however there is no limit to the number of text string lines.</div>
 816 </li>
 817 <li class="level1"><div class="li"> The minimum size is 2 points (1/72 of an inch).</div>
 818 </li>
 819 <li class="level1"><div class="li"> There is no maximum size.</div>
 820 </li>
 821 <li class="level1"><div class="li"> The coordinate pair is the origin of the text item.</div>
 822 </li>
 823 <li class="level1"><div class="li"> The visibility field is an enumerated type:</div>
 824 <ul>
 825 <li class="level2"><div class="li"> INVISIBLE = 0</div>
 826 </li>
 827 <li class="level2"><div class="li"> VISIBLE = 1</div>
 828 </li>
 829 </ul>
 830 </li>
 831 <li class="level1"><div class="li"> The show_name_value is an enumerated type:</div>
 832 <ul>
 833 <li class="level2"><div class="li"> SHOW NAME VALUE = 0 (show both name and value of an attribute)</div>
 834 </li>
 835 <li class="level2"><div class="li"> SHOW VALUE = 1 (show only the value of an attribute)</div>
 836 </li>
 837 <li class="level2"><div class="li"> SHOW NAME = 2 (show only the name of an attribute)</div>
 838 </li>
 839 </ul>
 840 </li>
 841 <li class="level1"><div class="li"> The show_name_value field is only valid if the string is an attribute (string has to be in the form: name=value to be considered an attribute).</div>
 842 </li>
 843 <li class="level1"><div class="li"> The angle of the text can only take on one of the following values: 0, 90, 180, 270. A value of 270 will always generate upright text.</div>
 844 </li>
 845 <li class="level1"><div class="li"> The alignment/origin field controls the relative location of the origin.</div>
 846 </li>
 847 <li class="level1"><div class="li"> The alignment field can take a value from 0 to 8.</div>
 848 </li>
 849 <li class="level1"><div class="li"> The num_lines field always starts at 1.</div>
 850 </li>
 851 <li class="level1"><div class="li"> The num_lines field was added starting with file format version 1. Past versions (0 or earlier) only supported single line text objects.<br/>
 852  The following diagram shows what the values for the alignment field mean:</div>
 853 </li>
 854 </ul>
 855 <table class="inline">
 856         <tr>
 857                 <td> <a href="_detail/geda_fileformat_textgraphic.html" class="media" title="geda:fileformat_textgraphic.jpg"><img src="_media/geda_fileformat_textgraphic.jpg" class="media" title="fileformat_textgraphic.jpg" alt="fileformat_textgraphic.jpg" /></a> </td>
 858         </tr>
 859 </table>
 860
 861 <p>
 862  Example:<br/>
 863
 864 </p>
 865 <pre class="code">T 16900 35800 3 10 1 0 0 0 1
 866 Text string!</pre>
 867
 868 <p>
 869 A text object with the origin at (16900, 35800), color index 3, 10 points in size, visible, attribute  ags not valid (not an attribute), origin at lower left, string: Text string!
 870 </p>
 871
 872 <p>
 873 Example:<br/>
 874
 875 </p>
 876 <pre class="code">T 16900 35800 3 10 1 0 0 0 5
 877 Text string line 1
 878 Text string line 2
 879 Text string line 3
 880 Text string line 4
 881 Text string line 5</pre>
 882
 883 <p>
 884 This is a similar text object as the above example, however here there are five lines of text.
 885 </p>
 886
 887 </div>
 888 <!-- SECTION "text" [15236-17889] -->
 889 <h3><a name="net" id="net">net</a></h3>
 890 <div class="level3">
 891
 892 <p>
 893 Valid in: Schematic files ONLY<br/>
 894  <strong><code>type x1 y1 x2 y2 color</code></strong>
 895 </p>
 896 <table class="inline">
 897         <tr>
 898                 <th>Field</th><th>Type/unit</th><th>Description</th>
 899         </tr>
 900         <tr>
 901                 <td>type</td><td>char</td><td>N</td>
 902         </tr>
 903         <tr>
 904                 <td>x1</td><td>int/mils</td><td>First X coordinate</td>
 905         </tr>
 906         <tr>
 907                 <td>y1</td><td>int/mils</td><td>First Y coordinate</td>
 908         </tr>
 909         <tr>
 910                 <td>x2</td><td>int/mils</td><td>Second X coordinate</td>
 911         </tr>
 912         <tr>
 913                 <td>y2</td><td>int/mils</td><td>Second Y coordinate</td>
 914         </tr>
 915         <tr>
 916                 <td>color</td><td>int</td><td>Color index</td>
 917         </tr>
 918 </table>
 919 <ul>
 920 <li class="level1"><div class="li"> Nets can only appear in schematic files.</div>
 921 </li>
 922 <li class="level1"><div class="li"> You cannot have a zero length net (the tools will throw them away).</div>
 923 </li>
 924 </ul>
 925
 926 <p>
 927  Example:<br/>
 928
 929 </p>
 930 <pre class="code">N 12700 29400 32900 29400 4</pre>
 931
 932 <p>
 933 A net segment from (12700, 29400) to (32900, 29400) with color index 4.
 934 </p>
 935
 936 </div>
 937 <!-- SECTION "net" [17890-18415] -->
 938 <h3><a name="bus" id="bus">bus</a></h3>
 939 <div class="level3">
 940
 941 <p>
 942 Valid in: Schematic files ONLY<br/>
 943  <strong><code>type x1 y1 x2 y2 color ripperdir</code></strong>
 944 </p>
 945 <table class="inline">
 946         <tr>
 947                 <th>Field</th><th>Type/unit</th><th>Description</th>
 948         </tr>
 949         <tr>
 950                 <td>type</td><td>char</td><td>U</td>
 951         </tr>
 952         <tr>
 953                 <td>x1</td><td>int/mils</td><td>First X coordinate</td>
 954         </tr>
 955         <tr>
 956                 <td>y1</td><td>int/mils</td><td>First Y coordinate</td>
 957         </tr>
 958         <tr>
 959                 <td>x2</td><td>int/mils</td><td>Second X coordinate</td>
 960         </tr>
 961         <tr>
 962                 <td>y2</td><td>int/mils</td><td>Second Y coordinate</td>
 963         </tr>
 964         <tr>
 965                 <td>color</td><td>int</td><td>Color index</td>
 966         </tr>
 967         <tr>
 968                 <td>ripperdir</td><td>int</td><td>Direction of bus rippers</td>
 969         </tr>
 970 </table>
 971 <ul>
 972 <li class="level1"><div class="li"> The ripperdir field for an brand new bus is 0.</div>
 973 </li>
 974 <li class="level1"><div class="li"> The ripperdir field takes on a value of 1 or -1 when a net is connected to the bus for the first time. This value indicates the direction of the ripper symbol. The ripper direction is set to the same value for the entire life of the bus object.</div>
 975 </li>
 976 <li class="level1"><div class="li"> Buses can only appear in schematic files.</div>
 977 </li>
 978 <li class="level1"><div class="li"> You cannot have a zero length bus (the tools will throw them away).</div>
 979 </li>
 980 </ul>
 981
 982 <p>
 983  Example:<br/>
 984
 985 </p>
 986 <pre class="code">U 27300 37400 27300 35300 3 0</pre>
 987
 988 <p>
 989 A bus segment from (27300, 37400) to (27300, 35300) with color index 3 and no nets have been connected to this bus segment.
 990 </p>
 991
 992 </div>
 993 <!-- SECTION "bus" [18416-19347] -->
 994 <h3><a name="pin" id="pin">pin</a></h3>
 995 <div class="level3">
 996
 997 <p>
 998 Valid in: Symbol files ONLY<br/>
 999  <strong><code>type x1 y1 x2 y2 color pintype whichend</code></strong>
1000 </p>
1001 <table class="inline">
1002         <tr>
1003                 <th>Field</th><th>Type/unit</th><th>Description</th>
1004         </tr>
1005         <tr>
1006                 <td>type</td><td>char</td><td>P</td>
1007         </tr>
1008         <tr>
1009                 <td>x1</td><td>int/mils</td><td>First X coordinate</td>
1010         </tr>
1011         <tr>
1012                 <td>y1</td><td>int/mils</td><td>First Y coordinate</td>
1013         </tr>
1014         <tr>
1015                 <td>x2</td><td>int/mils</td><td>Second X coordinate</td>
1016         </tr>
1017         <tr>
1018                 <td>y2</td><td>int/mils</td><td>Second Y coordinate</td>
1019         </tr>
1020         <tr>
1021                 <td>color</td><td>int</td><td>Color index</td>
1022         </tr>
1023         <tr>
1024                 <td>pintype</td><td>int</td><td>Type of pin</td>
1025         </tr>
1026         <tr>
1027                 <td>whichend</td><td>int</td><td>Specifies the active end</td>
1028         </tr>
1029 </table>
1030 <ul>
1031 <li class="level1"><div class="li"> The pintype is an enumerated type:</div>
1032 <ul>
1033 <li class="level2"><div class="li"> NORMAL <acronym title="Personal Identification Number">PIN</acronym> = 0</div>
1034 </li>
1035 <li class="level2"><div class="li"> BUS <acronym title="Personal Identification Number">PIN</acronym> = 1 unused</div>
1036 </li>
1037 </ul>
1038 </li>
1039 <li class="level1"><div class="li"> The whichend specifies which end point of the pin is the active connection port. Only this end point can have other pins or nets connected to it.</div>
1040 </li>
1041 <li class="level1"><div class="li"> To make the first end point active, whichend should be 0, else to specify the other end, whichend should be 1.</div>
1042 </li>
1043 <li class="level1"><div class="li"> Pins can only appear in symbol files.</div>
1044 </li>
1045 <li class="level1"><div class="li"> You cannot have a zero length pen (the tools will throw them away).</div>
1046 </li>
1047 </ul>
1048
1049 <p>
1050  Example:<br/>
1051
1052 </p>
1053 <pre class="code">P 0 200 200 200 1 0 0</pre>
1054
1055 <p>
1056 A pin from (0, 200) to (200, 200) with color index 1, a regular pin, and the first point being the active connection end.
1057 </p>
1058
1059 </div>
1060 <!-- SECTION "pin" [19348-20344] -->
1061 <h3><a name="component" id="component">component</a></h3>
1062 <div class="level3">
1063
1064 <p>
1065 Valid in: Schematic files ONLY<br/>
1066  <strong><code>type x y selectable angle mirror basename</code></strong>
1067 </p>
1068 <table class="inline">
1069         <tr>
1070                 <th>Field</th><th>Type/unit</th><th>Description</th>
1071         </tr>
1072         <tr>
1073                 <td>type</td><td>char</td><td>C</td>
1074         </tr>
1075         <tr>
1076                 <td>x</td><td>int/mils</td><td>Origin X coordinate</td>
1077         </tr>
1078         <tr>
1079                 <td>y</td><td>int/mils</td><td>Origin Y coordinate</td>
1080         </tr>
1081         <tr>
1082                 <td>selectable</td><td>int</td><td>Selectable flag</td>
1083         </tr>
1084         <tr>
1085                 <td>angle</td><td>int/degrees</td><td>Angle of the component</td>
1086         </tr>
1087         <tr>
1088                 <td>mirror</td><td>int</td><td>Mirror around Y axis</td>
1089         </tr>
1090         <tr>
1091                 <td>basename</td><td>string</td><td>The filename of the component</td>
1092         </tr>
1093 </table>
1094
1095 <p>
1096  The selectable field is either 1 for selectable or 0 if not selectable.
1097 </p>
1098 <ul>
1099 <li class="level1"><div class="li"> The angle field can only take on the following values: 0, 90, 180, 270.</div>
1100 </li>
1101 <li class="level1"><div class="li"> The angle field can only be positive.</div>
1102 </li>
1103 <li class="level1"><div class="li"> The mirror flag is 0 if the component is not mirrored (around the Y axis).</div>
1104 </li>
1105 <li class="level1"><div class="li"> The mirror flag is 1 if the component is mirrored (around the Y axis).</div>
1106 </li>
1107 <li class="level1"><div class="li"> The just basename is the filename of the component. This filename is not the full path.</div>
1108 </li>
1109 </ul>
1110
1111 <p>
1112  Example:<br/>
1113
1114 </p>
1115 <pre class="code">C 18600 19900 1 0 0 7400-1.sym</pre>
1116
1117 <p>
1118 A component who’s origin is at (18600,19900), is selectable, not rotated, not mirrored, and the basename of the component is 7400-1.sym.
1119 </p>
1120
1121 </div>
1122 <!-- SECTION "component" [20345-21348] -->
1123 <h3><a name="font" id="font">font</a></h3>
1124 <div class="level3">
1125
1126 <p>
1127 Valid in: Special font files ONLY<br/>
1128  <strong><code>type character width flag</code></strong>
1129 </p>
1130 <table class="inline">
1131         <tr>
1132                 <th>Field</th><th>Type/unit</th><th>Description</th>
1133         </tr>
1134         <tr>
1135                 <td>type</td><td>char</td><td>F</td>
1136         </tr>
1137         <tr>
1138                 <td>character</td><td>char</td><td>The character being defined</td>
1139         </tr>
1140         <tr>
1141                 <td>width</td><td>int/mils</td><td>Width of the character (mils)</td>
1142         </tr>
1143         <tr>
1144                 <td>flag</td><td>int</td><td>Special space flag</td>
1145         </tr>
1146 </table>
1147 <ul>
1148 <li class="level1"><div class="li"> This is a special tag and should ONLY show up in font definition files.</div>
1149 </li>
1150 <li class="level1"><div class="li"> If the font character being defined is the space character (32) then flag should be 1, otherwise 0.</div>
1151 </li>
1152 </ul>
1153
1154 <p>
1155  Example:<br/>
1156
1157 </p>
1158 <pre class="code">F 11 1</pre>
1159
1160 <p>
1161 The above font definition is for the space character.
1162 </p>
1163
1164 </div>
1165 <!-- SECTION "font" [21349-21869] -->
1166 <h2><a name="colors" id="colors">Colors</a></h2>
1167 <div class="level2">
1168
1169 <p>
1170 In the gEDA/gaf schematic and symbol file format colors are specified via an integer index. The relationship between integer and color is based on object type. Each object type typically has one or more colors. Here is a table of color index to object type:
1171 </p>
1172 <table class="inline">
1173         <tr>
1174                 <th>Index</th><th>Object type</th>
1175         </tr>
1176         <tr>
1177                 <td>0</td><td>BACKGROUND_COLOR</td>
1178         </tr>
1179         <tr>
1180                 <td>1</td><td><acronym title="Personal Identification Number">PIN</acronym>_COLOR</td>
1181         </tr>
1182         <tr>
1183                 <td>2</td><td>NET_ENDPOINT_COLOR</td>
1184         </tr>
1185         <tr>
1186                 <td>3</td><td>GRAPHIC_COLOR</td>
1187         </tr>
1188         <tr>
1189                 <td>4</td><td>NET_COLOR</td>
1190         </tr>
1191         <tr>
1192                 <td>5</td><td>ATTRIBUTE_COLOR</td>
1193         </tr>
1194         <tr>
1195                 <td>6</td><td>LOGIC_BUBBLE_COLOR</td>
1196         </tr>
1197         <tr>
1198                 <td>7</td><td>GRID_COLOR</td>
1199         </tr>
1200         <tr>
1201                 <td>8</td><td>DETACHED_ATTRIBUTE_COLOR</td>
1202         </tr>
1203         <tr>
1204                 <td>9</td><td>TEXT_COLOR</td>
1205         </tr>
1206         <tr>
1207                 <td>10</td><td>BUS_COLOR</td>
1208         </tr>
1209         <tr>
1210                 <td>11</td><td>SELECT_COLOR</td>
1211         </tr>
1212         <tr>
1213                 <td>12</td><td>BOUNDINGBOX_COLOR</td>
1214         </tr>
1215         <tr>
1216                 <td>13</td><td>ZOOM_BOX_COLOR</td>
1217         </tr>
1218         <tr>
1219                 <td>14</td><td>STROKE_COLOR</td>
1220         </tr>
1221         <tr>
1222                 <td>15</td><td>LOCK_COLOR</td>
1223         </tr>
1224         <tr>
1225                 <td>16</td><td>OUTPUT_BACKGROUND_COLOR</td>
1226         </tr>
1227 </table>
1228
1229 <p>
1230  The actual color associated with the color index is defined on a per tool bases. Objects are typically assigned their corresponding color index, but it is permissible (sometimes) to assign other color index values to different object types.
1231 </p>
1232
1233 </div>
1234 <!-- SECTION "Colors" [21870-22741] -->
1235 <h2><a name="attributes" id="attributes">Attributes</a></h2>
1236 <div class="level2">
1237
1238 <p>
1239 Attributes are enclosed in braces {} and can only be text. Attributes are text items which take on the form name=value. If it doesn’t have name=value, it’s not an attribute. Attributes are attached to the previous object. Here’s an example:
1240 </p>
1241 <pre class="code">P 988 500 1300 500 1
1242 {
1243 T 1000 570 5 8 1 1 0
1244 pinseq=3
1245 T 1000 550 5 8 1 1 0
1246 pinnumber=3
1247 }</pre>
1248
1249 <p>
1250 The object is a pin which has an attribute pinnumber=3 and pinseq=3 (name=value). You can have multiple text objects (both the T &hellip; and text string are required) in between the braces {}. As of 20021103, you can only attached text items as attributes. Attaching other object types as attributes is unsupported.<br/>
1251  You can also have “toplevel” attributes. These attributes are not attached to any object, but instead are just text objects that take on the form name=value.<br/>
1252  These attributes are useful when you need to convey some info about a schematic page or symbol and need the netlister to have access to this info.
1253 </p>
1254
1255 </div>
1256 <!-- SECTION "Attributes" [22742-23729] -->
1257 <h2><a name="embedded_components" id="embedded_components">Embedded Components</a></h2>
1258 <div class="level2">
1259
1260 <p>
1261 Embedded components are components which have all of their definition stored within the schematic file. When a users place a component onto a schematic page, they have the option of making the component embedded. Other than storing all the symbol information inside of the schematic, an embedded component is just any other component. Embedded components are defined as:
1262 </p>
1263 <pre class="code">C 18600 21500 1 0 0 EMBEDDED555-1.sym
1264 [
1265 ...
1266 ... Embedded primitive objects
1267 ...
1268 ]</pre>
1269
1270 <p>
1271 In the example above, <strong>555-1.sym</strong> is the component. The EMBEDDED tag and the [ ] are the distinguishing characteristics of embedded components. <strong>componentname.sym</strong> must exist in one of the specified component-libraries if you want to unembed the component.
1272 </p>
1273
1274 </div>
1275 <!-- SECTION "Embedded Components" [23730-24489] -->
1276 <h2><a name="document_revision_history" id="document_revision_history">Document Revision History</a></h2>
1277 <div class="level2">
1278 <table class="inline">
1279         <tr>
1280                 <td>November 30th, 2002</td><td>Created fleformats.tex from fleformats.html.</td>
1281         </tr>
1282         <tr>
1283                 <td>December 1st, 2002</td><td>Continued work on this document.</td>
1284         </tr>
1285         <tr>
1286                 <td>October 4th, 2003</td><td>Added new file format version flag info.</td>
1287         </tr>
1288         <tr>
1289                 <td>October 19th, 2003</td><td>Added num lines text field.</td>
1290         </tr>
1291 </table>
1292
1293 </div>
1294 <!-- SECTION "Document Revision History" [24490-] --></div>
1295 </body>
1296 </html>