[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
gEDA-cvs: branch: master updated (1.3.0-20071229-55-gc1e3075)
The branch, master has been updated
via c1e3075cb263a6098d2351440b680247456ae0d0 (commit)
from e8b3be0fbcbf7518b05b437e13eeaa11478345aa (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
=========
Summary
=========
gnetlist/docs/gnetlist.1 | 146 ++++++++++++++++++++++++-------------------
gschem/docs/gschem.1 | 21 ++++--
gsymcheck/docs/gsymcheck.1 | 61 +++++++++++++++++--
3 files changed, 150 insertions(+), 78 deletions(-)
=================
Commit Messages
=================
commit c1e3075cb263a6098d2351440b680247456ae0d0
Author: Ales Hvezda <ahvezda@xxxxxxxx>
Date: Thu Jan 10 00:27:16 2008 -0500
Updated and correct the gEDA/gaf man pages a little bit.
This is the fix for SF Bug: [ 1556064 ] man page version out of date
:100644 100644 32d7e70... 91bfde6... M gnetlist/docs/gnetlist.1
:100644 100644 d7f8406... 9991e12... M gschem/docs/gschem.1
:100644 100644 4b3a67b... a4338ae... M gsymcheck/docs/gsymcheck.1
=========
Changes
=========
commit c1e3075cb263a6098d2351440b680247456ae0d0
Author: Ales Hvezda <ahvezda@xxxxxxxx>
Date: Thu Jan 10 00:27:16 2008 -0500
Updated and correct the gEDA/gaf man pages a little bit.
This is the fix for SF Bug: [ 1556064 ] man page version out of date
diff --git a/gnetlist/docs/gnetlist.1 b/gnetlist/docs/gnetlist.1
index 32d7e70..91bfde6 100644
--- a/gnetlist/docs/gnetlist.1
+++ b/gnetlist/docs/gnetlist.1
@@ -1,9 +1,9 @@
-.TH gnetlist 1 "February 16th, 2007" Version 20070210
+.TH gnetlist 1 "January 10th, 2008" Version 1.3.1.20080110
.SH NAME
gnetlist - gEDA/gaf Netlist extraction/generation
.SH SYNOPSIS
.B gnetlist
-[-e] [-i] [-I] [-q] [-s] [-v] [-l schem_file] [-m schem_file ] [ -O option ] [-h | --help] [-g guile_procedure] [-c scheme_string ] [-o output_filename] schematic1 [... schematicN]
+[-e] [-i] [-I] [-q] [-s] [-v] [-l schem_file] [-m schem_file ] [-n] [ -O option ] [-h | --help] [-g guile_procedure] [-c scheme_string ] [-o output_filename] schematic1 [... schematicN]
.SH DESCRIPTION
.PP
\fIgnetlist\fP is the netlist extraction/generation program which is part gEDA
@@ -18,67 +18,73 @@ guile script extracts the connections into some netlist format.
gnetlist is very much so a work in progress. Currently it supports the
following backends:
- 1) Allegro netlist format (-g allegro)
-
- 2) BAE netlist format (-g bae)
-
- 3) BOM / BOM2 - Bill of Materials (-g bom and -g bom2)
-
- 4) Partslist 1,2,3 - More Bill of Materials (-g partslist[1-3])
-
- 5) DRC - Start of a design rule checker (-g drc)
-
- 6) DRC2 - A second design rule checker (-g drc2)
-
- 7) gEDA - native format, mainly used for testing (-g geda)
-
- 8) Gossip netlist format (-g gossip)
-
- 9) PADS netlist format (-g pads)
-
- 10) PCB / PCBboard (-g PCB and -g PCBboard)
-
- 11) gsch2pcb backend (-g gsch2pcb)
-
- 12) ProtelII netlist format (-g protelII)
-
- 13) Spice compatible netlist format (-g spice)
-
- 14) Enhanced spice compatible netlist format (-g spice-sdb)
-
- 15) Switcap netlist format (-g switcap)
-
- 16) Tango netlist format (-g tango)
-
- 17) Verilog code (-g verilog)
-
- 18) VHDL code (-g vhdl)
-
- 19) VIPEC netlist format (-g vipec)
-
- 20) Bartels Autoengineer netlist format (-g bae)
-
- 21) GOSSIP system simulation system netlist format (-g gossip)
-
- 22) MAXASCII netlist format (-g maxascii)
-
- 23) VHDL-AMS netlist format (-g vams)
-
- 24) Futurenet2 netlist format (-g futurenet2 )
-
- 25) SWITCAP switched capacitor simulator netlist format (-g switcap )
-
- 26) RF Cascade netlist format (-g cascade )
-
- 27) RACAL-REDAC netlist format (-g redac )
-
- 28) PCB actions file for forward annotating pin/pad names from
- schematic to layout (-g pcbpins)
-
+.IP \[bu] 2
+Allegro netlist format (-g allegro)
+.IP \[bu]
+BOM / BOM2 - Bill of Materials (-g bom and -g bom2)
+.IP \[bu]
+Partslist 1,2,3 - More Bill of Materials (-g partslist[1-3])
+.IP \[bu]
+DRC - Start of a design rule checker (-g drc)
+.IP \[bu]
+DRC2 - A second design rule checker (-g drc2)
+.IP \[bu]
+gEDA - native format, mainly used for testing (-g geda)
+.IP \[bu]
+Gossip netlist format (-g gossip)
+.IP \[bu]
+PADS netlist format (-g pads)
+.IP \[bu]
+PCB / PCBboard (-g PCB and -g PCBboard)
+.IP \[bu]
+PCB actions file for forward annotating pin/pad names from
+schematic to layout (-g pcbpins)
+.IP \[bu]
+gsch2pcb backend (-g gsch2pcb)
+.IP \[bu]
+ProtelII netlist format (-g protelII)
+.IP \[bu]
+Spice compatible netlist format (-g spice)
+.IP \[bu]
+Enhanced spice compatible netlist format (-g spice-sdb)
+.IP \[bu]
+Tango netlist format (-g tango)
+.IP \[bu]
+Verilog code (-g verilog)
+.IP \[bu]
+VHDL code (-g vhdl)
+.IP \[bu]
+VIPEC netlist format (-g vipec)
+.IP \[bu]
+Bartels Autoengineer netlist format (-g bae)
+.IP \[bu]
+GOSSIP system simulation system netlist format (-g gossip)
+.IP \[bu]
+MAXASCII netlist format (-g maxascii)
+.IP \[bu]
+VHDL-AMS netlist format (-g vams)
+.IP \[bu]
+Futurenet2 netlist format (-g futurenet2 )
+.IP \[bu]
+SWITCAP switched capacitor simulator netlist format (-g switcap )
+.IP \[bu]
+RF Cascade netlist format (-g cascade )
+.IP \[bu]
+RACAL-REDAC netlist format (-g redac )
+.IP \[bu]
+SystemC netlist backend (-g systemc)
+.IP \[bu]
+Calay format netlist backend (-g calay)
+.IP \[bu]
+Osmond format netlist backend (-g osmond)
+.IP \[bu]
+Eagle netlist format (-g eagle)
+.IP \[bu]
+Netlister for symbolic circuit analysis using Mathematica (-g mathematica)
For more info on these formats please look at the README.*
-Please read the official (non-existant) documentation on how to use
+Please read the official documentation on how to use
gnetlist, since this man page just describes the command line arguments
and a few examples on how to run gnetlist.
@@ -104,7 +110,7 @@ execute before any backend is loaded or any guile procedure (using -g flag)
is executed. This flag can be specified multiple times and can be used to
pass information to backends.
.TP 8
-.B -e
+.B -e, --embed
Force embedding contents of .include file when using the spice-sdb backend.
.TP 8
.B -O string
@@ -117,6 +123,9 @@ execute after the backend is loaded but still before any guile procedure
and can be used to pass information to backends. This flag, for example,
allows the user to override variables inside of the backends (such as paths).
.TP 8
+.B -n --nomunge
+Do not autocorrect the refdes attributes. Only applies to the spice-sdb backend.
+.TP 8
.B -c string
Pass the specified string to the guile interpreter. This allows you to
execute arbitrary guile scripts from the command line. Be sure to surround
@@ -124,10 +133,10 @@ the string with either single or double quotes to satisfy your shell. The
string is execute before any init or netlist backend scheme code is
loaded or executed.
.TP 8
-.B -I
+.B -I --include
Put .INCLUDE <filename> in output file instead of model file's contents.
.TP 8
-.B -h
+.B -h --help
Print out short command line help.
.TP 8
.B -i
@@ -190,7 +199,14 @@ with the -v flag:
.ad b
.SH "ENVIRONMENT"
-No environment variables are used.
+\fIgnetlist\fP respects the following environment variable:
+.PP
+.TP 8
+.B GEDADATA
+specifies where the various required scheme and rc files are located
+(the default is ${prefix}/share/gEDA). This environment variables does
+not need to be set by the end user unless they are moving the executables
+to a new install ${prefix}.
.SH "AUTHOR"
Ales Hvezda and many others
@@ -199,7 +215,7 @@ Ales Hvezda and many others
.BR gschem (1),
.BR gsymcheck (1)
.SH COPYRIGHT
-Copyright \(co 1999-2007 Ales Hvezda
+Copyright \(co 1999-2008 Ales Hvezda
This document can be freely redistributed according to the terms of the
GNU General Public License version 2.0
diff --git a/gschem/docs/gschem.1 b/gschem/docs/gschem.1
index d7f8406..9991e12 100644
--- a/gschem/docs/gschem.1
+++ b/gschem/docs/gschem.1
@@ -1,4 +1,4 @@
-.TH gschem 1 "February 16th, 2007" Version 20070210
+.TH gschem 1 "January 10th, 2008" Version 1.3.1.20080110
.SH NAME
gschem - gEDA/gaf Schematic Capture
.SH SYNOPSIS
@@ -13,7 +13,7 @@ are either part of a standard library or created by the user) which
represent the various gates and components. These components are then
interconnected by nets (wires). Schematics may be printed to a
PostScript file for printing or further conversion to other output
-formats.
+formats. Output to various image formats is also supported.
\fIgschem\fP is also the symbol creation editor. All the standard
methods of creating schematics are used in the creation of symbols. There
@@ -74,19 +74,26 @@ the current directory
To run \fIgschem\fP and then interact with the program:
- ./gschem
+ gschem
.br
To run \fIgschem\fP in interactive mode but load a sample schematic:
- ./gschem adders_1.sch
+ gschem adders_1.sch
To run \fIgschem\fP and load up all schematics in the current subdirectory:
- ./gschem *.sch
+ gschem *.sch
.SH "ENVIRONMENT"
-No environment variables are used.
+\fIgschem\fP respects the following environment variable:
+.PP
+.TP 8
+.B GEDADATA
+specifies where the various required scheme and rc files are located
+(the default is ${prefix}/share/gEDA). This environment variables does
+not need to be set by the end user unless they are moving the executables
+to a new install ${prefix}.
.SH "AUTHOR"
Ales Hvezda and many others
@@ -96,7 +103,7 @@ Ales Hvezda and many others
.BR gsymcheck (1)
.SH COPYRIGHT
.nf
-Copyright \(co 1999-2007 Ales Hvezda
+Copyright \(co 1999-2008 Ales Hvezda
This document can be freely redistributed according to the terms of the
GNU General Public License version 2.0
diff --git a/gsymcheck/docs/gsymcheck.1 b/gsymcheck/docs/gsymcheck.1
index 4b3a67b..a4338ae 100644
--- a/gsymcheck/docs/gsymcheck.1
+++ b/gsymcheck/docs/gsymcheck.1
@@ -1,4 +1,4 @@
-.TH gsymcheck 1 "February 16th, 2007" Version 20070210
+.TH gsymcheck 1 "January 10th, 2008" Version 1.3.1.20080110
.SH NAME
gsymcheck - gEDA/gaf Symbol Checker
.SH SYNOPSIS
@@ -6,8 +6,30 @@ gsymcheck - gEDA/gaf Symbol Checker
[-h] [-v] [-q] symbol1 [... symbolN]
.SH DESCRIPTION
.PP
-\fIgsymcheck\fP is a symbol checker for gEDA. Eventually there will be a
-list of checks performed on the symbols listed here.
+\fIgsymcheck\fP is a symbol checker for gEDA/gaf. Here is a list of checks that
+\fIgsymcheck\fP performs:
+
+.IP \[bu] 2
+Checks for graphical= attribute (if present does varied tests)
+.IP \[bu]
+Checks for the device= attribute
+.IP \[bu]
+Checks for various other missing attributes (pinlabel, pintype,
+pinseq, footprint, refdes)
+.IP \[bu]
+Checks to make sure that the active pin end is on the 100 unit
+grid.
+.IP \[bu]
+Checks the uses of the various attributes (duplicates, incorrect
+syntax, invalid values, etc...)
+.IP \[bu]
+Checks for obsolete, old, and forbidden attributes
+.IP \[bu]
+Checks for any nets or buses within a symbol
+.IP \[bu]
+Checks for any other connections within a symbol
+.IP \[bu]
+Checks to make sure the number of pins is the correct number
.SH OPTIONS
.l
@@ -34,10 +56,37 @@ specified then they are sequentially read in and checked. It is important
that the schematic(s) follow all the options (ie last).
.SH EXAMPLES
-Examples to be listed here eventually
+Here are some examples on how to run \fIgsymcheck\fP:
+
+To get usage information just run:
+
+ gsymcheck
+
+To actually check a symbol with just error counts, run:
+
+ gsymcheck symbolfilename.sym
+
+To get the actuall error messages, run:
+
+ gsymcheck -v symbolfilename.sym
+
+To see all the error messages and warnings, run:
+
+ gsymcheck -vv symbolfilename.sym
+
+To see all the error messages, warnings, and parse info, run:
+
+ gsymcheck -vvv symbolfilename.sym
.SH "ENVIRONMENT"
-No environment variables are used.
+\fIgsymcheck\fP respects the following environment variable:
+.PP
+.TP 8
+.B GEDADATA
+specifies where the various required scheme and rc files are located
+(the default is ${prefix}/share/gEDA). This environment variables does
+not need to be set by the end user unless they are moving the executables
+to a new install ${prefix}.
.SH "AUTHOR"
Ales Hvezda and many others
@@ -46,7 +95,7 @@ Ales Hvezda and many others
.BR gschem (1),
.BR gnetlist (1)
.SH COPYRIGHT
-Copyright \(co 1999-2007 Ales Hvezda
+Copyright \(co 1999-2008 Ales Hvezda
This document can be freely redistributed according to the terms of the
GNU General Public License version 2.0
_______________________________________________
geda-cvs mailing list
geda-cvs@xxxxxxxxxxxxxx
http://www.seul.org/cgi-bin/mailman/listinfo/geda-cvs