File: help.tex

package info (click to toggle)
acs 021-2.3
  • links: PTS
  • area: main
  • in suites: slink
  • size: 2,196 kB
  • ctags: 2,629
  • sloc: cpp: 15,013; makefile: 166
file content (51 lines) | stat: -rw-r--r-- 1,862 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
%$Id: help.tex,v 1.2 96/03/30 18:03:21 al Exp $
% man commands help .
%------------------------------------------------------------------------
\section{{\tt HELP} command}
\index{help}
\index{on-line documentation}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt Help} \{{\it subject}\}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Provides on line documentation.
%------------------------------------------------------------------------
\subsection{Comments}

{\tt Help} lists the commands.

{\tt Help Help} lists the other subjects on which help is available.

{\tt Help ERrors} lists the error messages.  The word in the error message
that is partially capitalized is a keyword.  {\tt Help} followed by this
word will tell you more about that message.

Types of subjects available include commands, command options, error
messages, and circuit description.

In order for the Help command to work, the file {\tt acs.hlp} must be
available somewhere in the executables search path.  Usually the best
place for it is the same directory as {\tt acs}.
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}

\item[{\tt help build}] Tells you about the `{\tt Build}' command.

\item[{\tt help mosfet}] Tells you about the MOSFET model usage.

\item[{\tt help errors}] Lists the error messages.  Strange looking
capitalization identifies keywords that will tell you how to get more about
a particular error message.

\item[{\tt help converge}] Gives details about the `{\tt did not converge}'
error message.

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