docs/wiki/geda_gattrib_readme.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   4  lang="en" dir="ltr">
   5 <head>
   6   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   7   <title>geda:gattrib_readme</title>
   8 <meta name="generator" content="DokuWiki Release rc2007-05-24" />
   9 <meta name="robots" content="index,follow" />
  10 <meta name="date" content="2007-05-24T22:27:25-0400" />
  11 <meta name="keywords" content="geda,gattrib_readme" />
  12 <link rel="search" type="application/opensearchdescription+xml" href="http://geda.seul.org/wiki/lib/exe/opensearch.php" title="geda Wiki" />
  13 <link rel="start" href="http://geda.seul.org/wiki/" />
  14 <link rel="contents" href="http://geda.seul.org/wiki/geda:gattrib_readme?do=index" title="Index" />
  15 <link rel="alternate" type="application/rss+xml" title="Recent Changes" href="http://geda.seul.org/wiki/feed.php" />
  16 <link rel="alternate" type="application/rss+xml" title="Current Namespace" href="http://geda.seul.org/wiki/feed.php?mode=list&ns=geda" />
  17 <link rel="alternate" type="text/html" title="Plain HTML" href="http://geda.seul.org/wiki/_export/xhtml/geda:gattrib_readme" />
  18 <link rel="alternate" type="text/plain" title="Wiki Markup" href="http://geda.seul.org/wiki/_export/raw/geda:gattrib_readme" />
  19 <link rel="stylesheet" media="all" type="text/css" href="lib/exe/css" />
  20 <link rel="stylesheet" media="screen" type="text/css" href="lib/exe/001css" />
  21 <link rel="stylesheet" media="print" type="text/css" href="lib/exe/002css" />
  22 </head>
  23 <body>
  24 <div class="dokuwiki export">
  25
  26
  27
  28 <h1><a name="gattrib_readme" id="gattrib_readme">gattrib README</a></h1>
  29 <div class="level1">
  30 <pre class="code">******************************************************************
  31 *************  DANGER!!  Read the entirety of this  **************
  32 ************  README before you try runing gattrib!  *************
  33 ******************************************************************
  34
  35
  36 INTRODUCTION
  37
  38 Gattrib is gEDA&#039;s attribute editor.  It reads a set of gschem .sch
  39 files (schematic files), and creates a spreadsheet showing all
  40 components in rows, with the associated component attributes listed in
  41 the columns.  It allows the user to add, modify, or delete component
  42 attributes outside of gschem, and then save the .sch files back
  43 out.  When it is completed, it will allow the user to edit attributes
  44 attached to components, nets, and pins.  (Currently, only component
  45 attribute editing is implemented; pin attributes are displayed only,
  46 and net attributes are TBD.)
  47
  48 Gattrib is useful in situations where you need to view, add, modify,
  49 or delete a number of attributes all at once.  It saves you the pain
  50 of clicking on each component and repeatedly using gschem&#039;s attribute
  51 editor to modify component attributes.  For example, if you create a
  52 large design with generic components, and then later want to attach
  53 &quot;footprint&quot; attributes to your components, it is a real hassle to do
  54 so using gschem.  In this situation, you can run gattrib on your
  55 design files to attach the &quot;footprint&quot; attributes all at once using an
  56 easy-to-use spreadsheet.
  57
  58 WARNING NOTE:  Gattrib is currently PRE-ALPHA SOFTWARE!
  59 It has been tested on several designs, but is not garuanteed to work.
  60 It may even trash your design!  Therefore, if you wish to try gattrib
  61 out, please create a backup copy of your design before you run it!
  62
  63 ------------------------------------------------------------------
  64 USAGE
  65
  66 You can invoke gattrib on your design from the command line in the
  67 following way:
  68
  69 gattrib my_design_*.sch
  70
  71 (This assumes you have a multi-page design with file names
  72 &quot;my_design_1.sch&quot;, &quot;my_design_2.sch&quot;, etc.)  Gattrib will then read in
  73 your design, and present you with a spreadsheet showing all components
  74 and associated attributes.
  75
  76 You can also just run gattrib, and specify the input files using the
  77 file-&gt;open dialog box.
  78
  79 To edit your attributes, just edit the cells in the spreadsheet.
  80
  81 To save your design, just select &quot;save&quot; from the command menu.  Note
  82 that no checks are currently done when you select save.  Be careful!
  83
  84 To quit, just select &quot;quit&quot; from the command menu.  Note that
  85 currently no checks thet you have saved your design are done when you
  86 quit.
  87
  88 If you want to add an entirely new attribute to your design (i.e. one
  89 which doesn&#039;t exist on any component), you must first attach at least
  90 one instance of that attribute to a component using gschem.  Then you
  91 can use gattrib to attach the attribute to the remaining components.
  92 (The reason for this is that gattrib creates its spreadsheet columns
  93 based upon all attributes it finds when reading in the design.
  94 Therefore, to create a column for a new attribute, you need to make
  95 sure that that new attribute pre-exists in the design.)  In the future,
  96 you will be able to add new attribute columns directly from gattrib,
  97 but this feature is currently unimplemented.
  98
  99 ------------------------------------------------------------------
 100 FEATURES
 101
 102 The following features are currently implemented:
 103
 104 *  .sch file read in from command line.
 105 *  .sch file read in from menu.
 106 *  .sch file save out from menu.
 107 *  Component attribute editing (of course).
 108 *  Pin attribute viewing.
 109 *  Quit from menu.
 110
 111 The following features are currently unimplemented, but will be
 112 incorporated at some future date:
 113
 114 *  Throw up &quot;Are you sure&quot; dialog boxes upon selecting &quot;save&quot; and
 115    &quot;quit&quot; from menu.
 116 *  Alphabetic sort of rows.  (Should happen automatically upon read-in
 117    of design.)
 118 *  Editing of net attributes (important for setting routing
 119    attributes).
 120 *  Adding/deleting attribute columns (to add/delete entire sets of
 121    attributes from a design.)
 122 *  Search/replace of individual attributes.
 123 *  Search for component refdeses &amp; netnames.
 124 *  Set/view component &amp; net visibility (through options pull-down
 125    menu).  Currently, visibility is &quot;invisible&quot;, and both name &amp; value
 126    are displayed (if you turn on the visibility).
 127
 128 Note that if you select unimplemented features from the menu, nothing
 129 will happen.
 130
 131 ------------------------------------------------------------------
 132 INSTALLATION
 133
 134 To install gattrib, place the tarball in the directory where your gEDA
 135 sources live.  Then do:
 136
 137 tar -zxvf geda-gattrib-20040806.tar.gz
 138 cd geda-gattrib-20040806
 139 ./configure --prefix=/path/to/your/geda/stuff
 140 make
 141 make install
 142
 143 Note that you may need to set some environment variables first.  If
 144 your compilation barfs, try setting these (for csh):
 145
 146 setenv LD_LIBRARY_PATH /usr/local/geda/lib:$LD_LIBRARY_PATH
 147 setenv PATH /usr/local/geda/bin:$PATH
 148 setenv PKG_CONFIG_PATH /usr/local/geda/lib/pkgconfig:$PKG_CONFIG_PATH
 149
 150 ------------------------------------------------------------------
 151 CREDITS/CONTACT:
 152
 153 Gattrib was cobbled together by Stuart Brorson starting in December
 154 2003 from parts culled from GtkSheet (GTK+Extra) and gEDA.  Please
 155 mail bug reports to: sdb@cloud9.net
 156
 157
 158
 159 </pre>
 160
 161 </div>
 162 </div>
 163 </body>
 164 </html>