| << [[geda:gnetlist_ug:introduction|Introduction]]  |  **[[geda:gnetlist_ug|gEDA gnetlist User Guide]]**     |  [[geda:gnetlist_ug:input_output_files|Input & output files]] >> |

===== Running gnetlist =====

<note tip>Are you looking for help with [[geda:installation|installing gEDA]]?</note>

gnetlist has a command-line interface, and can be run using the ''gnetlist'' command in a terminal window.  For example, a normal command to run gnetlist on a design in order to generate a list of components used might look like this:

<code>
gnetlist -g bom2 -o stepper.bom power-supply.sch motor-drive.sch
</code>

To run gnetlist, you will usually need to [[input_output_files|specify a list of schematic files]] to process; choose a //[[netlist_backends|netlist backend]]// to use to generate the output; and provide the name of the [[input_output_files|output file]] in which to save the netlist.

gnetlist accepts a variety of [[geda:gnetlist_ug:command_line|optional arguments]] that can be used to alter its behaviour.  They are also explained in the gnetlist manpage (which you can view by running ''man gnetlist'').