gattrib/README

   1 ******************************************************************
   2 *************  DANGER!!  Read the entirety of this  **************
   3 ************  README before you try runing gattrib!  *************
   4 ******************************************************************
   5
   6
   7 INTRODUCTION
   8
   9 Gattrib is gEDA's attribute editor.  It reads a set of gschem .sch
  10 files (schematic files), and creates a spreadsheet showing all
  11 components in rows, with the associated component attributes listed in
  12 the columns.  It allows the user to add, modify, or delete component
  13 attributes outside of gschem, and then save the .sch files back
  14 out.  When it is completed, it will allow the user to edit attributes
  15 attached to components, nets, and pins.  (Currently, only component
  16 attribute editing is implemented; pin and net attributes are displayed
  17 only.)
  18
  19 Gattrib is useful in situations where you need to view, add, modify,
  20 or delete a number of attributes all at once.  It saves you the pain
  21 of clicking on each component and repeatedly using gschem's attribute
  22 editor to modify component attributes.  For example, if you create a
  23 large design with generic components, and then later want to attach
  24 "footprint" attributes to your components, it is a real hassle to do
  25 so using gschem.  In this situation, you can run gattrib on your
  26 design files to attach the "footprint" attributes all at once using an
  27 easy-to-use spreadsheet.
  28
  29 WARNING NOTE:  Gattrib has been tested on many designs,
  30 but is not guaranteed to work.  It may even trash your design!
  31 Therefore, always keep a back-up copy of your design files.  Note that
  32 this is good advice when using any software on critical files.
  33
  34 ------------------------------------------------------------------
  35 USAGE
  36
  37 You can invoke gattrib on your design from the command line in the
  38 following way:
  39
  40 gattrib my_design_*.sch
  41
  42 (This assumes you have a multi-page design with file names
  43 "my_design_1.sch", "my_design_2.sch", etc.)  Gattrib will then read in
  44 your design, and present you with a spreadsheet showing all components
  45 and associated attributes.
  46
  47 You can also just run gattrib, and specify the input files using the
  48 file->open dialog box.
  49
  50 To edit your attributes, just edit the cells in the spreadsheet.
  51
  52 To save your design, just select "save" from the command menu.  Note
  53 that no checks are currently done when you select save.  Be careful!
  54
  55 You can also save out a csv (comma separated values) file, which can
  56 later be imported into e.g. oocalc.  This is useful for BOM
  57 management.
  58
  59 To quit, just select "quit" from the command menu.  Note that
  60 currently no checks thet you have saved your design are done when you
  61 quit.
  62
  63 If you want to add an entirely new attribute to your design (i.e. one
  64 which doesn't exist on any component), you can do this through "edit
  65 -> add new attribute column".  You can also delete an entire attribut
  66 column.
  67
  68 You can set the visibility of any particular attribute, or an entire
  69 column of attributes through the "visibility" menu.  Just select the
  70 attribute or column first, then do "visibility -> <whatever>".
  71
  72 ------------------------------------------------------------------
  73 FEATURES
  74
  75 The following features are currently implemented:
  76
  77 *  .sch file read in from command line.
  78 *  .sch file read in from menu.
  79 *  .sch file save out from menu.
  80 *  CSV (comma separated value) file save out from menu.
  81 *  Component attribute editing (of course).
  82 *  Net attribute viewing.
  83 *  Pin attribute viewing.
  84 *  Add/delete attribute columns.
  85 *  Changing visibility of attributes.
  86 *  Quit from menu.
  87
  88 The following features are currently unimplemented, but will be
  89 incorporated at some future date:
  90
  91 *  Throw up "Are you sure" dialog boxes upon selecting "save" from
  92    menu. (Is this really necessary?)
  93 *  Editing of net attributes (important for setting routing
  94    attributes).
  95 *  Search/replace of individual attributes.
  96 *  Search for component refdeses & netnames.
  97 *  Indicate component visibility by changing the color of the
  98    attribute in each cell.  Example:  Invisible = light grey.
  99    Name only = red. Value only = normal black.  Name & value = bold
 100    face.
 101
 102 Note that if you select unimplemented features from the menu, you will
 103 get a warning window.
 104
 105 ------------------------------------------------------------------
 106 INSTALLATION
 107
 108 To install gattrib, place the tarball in the directory where your gEDA
 109 sources live.  Then do:
 110
 111 tar -zxvf geda-gattrib-20040806.tar.gz
 112 cd geda-gattrib-20040806
 113 ./configure --prefix=/path/to/your/geda/stuff
 114 make
 115 make install
 116
 117 Note that you may need to set some environment variables first.  Also
 118 remember to use a date code (20040806) corresponding to the current
 119 gattrib distribution .  If your compilation barfs, try setting these
 120 (for csh):
 121
 122 setenv LD_LIBRARY_PATH /usr/local/geda/lib:$LD_LIBRARY_PATH
 123 setenv PATH /usr/local/geda/bin:$PATH
 124 setenv PKG_CONFIG_PATH /usr/local/geda/lib/pkgconfig:$PKG_CONFIG_PATH
 125
 126 ------------------------------------------------------------------
 127 CREDITS/CONTACT:
 128
 129 Gattrib was cobbled together by Stuart Brorson starting in December
 130 2003 from parts culled from GtkSheet (GTK+Extra) and gEDA.  Please
 131 mail bug reports to: sdb@cloud9.net
 132
 133
 134