gsymcheck/docs/gsymcheck.1

   1 .TH gsymcheck 1 "June 19th, 2011" "gEDA Project" 1.7.1.20110619
   2 .SH NAME
   3 gsymcheck - gEDA/gaf Symbol Checker
   4 .SH SYNOPSIS
   5 .B gsymcheck
   6 [\-h] [\-v] [\-q] symbol1 [... symbolN]
   7 .SH DESCRIPTION
   8 .PP
   9 \fIgsymcheck\fP is a symbol checker for gEDA/gaf.  Here is a list of checks that
  10 \fIgsymcheck\fP performs:
  11
  12 .IP \[bu] 2
  13 Checks for graphical= attribute (if present does varied tests)
  14 .IP \[bu]
  15 Checks for the device= attribute
  16 .IP \[bu]
  17 Checks for various other missing attributes (pinlabel, pintype,
  18 pinseq, footprint, refdes)
  19 .IP \[bu]
  20 Checks to make sure that the active pin end is on the 100 unit
  21 grid.
  22 .IP \[bu]
  23 Checks the uses of the various attributes (duplicates, incorrect
  24 syntax, invalid values, etc...)
  25 .IP \[bu]
  26 Checks for obsolete, old, and forbidden attributes
  27 .IP \[bu]
  28 Checks for any nets or buses within a symbol
  29 .IP \[bu]
  30 Checks for any other connections within a symbol
  31 .IP \[bu]
  32 Checks to make sure the number of pins is the correct number
  33
  34 .SH OPTIONS
  35 \fIgsymcheck\fP accepts the following options:
  36 .TP 8
  37 .B -q
  38 Quiet mode on.  This mode turns off all warnings/notes/messages. (optional)
  39 .TP 8
  40 .B -v
  41 Verbose mode 1.  This mode will show all error messages (optional)
  42 .TP 8
  43 .B -vv
  44 Verbose mode 2.  This mode will show all error and warning messages (optional)
  45 .TP 8
  46 .B -vvv
  47 Verbose mode 2.  This mode will show all error, warning, and info messages (optional)
  48 .TP 8
  49 .B -h
  50 Usage summary / gsymcheck help
  51 .TP 8
  52 symbol1 [... symbolN]
  53 At least one symbol file must be specified.  If multiple symbols are
  54 specified then they are sequentially read in and checked.  It is important
  55 that the schematic(s) follow all the options (ie last).
  56
  57 .SH EXAMPLES
  58 Here are some examples on how to run \fIgsymcheck\fP:
  59
  60 To get usage information just run:
  61
  62          gsymcheck
  63
  64 To actually check a symbol with just error counts, run:
  65
  66         gsymcheck symbolfilename.sym
  67
  68 To get the actuall error messages, run:
  69
  70         gsymcheck \-v symbolfilename.sym
  71
  72 To see all the error messages and warnings, run:
  73
  74         gsymcheck \-vv symbolfilename.sym
  75
  76 To see all the error messages, warnings, and parse info, run:
  77
  78         gsymcheck \-vvv symbolfilename.sym
  79
  80 .SH "ENVIRONMENT"
  81 \fIgsymcheck\fP respects the following environment variable:
  82 .PP
  83 .TP 8
  84 .B GEDADATA
  85 specifies where the various required scheme and rc files are located
  86 (the default is ${prefix}/share/gEDA).  This environment variables does
  87 not need to be set by the end user unless they are moving the executables
  88 to a new install ${prefix}.
  89
  90 .SH "AUTHOR"
  91 Ales Hvezda and many others
  92
  93 .SH SEE ALSO
  94 .BR gschem (1),
  95 .BR gnetlist (1)
  96 .SH COPYRIGHT
  97 Copyright \(co  1999-2008 Ales Hvezda
  98
  99 This document can be freely redistributed according to the terms of the
 100 GNU General Public License version 2.0
 101