nutmeg.1

spice中支持多层次元件模型仿真的可单独运行的插件源码

.TP
\fBshift [varname] [number]\fR
If \fIvarname\fR is the name of a list variable, it is shifted to the left
by \fInumber\fR elements. (I.e, the \fInumber\fR leftmost elements are
removed.)  The default \fIvarname\fR is \fBargv\fR, and the default
\fInumber\fR is 1.
.TP
\fBrusage [resource ...]\fR
Print resource usage statistics.  If any \fBresource\fR\&s are given,
just print the usage of that resource.  Currently valid \fBresource\fR\&s
are:
.IP "" 16
\fBelapsed\fR
.br
The amount of time elapsed since the last \fBrusage elaped\fR call.
.IP
\fBfaults\fR
.br
Number of page faults and context switches (BSD only).
.IP
\fBspace\fR
.br
Data space used.
.IP
\fBtime\fR
.br
CPU time used so far.
.IP
\fBeverything\fR
.br
All of the above.
.TP
\fBcd [directory]\fR
Change the current working directory to \fBdirectory\fR, or to the user's
home directory if none is given.
.TP
\fBaspice [output-file]\fR
Start a \s-2SPICE-3\s+2 run, and when it is finished load the data. The
raw data is kept in a temporary file. If \fIoutput-file\fR is specified
then the diagnostic output is directed into that file, otherwise it
is thrown away.
.TP
\fBjobs\fR
Report on the asynchronous \s-2SPICE-3\s+2 jobs currently running.
\fBNutmeg\fR checks to see if the jobs are finished every time you
execute a command.
If it is done then the data is loaded and becomes available.
.TP
\fBrspice [input file]\fR
Runs a \s-2SPICE-3\s+2 remotely taking the \fBinput file\fR as a
\s-2SPICE-3\s+2 input deck, or the current circuit if no argument is
given. \fBNutmeg\fR waits for the job to complete, and passes output
from the remote job to the user's standard output. When the job is
finished the data is loaded in as with \fRaspice\fR. If the variable
\fIrhost\fR is set, \fBnutmeg\fR will connect to this host instead of
the default remote \s-2SPICE-3\s+2 server machine. Note that this
command will only work if your system administrator is running a
\s-2SPICE-3\s+2 daemon on the remote host. If the variable \fIrprogram\fR
is set, then \fBrspice\fR will use this as the pathname to the program
to run.
.TP
\fBecho [stuff...]\fR
Echos the arguments.
.TP
\fBfourier fundamental_frequency [value ...]\fR
Does a fourier analysis of each of the given values, using the first 10
multiples of the fundamental frequency (or the first \fInfreqs\fR, if that
variable is set \- see below). The output is like that of 
the \fB.four\fR \*S card. The values may be any valid expression.
The values are interpolated onto a fixed-space grid with the number of
points given by the \fBfourgridsize\fR variable, or 200 if it is not set.
The interpolation will be of degree \fBpolydegree\fR if that variable is
set, or 1.  If \fBpolydegree\fR is 0, then no interpolation will be done.
This is likely to give erroneous results if the time scale is not monotonic,
though.
.TP
\fBversion [version id]\fR
Print out the version of \fBnutmeg\fR that is running.
If there are arguments, it checks to make sure that the arguments match
the current version of \s-2SPICE\s+2. (This is mainly used as a \fBCommand:\fR
line in rawfiles.)
.TP
\fBrehash\fR
Recalculate the internal hash tables used when looking up UNIX commands,
and make all UNIX commands in the user's PATH available for command
completion.
This is useless unless you have \fBset unixcom\fR first (see above).
.PP
The following control structures are available:
.IP
.nf
\fBwhile\fR \fIcondition\fR
	statement
	...
\fBend\fR
.fi
.PP
While \fIcondition\fR, an arbitrary algebraic expression, is true,
execute the statements.
.IP
.nf
\fBrepeat\fR \fI[number]\fR
	statement
	...
\fBend\fR
.fi
.PP
Execute the statements \fInumber\fR times, or forever if no argument is
given.
.IP
.nf
\fBdowhile\fR \fIcondition\fR
	statement
	...
\fBend\fR
.fi
.PP
The same as \fBwhile\fR, except that the \fIcondition\fR is tested after
the statements are executed.
.IP
.nf
\fBforeach\fR \fIvar\fR \fIvalue ...\fR
	statement
	...
\fBend\fR
.fi
.PP
The statements are executed once for each of the \fIvalue\fRs, each time
with the variable \fIvar\fR set to the current one.  (\fIvar\fR can be accessed
by the $\fIvar\fR notation \- see below).
.IP
.nf
\fBif\fR \fIcondition\fR
	statement
	...
\fBelse\fR
	statement
	...
\fBend\fR
.fi
.PP
If the \fIcondition\fR is non-zero then the first set of statements are
executed, otherwise the second set.  The \fBelse\fR and the second set
of statements may be omitted.
.IP
\fBlabel\fR \fIword\fR
.PP
If a statement of the form \fBgoto\fI word\fR is encountered, control is
transfered to this point, otherwise this is a no-op.
.IP
\fBgoto\fR \fIword\fR
.PP
If a statement of the form \fBlabel\fI word\fR is present in the block
or an enclosing block, control is transfered there.  Note that if the
label is at the top level, it \fImust\fR be before the \fBgoto\fR statement
(i.e, a forward \fBgoto\fR may occur only within a block).
.IP
\fBcontinue\fR
.PP
If there is a \fBwhile, dowhile,\fR or \fBforeach\fR block enclosing this
statement, control passes to the test, or in the case of \fBforeach\fR,
the next value is taken.
Otherwise an
error results.
.IP
\fBbreak\fR
.PP
If there is a \fBwhile, dowhile,\fR or \fBforeach\fR block enclosing this
statement, control passes out of the block. Otherwise an
error results.
.PP
Of course, control structures may be nested.  When a block is entered
and the input is the terminal, the prompt becomes a number of >'s
equalling the number of blocks the user has entered. The current control
structures may be examined with the debugging command
.B cdump.
.PP
If a word is typed as a command, and there is no built-in command
with that name, the directories in the \fIsourcepath\fR list are searched
in order for the file.  If it is found, it is read in as a command file (as
if it were \fBsource\fRd).  Before it is read, however, the variables
\fIargc\fR and \fIargv\fR are set to the number of words following the
filename on the command line, and a list of those words respectively.
After the file is finished, these variables are \fBunset\fR.  Note that
if a command file calls another, it must save its \fIargv\fR and \fIargc\fR
since they will get altered.  Also, command files may not be re-entrant
since there are no local variables.  (Of course, the procedures may
explicitly manipulate a stack...)
This way one can write scripts analogous to shell scripts for \fBnutmeg\fR and
\*S.  Note that for the script to work with \*S, it \fBmust\fR begin
with a blank line (or whatever you like, since it will be thrown away)
and then a line with \fB.control\fR on it.  This is an unfortunate result
of the \fBsource\fR command being used for both circuit input and command
file execution.  Note also that this allows the user to merely type the
name of a circuit file as a command, and it will be automatically run.
.PP
There are various command scripts installed in
\fI/usr/local/lib/spice/scripts\fR (or whatever the path is on your machine),
and the default \fIsourcepath\fR includes this directory, so you can use
these command files (almost) like builtin commands.  
.PP
\fBNutmeg\fR will use either \fBX\fR or \fBMFB\fR, depending on whether
it finds the variable \fBDISPLAY\fR in the environment.  If you are
using \fBX\fR on a workstation, it should already be present, but if you
want to display graphics on a different machine than the one you
are running \fBnutmeg\fR on, \fBDISPLAY\fR should be of the form 
\fImachine\fR:0.
.PP
If \fBX\fR is being used, the cursor may be positioned at any
point on the screen when the window is up and characters typed at the
keyboard will be added to the window at that point.  The window may
then be sent to a printer using the \fBxpr(1)\fR program.
.PP
There are a number of pre-defined constants in \fBnutmeg\fR. They are:
.na
.nf
	pi		pi
	e		The base of natural logarithms
	c		The speed of light
	i		The square root of -1
	kelvin		Absolute 0 in Centigrade
	echarge		The charge on an electron
	boltz		Boltzman's constant
	planck		Planck's constant (h)

.fi
.ad
.PP
These are all in MKS units. If you have another variable with
a name that conflicts with one of these then it takes precedence.
.PP
Nutmeg occasionally checks to see if it
is getting close to running out of space, and warns the user if this
is the case. (This is more likely to be useful with the \s-2SPICE\s+2
front end.)
.PP
C-shell type quoting with "" and '', and backquote substitution may
be used. Within single quotes, no further substitution (like
history substitution) is done, and within double quotes, the words
are kept together but further substitution is done. Any text between
backquotes is replaced by the result of executing the text as a command
to the shell.
.PP
Tenex-style ('set filec' in the 4.3 C-shell)
command, filename, and keyword completion is possible: If EOF
(control-D) is typed after the first character on the line, a list
of the commands or possible arguments is printed. (If it is alone
on the line it will exit \fBnutmeg\fR.) If escape is typed, then
\fBnutmeg\fR will try to complete what the user has already typed.
To get a list of all commands, the user should type <space> ^D.
.PP
The values of variables may be used in commands by writing \fB$varname\fR
where the value of the variable is to appear.  The special variables
\fI$$\fR and \fI$<\fR refer to the process ID of the program and a
line of input which is read from the terminal when the variable
is evaluated, respectively.  If a variable has a name of the form
\fB$&word\fR, then \fBword\fR is considered a vector (see above),
and its value is taken to be the value of the variable.
If \fI$foo\fR is a valid variable, and is of type \fBlist\fR, then the
expression \fI$foo[low-high]\fR represents a range of elements.  Either
the upper index or the lower may be left out, and the reverse of a list may
be obtained with \fI$foo[len-0]\fR.  Also, the notation \fI$?foo\fR evaluates
to 1 if the variable \fIfoo\fR is defined, 0 otherwise, and \fI$#foo\fR
evaluates to the number of elements in \fIfoo\fR if it is a list, 1 if it
is a number or string, and 0 if it is a boolean variable.
.PP
History substitutions, similar to C-shell history substitutions, are
also available \- see the C-shell manual page for all of the details.
.PP
The characters ~, {, and } have the same effects as they do in the
C-Shell, i.e., home directory and alternative expansion. It is
possible to use the wildcard characters *, ?, [, and ] also,
but only if you \fBunset noglob\fR first. This makes them rather
useless for typing algebraic expressions, so you should \fBset noglob\fR
again after you are done with wildcard expansion. Note that the
pattern \fB[^abc]\fR will match all characters \fIexcept\fB a, b, 
\fRand\fB c.\fR
.PP
IO redirection is available \- the symbols \fB>, >>, >&, >>&, \fRand\fB <\fR
have the same effects as in the C-shell.
.PP
You may type multiple commands on one line, seperated by semicolons.
.PP
If you want to use a different \fBmfbcap\fR file than the default (usually
\fB~cad/lib/mfbcap\fR), you have to set the environment variable \fBMFBCAP\fR
before you start \fBnutmeg\fR.  The \fB-m\fR option and the \fBmfbcap\fR
variable no longer work.
.SH "VMS NOTES"
\fBNutmeg\fR can be run under VAX/VMS. Some features like command, etc
completion, expansion of *, ?, and [], backquote substitution, the
shell command, and so forth do not work. (In fact command completion
only works on 4.2 or 4.3 BSD.) 
.PP
\fBNutmeg\fR will look for start-up
commands in the file \fIspice.rc\fR in the current directory.
.PP
The standard suffix for rawspice files in VMS is ".raw".
.PP
You will have to respond to the \fI-more-\fR prompt during plot with a
carriage return instead of any key as you can do on UNIX.
.SH "SEE ALSO"
sconvert(1), spice(1), mfb(3), writedata(3)
.SH AUTHOR
Wayne Christopher ([e-mail])
.SH BUGS
.PP
The label entry facilities are very primitive \- after all, \fBnutmeg\fR isn't
a graphics editor (yet).  You must be careful to type very slowly when
entering labels -- \fBnutmeg\fR checks the \fBX\fR event queue once
every second, and can get very confused if characters arrive faster than
that.
.PP
If you redefine colors after creating a plot window with X, and then
cause the window to be redrawn, it will not to the right thing.
.PP
When defining aliases like
.IP
\fIalias pdb plot db( '!:1' - '!:2' )\fR
.PP
you must be careful to quote the argument list substitutions in this
manner. If you quote the whole argument it might not work properly.
.PP
In a user-defined function, the arguments cannot be part of a name that
uses the \fIplot.vec\fR syntax.  I.e,
.IP
\fIdefine poke(duck) cos(tran1.duck)
.PP
won't do the right thing.
.PP
If you type \fBplot all all\fR, or otherwise use a wildcard reference for
one plot twice in a command, bad things will happen.
.PP
The \fBasciiplot\fR command doesn't deal with log scales or the \fBdelta\fR
keywords.
.PP
There are probably some features that \fBnutmeg\fR doesn't have yet.
.SH CAVEATS
Often the names of terminals recognised by \fBMFB\fR are different
from those in /etc/termcap. Thus you may have to reset your terminal
type with the command
.IP
\fBset term = termname\fR
.PP
where \fBtermname\fR is the name in the \fBmfbcap\fR file.
.PP
The \fBhardcopy\fR command is useless on VMS and other systems without
the \fBplot\fR command, unless the user has a program that understands
\fIplot(5)\fR format.