utils/docs/gmk_sym.1

   1 .TH gmk_sym 1 "November 23rd, 2012" "gEDA Project" 1.8.1.20121123
   2
   3 .SH NAME
   4 gmk_sym \- create rectangular symbols for gschem from a text file
   5
   6 .SH SYNOPSIS
   7 .B gmk_sym [ -d ]
   8 .I inputfile.txt
   9 .B >
  10 .I outputfile.sym
  11 .PP
  12 .B gmk_sym -h|-?
  13
  14 .SH DESCRIPTION
  15 .B gmk_sym
  16 is a program to create rectangular symbols for gschem from a file
  17 composed of comma separated lines.
  18
  19 .SH OPTIONS
  20 .TP
  21 \-d
  22 Turn on debug output
  23 .TP
  24 \-h, \-?
  25 Display usage information
  26
  27 .SH FILE FORMAT
  28 The input file format is:
  29 .IP \(bu
  30 lines starting with ';' are comment lines and are not processed;
  31 .IP \(bu
  32 The 1st valid line describes a device:
  33 .RS
  34 .IP \(bu
  35 1st value: device name
  36 .IP \(bu
  37 2nd value: visible name
  38 .IP \(bu
  39 3rd value: visible name location on package
  40 .IP \(bu
  41 4th value: box's hoz size, in pins spacings
  42 .IP \(bu
  43 5th value: box's ver size, in pins spacings
  44 .IP \(bu
  45 6th value: uref prefix, like U or J
  46 .IP \(bu
  47 7th value: Footprint
  48 .IP \(bu
  49 8th value: Total number of pins on device (including hidden)
  50 .RE
  51 .IP \(bu
  52 All other valid lines describes the symbol's pins:
  53 .RS
  54 .IP \(bu
  55 1st value: pin name
  56 .IP \(bu
  57 2nd value: pin number
  58 .IP \(bu
  59 3rd value: pin shape, choice of: line, clock, dot&line
  60 .IP \(bu
  61 4th value: side of box to attach the pin,choice of: R, L, T, B
  62 .IP \(bu
  63 5th value: location of pin on side of box, in pin spacings
  64 .IP \(bu
  65 6th value: (optional) pin type attribute: in, out, io, oc, oe,
  66 pas, tp, tri, clk, pwr
  67 .RE
  68
  69 .SH AUTHOR
  70 Jerry O'Keefe <jerryok@pacbell.net>
  71
  72 .SH SEE ALSO
  73 .BR gschem (1)
  74
  75 .SH COPYRIGHT
  76 .nf
  77 Copyright \(co 1999-2011 gEDA Contributors.  License GPLv2+: GNU GPL
  78 version 2 or later.  Please see the `COPYING' file included with this
  79 program for full details.
  80 .PP
  81 This is free software: you are free to change and redistribute it.
  82 There is NO WARRANTY, to the extent permitted by law.