docs/wiki/geda-gnetlist_ug-input_output_files.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 <a href=.>start</a>&nbsp;=>&nbsp;<a href=geda-gnetlist_ug.html>gnetlist_ug</a></br>
  13 <div class="table sectionedit1"><table class="inline">
  14         <tr class="row0">
  15                 <td class="col0 leftalign"> « <a href="geda-gnetlist_ug-running_gnetlist.html" class="wikilink1" title="geda-gnetlist_ug-running_gnetlist.html">Running gnetlist</a>  </td><td class="col1 centeralign">  <strong><a href="geda-gnetlist_ug.html" class="wikilink1" title="geda-gnetlist_ug.html">gEDA gnetlist User Guide</a></strong>     </td><td class="col2 rightalign">  <a href="geda-gnetlist_ug-netlist_backends.html" class="wikilink1" title="geda-gnetlist_ug-netlist_backends.html">Netlist backends</a> » </td>
  16         </tr>
  17 </table></div>
  18 <!-- EDIT1 TABLE [1-181] -->
  19
  20
  21 <h2 class="sectionedit2" id="input_and_output_files">Input and output files</h2>
  22 <div class="level2">
  23
  24 <p>
  25 gnetlist takes one or more <em>schematic files</em> as input, and outputs the result of processing them to generate a <em>netlist</em>.
  26 </p>
  27 <div class="notetip">Schematic files can be viewed and edited using the gEDA <em>schematic capture</em> application. For more information, see the  <a href="geda-gschem_ug.html" class="wikilink1" title="geda-gschem_ug.html">gEDA gschem User Guide</a>.
  28 </div>
  29 </div>
  30 <!-- EDIT2 SECTION "Input and output files" [194-539] -->
  31 <h3 class="sectionedit3" id="schematic_files">Schematic files</h3>
  32 <div class="level3">
  33
  34 <p>
  35 Schematic files contain <em>components</em>, which may represent subcircuits to be included in the design, or or discrete parts or devices to be used.  Components have <em>pins</em> associated with them, which represent either a physical pin on an electronic component, or a logical connection to a subcircuit schematic.  Components are connected up by joining their pins with <em>nets</em> or <em>buses</em>.  All of these elements can have <em>attributes</em> associated with them, which control how they are interpreted by gnetlist.
  36 </p>
  37
  38 <p>
  39 You can list any number of schematic files as input.  They will be merged together to form a single netlist.  This allows you to split your circuit into several schematic diagrams, which can be useful if you have a very large and complicated design.  List the schematic files on the command line, e.g.:
  40 </p>
  41 <pre class="code">gnetlist power-supply.sch motor-drive.sch</pre>
  42
  43 <p>
  44 If you have a schematic which has a filename beginning with a hyphen (“-”), you should add the special option <code>--</code> after any options and before your list of input files.  This will make sure that none of your filenames get misinterpreted as options. For example:
  45 </p>
  46 <pre class="code">gnetlist -- -tricky-name.sch</pre>
  47
  48 </div>
  49 <!-- EDIT3 SECTION "Schematic files" [540-1755] -->
  50 <h3 class="sectionedit4" id="output_filename">Output filename</h3>
  51 <div class="level3">
  52
  53 <p>
  54 By default, gnetlist writes the netlist it generates to a file called “output.net”.  You can use the <code>-o</code> option to specify a different filename. For example, to output to a file called “stepper.bom”:
  55 </p>
  56 <pre class="code">gnetlist -o stepper.bom</pre>
  57
  58 </div>
  59 <!-- EDIT4 SECTION "Output filename" [1756-] --></body>
  60 </html>