%$Id: list.tex,v 25.95 2006/08/26 01:26:53 al Exp $ -*- LaTeX -*-
% man commands list .
% Copyright (C) 2001 Albert Davis
% Author: Albert Davis <aldavis@ieee.org>
%
% This file is part of "Gnucap", the Gnu Circuit Analysis Package
%
% This program is free software; you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation; either version 2, or (at your option)
% any later version.
%
% This program is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License
% along with this program; if not, write to the Free Software
% Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
% 02110-1301, USA.
%------------------------------------------------------------------------
\section{{\tt LIST} command}
\index{list command}
\index{view circuit}
\index{connection list}
\index{parts list}
\index{list by branch}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt list} \{{\it label ...}\} \\
{\tt list} \{{\it label} - {\it label}\}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Lists the circuit in memory.
%------------------------------------------------------------------------
\subsection{Comments}

Plain {\tt list} will list the whole circuit on the console.

{\tt List} with a component label asks for that one only.  Wildcards are
supported: {\tt ?} matches any character, once.  {\tt *} matches zero or
more of any character.

For several components, list them.

For a range, specify two labels separated by a dash.
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}

\item[{\tt list}] List the entire circuit to the console.

\item[{\tt list R11}] Show the component {\tt R11}.

\item[{\tt list D12 - C5}] List the part of the netlist from {\tt M12} to
{\tt C5}, inclusive.  {\tt D12} must be before {\tt C5} in the list.

\item[{\tt list D* C*}] List all diodes and capacitors.

\end{description}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
