man page fixes.
- Start new sentences on a new line, so that troff gets inter-sentence spacing correct. - Remove unterminated quotation mark. - Replace no-longer-defined "spice" macro with a literal string. - Remove trailing whitespace. - Close literal contexts instead of letting them propagate throughout an entire section.
This commit is contained in:
Anthony J. Bentley
rlar
parent
cccc02e844
commit
de8b63ae8f
|
|
@ -40,8 +40,9 @@ following assumptions are made: 1. The self-inductance l, the
|
|||
self-capacitance ctot (note: not c), the series resistance r and the
|
||||
parallel capacitance g are the same for all lines, and 2. Each line
|
||||
is coupled only to the two lines adjacent to it, with the same
|
||||
coupling parameters cm and lm. The first assumption implies that edge
|
||||
effects have to be neglected. The utility of these assumptions is
|
||||
coupling parameters cm and lm.
|
||||
The first assumption implies that edge effects have to be neglected.
|
||||
The utility of these assumptions is
|
||||
that they make the sL+R and sC+G matrices symmetric, tridiagonal and
|
||||
Toeplitz, with useful consequences (see the paper referenced below).
|
||||
.LP
|
||||
|
|
@ -85,7 +86,7 @@ Set the number of conductors.
|
|||
Write a usage message to standard error.
|
||||
.SH EXAMPLE
|
||||
.RS
|
||||
.B "ngmultidec -n4 -l9e9 -c20e-12 -r5.3 -x5e12 -k0.7 -otest -L5.4 > test.cir
|
||||
.B ngmultidec -n4 -l9e9 -c20e-12 -r5.3 -x5e12 -k0.7 -otest -L5.4 > test.cir
|
||||
.RE
|
||||
.SH SEE ALSO
|
||||
.nf
|
||||
|
|
|
|||
|
|
@ -57,10 +57,11 @@ Display a verbose help on the arguments available to the program.
|
|||
Display a version number and copyright information of the program.
|
||||
.PP
|
||||
Further arguments are taken to be data files in binary or ascii format
|
||||
(see \fBsconvert\fP(1)) which are loaded into ngnutmeg. If the file
|
||||
(see \fBsconvert\fP(1)) which are loaded into ngnutmeg.
|
||||
If the file
|
||||
is in binary format, it may be only partially completed (useful for
|
||||
examining \*[ngspice] output before the simulation is finished). One
|
||||
file may contain any number of data sets from different analyses.
|
||||
examining \*[ngspice] output before the simulation is finished).
|
||||
One file may contain any number of data sets from different analyses.
|
||||
.SH "ENVIRONMENT"
|
||||
See ngspice(1)
|
||||
.SH "FILES"
|
||||
|
|
|
|||
|
|
@ -24,14 +24,14 @@ and `a' for the new ascii format.
|
|||
specifies the format to be read, and
|
||||
.B totype
|
||||
specifies the format to be written.
|
||||
If
|
||||
If
|
||||
.B fromfile
|
||||
and
|
||||
and
|
||||
.B tofile
|
||||
are given, then they are used as the input and output, otherwise
|
||||
standard input and output are used. (Note that this second option is
|
||||
only available on \s-2UNIX\s+2 systems \- on VMS and other systems you must
|
||||
supply the filenames.)
|
||||
standard input and output are used.
|
||||
(Note that this second option is only available on \s-2UNIX\s+2 systems
|
||||
\- on VMS and other systems you must supply the filenames.)
|
||||
If no arguments are given, the parameters are prompted for.
|
||||
.PP
|
||||
Binary format is the preferred format for general use, as it is
|
||||
|
|
@ -39,7 +39,8 @@ the most economical in terms of space and speed of access, and ascii is
|
|||
provided to make it easy to modify data files and transfer them
|
||||
between machines with different floating-point formats.
|
||||
The old format is provided only
|
||||
for backward compatibility. The three formats are as follows:
|
||||
for backward compatibility.
|
||||
The three formats are as follows:
|
||||
.br
|
||||
.nf
|
||||
|
||||
|
|
@ -65,7 +66,7 @@ for backward compatibility. The three formats are as follows:
|
|||
Date: \fIDate\fR
|
||||
[ Plotname: \fIPlot Name\fR
|
||||
Flags: \fIcomplex\fR or \fIreal\fR
|
||||
No. Variables: \fInumoutputs\fR
|
||||
No. Variables: \fInumoutputs\fR
|
||||
No. Points: \fInumpoints\fR
|
||||
Command: \fInutmeg command\fR
|
||||
Variables: 0 \fIvarname1\fR \fItypename1\fR
|
||||
|
|
@ -76,13 +77,14 @@ for backward compatibility. The three formats are as follows:
|
|||
1 n n n n ...
|
||||
And so forth...
|
||||
] repeated one or more times
|
||||
|
||||
.fi
|
||||
.PP
|
||||
If one of the flags is \fIcomplex\fR, the points look like r,i where r and i
|
||||
are floating point (in %e format). Otherwise they are in %e format.
|
||||
are floating point (in %e format).
|
||||
Otherwise they are in %e format.
|
||||
Only one of \fIreal\fR and \fIcomplex\fR should appear.
|
||||
.PP
|
||||
The lines are guaranteed to be less than 80 columns wide (unless the
|
||||
The lines are guaranteed to be less than 80 columns wide (unless the
|
||||
plot title or variable names are very long), so this format is safe
|
||||
to mail between systems like CMS.
|
||||
.PP
|
||||
|
|
@ -95,7 +97,7 @@ and the \fBVariables:\fR lines, and whenever the plot is loaded into
|
|||
|
||||
\fITitle Card\fR (a NULL terminated string)
|
||||
\fIDate, Time\fR (a NULL terminated string)
|
||||
[
|
||||
[
|
||||
\fIPlot title\fR (a NULL terminated string)
|
||||
\fINumber of variables\fR (an int)
|
||||
\fINumber of data points\fR (an int)
|
||||
|
|
@ -103,9 +105,9 @@ and the \fBVariables:\fR lines, and whenever the plot is loaded into
|
|||
\fIvariable header struct\fR (repeated numoutputs times)
|
||||
\fIvariable name\fR (a NULL terminated string)
|
||||
\fIvariable type\fR (an int)
|
||||
\fIset of outputs\fR (repeated numpoints times)
|
||||
\fIset of outputs\fR (repeated numpoints times)
|
||||
] repeated one or more times.
|
||||
|
||||
.fi
|
||||
.PP
|
||||
A set of outputs is a vector of doubles of length numoutputs, or
|
||||
a vector of real-imaginary pairs of doubles if the data is complex.
|
||||
|
|
@ -114,12 +116,11 @@ nutmeg(1), spice(1), writedata(3)
|
|||
.SH AUTHOR
|
||||
Wayne Christopher (faustus@cad.berkeley.edu)
|
||||
.SH BUGS
|
||||
If variable names and the title
|
||||
If variable names and the title
|
||||
and plotname strings have trailing
|
||||
blanks in them they will be stripped off when the file is read, if
|
||||
it is in ascii format.
|
||||
.PP
|
||||
If a plot title begins with "Title:" \fBnutmeg\fR will be fooled into thinking
|
||||
that this is an ascii format file. \fBSconvert\fR always requires the
|
||||
type to be specified, however.
|
||||
|
||||
that this is an ascii format file.
|
||||
\fBSconvert\fR always requires the type to be specified, however.
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@
|
|||
.ds = \-\^\-
|
||||
.ds ngspice \s-2NGSPICE\s+2
|
||||
.SH "NAME"
|
||||
ngspice \- circuit simulator derived from \*[spice]\&3f5
|
||||
ngspice \- circuit simulator derived from SPICE3f5
|
||||
.SH "SYNOPSIS"
|
||||
\fBngspice\fP [\fIoptions\fP] [\fIfile\fP ...]
|
||||
.SH "DESCRIPTION"
|
||||
|
|
@ -39,21 +39,25 @@ Enable command completion. (defect)
|
|||
The program is being run on a terminal with \fBmfb\fP name \fIterm\fP.
|
||||
.TP
|
||||
\fB\-b\fP or \fB\*=batch\fP
|
||||
Run in batch mode. \*[ngspice] will read the standard input or the specified
|
||||
input file and do the simulation. Note that if the standard input
|
||||
is not a terminal, \*[ngspice] will default to batch mode, unless the
|
||||
\-i flag is given.
|
||||
Run in batch mode.
|
||||
\*[ngspice] will read the standard input or the specified
|
||||
input file and do the simulation.
|
||||
Note that if the standard input is not a terminal, \*[ngspice] will default
|
||||
to batch mode, unless the \-i flag is given.
|
||||
.TP
|
||||
\fB\-s\fP or \fB\*=server\fP
|
||||
Run in server mode. This is like batch mode, except that a temporary
|
||||
rawfile is used and then written to the standard output, preceded by
|
||||
a line with a single "@", after the simulation is done. This mode
|
||||
is used by the ngspice daemon.
|
||||
Run in server mode.
|
||||
This is like batch mode, except that a temporary rawfile is used and then
|
||||
written to the standard output, preceded by a line with a single "@", after
|
||||
the simulation is done.
|
||||
This mode is used by the ngspice daemon.
|
||||
.TP
|
||||
\fB\-i\fP or \fB\*=interactive\fP
|
||||
Run in interactive mode. This is useful if the standard input is
|
||||
not a terminal but interactive mode is desired. Command completion is
|
||||
not available unless the standard input is a terminal, however.
|
||||
Run in interactive mode.
|
||||
This is useful if the standard input is not a terminal but interactive mode
|
||||
is desired.
|
||||
Command completion is not available unless the standard input is a terminal,
|
||||
however.
|
||||
.TP
|
||||
\fB\-r\fP \fIrawfile\fP or \fB\*=rawfile=\fP\fIfile\fP
|
||||
Use \fIrawfile\fP as the default file into which the results of
|
||||
|
|
@ -76,11 +80,13 @@ All logs generated during a batch run (\fB\-b\fP) will be saved in \fIoutfile\fP
|
|||
.TP
|
||||
\fB\-p\fP or \fB\*=pipe\fP
|
||||
Allow a program (e.g., xcircuit) to act as a GUI frontend for
|
||||
ngspice through a pipe. Thus ngspice will assume that the pipe
|
||||
is a tty and allows one to run in interactive mode.
|
||||
ngspice through a pipe.
|
||||
Thus ngspice will assume that the pipe is a tty and allows one to run in
|
||||
interactive mode.
|
||||
.PP
|
||||
Further arguments are taken to be \*[spice] input decks, which are read
|
||||
and saved. (If batch mode is requested then they are run immediately.)
|
||||
Further arguments are taken to be SPICE input decks, which are read
|
||||
and saved.
|
||||
(If batch mode is requested then they are run immediately.)
|
||||
.SH "ENVIRONMENT"
|
||||
.TP
|
||||
\fBSPICE_LIB_DIR\fP
|
||||
|
|
@ -94,7 +100,8 @@ and saved. (If batch mode is requested then they are run immediately.)
|
|||
\fBSPICE_EDITOR\fP
|
||||
.TP
|
||||
\fBSPICE_ASCIIRAWFILE\fP default \fI0\fP
|
||||
Format of the rawfile. \fI0\fP for binary, and \fI1\fP for ascii.
|
||||
Format of the rawfile.
|
||||
\fI0\fP for binary, and \fI1\fP for ascii.
|
||||
.TP
|
||||
\fBSPICE_NEWS\fP default \fI$SPICE_LIB_DIR/news\fP
|
||||
A file which is copied verbatim to stdout when ngspice starts in interactive mode.
|
||||
|
|
|
|||
Loading…
Reference in New Issue