gsymcheck/docs/gsymcheck.1

   1 .TH gsymcheck 1 "August 30th, 2009" Version 1.5.4.20090830
   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 .l
  36 \fIgsymcheck\fP accepts the following options:
  37 .TP 8
  38 .B -q
  39 Quiet mode on.  This mode turns off all warnings/notes/messages. (optional)
  40 .TP 8
  41 .B -v
  42 Verbose mode 1.  This mode will show all error messages (optional)
  43 .TP 8
  44 .B -vv
  45 Verbose mode 2.  This mode will show all error and warning messages (optional)
  46 .TP 8
  47 .B -vvv
  48 Verbose mode 2.  This mode will show all error, warning, and info messages (optional)
  49 .TP 8
  50 .B -h
  51 Usage summary / gsymcheck help
  52 .TP 8
  53 symbol1 [... symbolN]
  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).
  57
  58 .SH EXAMPLES
  59 Here are some examples on how to run \fIgsymcheck\fP:
  60
  61 To get usage information just run:
  62
  63          gsymcheck
  64
  65 To actually check a symbol with just error counts, run:
  66
  67         gsymcheck symbolfilename.sym
  68
  69 To get the actuall error messages, run:
  70
  71         gsymcheck -v symbolfilename.sym
  72
  73 To see all the error messages and warnings, run:
  74
  75         gsymcheck -vv symbolfilename.sym
  76
  77 To see all the error messages, warnings, and parse info, run:
  78
  79         gsymcheck -vvv symbolfilename.sym
  80
  81 .SH "ENVIRONMENT"
  82 \fIgsymcheck\fP respects the following environment variable:
  83 .PP
  84 .TP 8
  85 .B GEDADATA
  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}.
  90
  91 .SH "AUTHOR"
  92 Ales Hvezda and many others
  93
  94 .SH SEE ALSO
  95 .BR gschem (1),
  96 .BR gnetlist (1)
  97 .SH COPYRIGHT
  98 Copyright \(co  1999-2008 Ales Hvezda
  99
 100 This document can be freely redistributed according to the terms of the
 101 GNU General Public License version 2.0
 102