1gsymcheck(1)                    1.4.0.20080127                    gsymcheck(1)
2
3
4

NAME

6       gsymcheck - gEDA/gaf Symbol Checker
7

SYNOPSIS

9       gsymcheck [-h] [-v] [-q] symbol1 [... symbolN]
10

DESCRIPTION

12       gsymcheck  is  a symbol checker for gEDA/gaf.  Here is a list of checks
13       that gsymcheck performs:
14
15
16       · Checks for graphical= attribute (if present does varied tests)
17
18       · Checks for the device= attribute
19
20       · Checks for various other missing attributes (pinlabel, pintype,  pin‐
21         seq, footprint, refdes)
22
23       · Checks to make sure that the active pin end is on the 100 unit grid.
24
25       · Checks the uses of the various attributes (duplicates, incorrect syn‐
26         tax, invalid values, etc...)
27
28       · Checks for obsolete, old, and forbidden attributes
29
30       · Checks for any nets or buses within a symbol
31
32       · Checks for any other connections within a symbol
33
34       · Checks to make sure the number of pins is the correct number
35
36

OPTIONS

38       gsymcheck accepts the following options:
39
40       -q      Quiet mode on.  This mode  turns  off  all  warnings/notes/mes‐
41               sages. (optional)
42
43       -v      Verbose  mode  1.   This  mode  will  show  all  error messages
44               (optional)
45
46       -vv     Verbose mode 2.  This mode will show all error and warning mes‐
47               sages (optional)
48
49       -vvv    Verbose  mode  2.   This mode will show all error, warning, and
50               info messages (optional)
51
52       -h      Usage summary / gsymcheck help
53
54       symbol1 [... symbolN]
55               At least one symbol file must be specified.  If  multiple  sym‐
56               bols  are  specified  then  they  are  sequentially read in and
57               checked.  It is important that the schematic(s) follow all  the
58               options (ie last).
59
60

EXAMPLES

62       Here are some examples on how to run gsymcheck:
63
64       To get usage information just run:
65
66             gsymcheck
67
68       To actually check a symbol with just error counts, run:
69
70            gsymcheck symbolfilename.sym
71
72       To get the actuall error messages, run:
73
74            gsymcheck -v symbolfilename.sym
75
76       To see all the error messages and warnings, run:
77
78            gsymcheck -vv symbolfilename.sym
79
80       To see all the error messages, warnings, and parse info, run:
81
82            gsymcheck -vvv symbolfilename.sym
83
84

ENVIRONMENT

86       gsymcheck respects the following environment variable:
87
88       GEDADATA
89               specifies  where  the  various required scheme and rc files are
90               located (the default is ${prefix}/share/gEDA).   This  environ‐
91               ment  variables  does not need to be set by the end user unless
92               they are moving the executables to a new install ${prefix}.
93
94

AUTHOR

96       Ales Hvezda and many others
97
98

SEE ALSO

100       gschem(1), gnetlist(1)
101

103       Copyright ©  1999-2008 Ales Hvezda
104
105       This document can be freely redistributed according to the terms of the
106       GNU General Public License version 2.0
107
108
109
110
111Version                       January 27th, 2008                  gsymcheck(1)
Impressum