luke
/
ngspice
mirror of https://git.code.sf.net/p/ngspice/ngspice
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cleanup man pages

This commit is contained in:
rlar 2014-10-28 20:42:09 +01:00
parent aa6ef36213
commit 0ebc8c9ba5
4 changed files with 84 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
man/man1/ngmultidec.1
View File

@ -1,4 +1,20 @@
.TH NGMULTIDEC 1 ngpice .\" Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH NGMULTIDEC 1 "2014-10-28"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME .SH NAME
ngmultidec \- make ngpice sub-circuit for coupled transmission lines ngmultidec \- make ngpice sub-circuit for coupled transmission lines
.SH SYNOPSIS .SH SYNOPSIS

50
man/man1/ngnutmeg.1
View File

@ -1,37 +1,38 @@
.\" Hey, EMACS: -*- nroff -*-
.\"
.\" Copyright (c) 1985 Wayne A. Christopher, U. C. Berkeley CAD Group .\" Copyright (c) 1985 Wayne A. Christopher, U. C. Berkeley CAD Group
.ig .\"
.\" First parameter, NAME, should be all caps
(woman-find-file buffer-file-name) .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
(let* ((man-args (concat "-l " buffer-file-name)) .TH NGNUTMEG 1 "2014-10-28"
(bufname (concat "*Man " man-args "*"))) .\" Please adjust this date whenever revising the manpage.
(when (get-buffer bufname) .\"
(kill-buffer bufname)) .\" Some roff macros, for reference:
(man man-args)) .\" .nh disable hyphenation
.\" .hy enable hyphenation
(compile .\" .ad l left justify
(concat "groff -t -e -man -Tps " .\" .ad b justify to both left and right margins
buffer-file-name .\" .nf disable filling
" > /tmp/tmp.ps && gv /tmp/tmp.ps")) .\" .fi enable filling
.\" .br insert line break
.. .\" .sp <n> insert n+1 empty lines
.TH NGNUTMEG 1 "6 June 2010" .\" for manpage-specific macros, see man(7)
.ds = \-\^\- .ds = \-\^\-
.ds ngspice \s-2NGSPICE\s+2
.SH "NAME" .SH "NAME"
ngnutmeg \- ngspice post-processor ngnutmeg \- ngspice post-processor
.SH "SYNOPSIS" .SH "SYNOPSIS"
\fBngnutmeg\fP [\fIoptions\fP] [\fIdatafile\fP ...] \fBngnutmeg\fP [\fIoptions\fP] [\fIdatafile\fP ...]
.SH "DESCRIPTION" .SH "DESCRIPTION"
This man page is just a small overview. This man page is just a small overview.
The primary documentation of ngspice is in the \*[ngspice] User's Manual, The primary documentation of ngspice is in the ngspice User's Manual,
which is available as a pdf file. which is available as a pdf file.
.br .br
\fBngnutmeg\fP is a post processor for \*[ngspice] \- it takes \fBngnutmeg\fP is a post processor for ngspice \- it takes
the raw output file created by \fBngspice \-r\fP the raw output file created by \fBngspice \-r\fP
and plots the data on a graphics terminal or a workstation display. and plots the data on a graphics terminal or a workstation display.
Note that the raw output file is different from the Note that the raw output file is different from the
data that \*[ngspice] writes to the standard output. data that ngspice writes to the standard output.
.SH "OPTIONS" .SH "OPTIONS"
.TP .TP
\fB\-\fP \fB\-\fP
@ -60,7 +61,7 @@ Further arguments are taken to be data files in binary or ascii format
(see \fBsconvert\fP(1)) which are loaded into ngnutmeg. (see \fBsconvert\fP(1)) which are loaded into ngnutmeg.
If the file If the file
is in binary format, it may be only partially completed (useful for is in binary format, it may be only partially completed (useful for
examining \*[ngspice] output before the simulation is finished). examining ngspice output before the simulation is finished).
One file may contain any number of data sets from different analyses. One file may contain any number of data sets from different analyses.
.SH "ENVIRONMENT" .SH "ENVIRONMENT"
See ngspice(1) See ngspice(1)
@ -69,7 +70,7 @@ See ngspice(1)
.SH "SEE ALSO" .SH "SEE ALSO"
sconvert(1), ngspice(1), mfb(3), writedata(3), and sconvert(1), ngspice(1), mfb(3), writedata(3), and
.br .br
\*[ngspice] User's Manual at \fBhttp://ngspice.sourceforge.net/docs.html\fP ngspice User's Manual at \fBhttp://ngspice.sourceforge.net/docs.html\fP
.SH "BUGS" .SH "BUGS"
Please report bugs to the ngspice project via Please report bugs to the ngspice project via
.br .br
@ -78,6 +79,3 @@ Please report bugs to the ngspice project via
Wayne Christopher (faustus@cad.berkeley.edu) Wayne Christopher (faustus@cad.berkeley.edu)
.br .br
\fBngspice\fP: various authors (see \fBhttp://sourceforge.net/projects/ngspice/\fP) \fBngspice\fP: various authors (see \fBhttp://sourceforge.net/projects/ngspice/\fP)
.\" Local Variables:
.\" mode: nroff
.\" End:

20
man/man1/ngsconvert.1
View File

@ -1,5 +1,23 @@
.\" Hey, EMACS: -*- nroff -*-
.\"
.\" Copyright (c) 1985 Wayne A. Christopher, U. C. Berkeley CAD Group .\" Copyright (c) 1985 Wayne A. Christopher, U. C. Berkeley CAD Group
.TH SCONVERT 1 "20 March 1986" .\"
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH SCONVERT 1 "2014-10-28"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.UC 4 .UC 4
.SH NAME .SH NAME
sconvert \- convert spice formats sconvert \- convert spice formats

49
man/man1/ngspice.1
View File

@ -1,34 +1,36 @@
.\" Hey, EMACS: -*- nroff -*-
.\"
.\" Copyright (c) 1985 Wayne A. Christopher, U. C. Berkeley CAD Group .\" Copyright (c) 1985 Wayne A. Christopher, U. C. Berkeley CAD Group
.ig .\"
.\" First parameter, NAME, should be all caps
(woman-find-file buffer-file-name) .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
(let* ((man-args (concat "-l " buffer-file-name)) .TH NGSPICE 1 "2014-10-28"
(bufname (concat "*Man " man-args "*"))) .\" Please adjust this date whenever revising the manpage.
(when (get-buffer bufname) .\"
(kill-buffer bufname)) .\" Some roff macros, for reference:
(man man-args)) .\" .nh disable hyphenation
.\" .hy enable hyphenation
(compile (concat "groff -t -e -man -Tps " .\" .ad l left justify
buffer-file-name .\" .ad b justify to both left and right margins
" > /tmp/tmp.ps && gv /tmp/tmp.ps")) .\" .nf disable filling
.\" .fi enable filling
.. .\" .br insert line break
.TH NGSPICE 1 "6 June 2010" .\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.ds = \-\^\- .ds = \-\^\-
.ds ngspice \s-2NGSPICE\s+2
.SH "NAME" .SH "NAME"
ngspice \- circuit simulator derived from SPICE3f5 ngspice \- circuit simulator derived from SPICE3f5
.SH "SYNOPSIS" .SH "SYNOPSIS"
\fBngspice\fP [\fIoptions\fP] [\fIfile\fP ...] \fBngspice\fP [\fIoptions\fP] [\fIfile\fP ...]
.SH "DESCRIPTION" .SH "DESCRIPTION"
This man page is just a small overview. This man page is just a small overview.
The primary documentation of ngspice is in the \*[ngspice] User's Manual, The primary documentation of ngspice is in the ngspice User's Manual,
which is available as a pdf file. which is available as a pdf file.
.SH "OPTIONS" .SH "OPTIONS"
.TP .TP
\fB\-n\fP or \fB\*=no\-spiceinit\fP \fB\-n\fP or \fB\*=no\-spiceinit\fP
Don't try to source the file ".spiceinit" upon startup. Normally \*[ngspice] Don't try to source the file ".spiceinit" upon startup. Normally ngspice
tries to find the file in the current directory, and if it is not found then tries to find the file in the current directory, and if it is not found then
in the user's home directory. in the user's home directory.
.TP .TP
@ -40,9 +42,9 @@ The program is being run on a terminal with \fBmfb\fP name \fIterm\fP.
.TP .TP
\fB\-b\fP or \fB\*=batch\fP \fB\-b\fP or \fB\*=batch\fP
Run in batch mode. Run in batch mode.
\*[ngspice] will read the standard input or the specified ngspice will read the standard input or the specified
input file and do the simulation. input file and do the simulation.
Note that if the standard input is not a terminal, \*[ngspice] will default Note that if the standard input is not a terminal, ngspice will default
to batch mode, unless the \-i flag is given. to batch mode, unless the \-i flag is given.
.TP .TP
\fB\-s\fP or \fB\*=server\fP \fB\-s\fP or \fB\*=server\fP
@ -136,7 +138,7 @@ The User's Initialisation File.
.SH "SEE ALSO" .SH "SEE ALSO"
sconvert(1), ngnutmeg(1), mfb(3), writedata(3), and sconvert(1), ngnutmeg(1), mfb(3), writedata(3), and
.br .br
\*[ngspice] User's Manual at \fBhttp://ngspice.sourceforge.net/docs.html\fP ngspice User's Manual at \fBhttp://ngspice.sourceforge.net/docs.html\fP
.SH "BUGS" .SH "BUGS"
Please report bugs to the ngspice project via Please report bugs to the ngspice project via
.br .br
@ -147,6 +149,3 @@ Please report bugs to the ngspice project via
\fBnutmeg\fP: User interface: Wayne Christopher (faustus@cad.berkeley.edu) \fBnutmeg\fP: User interface: Wayne Christopher (faustus@cad.berkeley.edu)
.br .br
\fBngspice\fP: various authors (see \fBhttp://sourceforge.net/projects/ngspice/\fP) \fBngspice\fP: various authors (see \fBhttp://sourceforge.net/projects/ngspice/\fP)
.\" Local Variables:
.\" mode: nroff
.\" End: