1 .TH gsymcheck 1 "August 30th, 2009" Version 1.5.4.20090830
3 gsymcheck - gEDA/gaf Symbol Checker
6 [-h] [-v] [-q] symbol1 [... symbolN]
9 \fIgsymcheck\fP is a symbol checker for gEDA/gaf. Here is a list of checks that
10 \fIgsymcheck\fP performs:
13 Checks for graphical= attribute (if present does varied tests)
15 Checks for the device= attribute
17 Checks for various other missing attributes (pinlabel, pintype,
18 pinseq, footprint, refdes)
20 Checks to make sure that the active pin end is on the 100 unit
23 Checks the uses of the various attributes (duplicates, incorrect
24 syntax, invalid values, etc...)
26 Checks for obsolete, old, and forbidden attributes
28 Checks for any nets or buses within a symbol
30 Checks for any other connections within a symbol
32 Checks to make sure the number of pins is the correct number
36 \fIgsymcheck\fP accepts the following options:
39 Quiet mode on. This mode turns off all warnings/notes/messages. (optional)
42 Verbose mode 1. This mode will show all error messages (optional)
45 Verbose mode 2. This mode will show all error and warning messages (optional)
48 Verbose mode 2. This mode will show all error, warning, and info messages (optional)
51 Usage summary / gsymcheck help
54 At least one symbol file must be specified. If multiple symbols are
55 specified then they are sequentially read in and checked. It is important
56 that the schematic(s) follow all the options (ie last).
59 Here are some examples on how to run \fIgsymcheck\fP:
61 To get usage information just run:
65 To actually check a symbol with just error counts, run:
67 gsymcheck symbolfilename.sym
69 To get the actuall error messages, run:
71 gsymcheck -v symbolfilename.sym
73 To see all the error messages and warnings, run:
75 gsymcheck -vv symbolfilename.sym
77 To see all the error messages, warnings, and parse info, run:
79 gsymcheck -vvv symbolfilename.sym
82 \fIgsymcheck\fP respects the following environment variable:
86 specifies where the various required scheme and rc files are located
87 (the default is ${prefix}/share/gEDA). This environment variables does
88 not need to be set by the end user unless they are moving the executables
89 to a new install ${prefix}.
92 Ales Hvezda and many others
98 Copyright \(co 1999-2008 Ales Hvezda
100 This document can be freely redistributed according to the terms of the
101 GNU General Public License version 2.0