Update wiki pages
[geda-gaf.git] / docs / wiki / geda-olib_readme.html
blob8bd99823875d0a995e09fa8d31fe1fa23165ed89
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html>
4 <head>
5 <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
6 <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
7 <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10 </head>
11 <body>
13 <h1 class="sectionedit1" id="olib_orcad_tm_converter_readme">olib (OrCAD (TM) converter) README</h1>
14 <div class="level1">
15 <pre class="code">###############################################################
16 README and release notes for olib2geda - 1 settembre 2002
17 OrCAD (TM) lib ASCII dump to gEDA .sym converter
18 ###############################################################
21 What it olib2geda?
22 It&#039;s a simple automated converter from OrCAD v4 (in SDT version 1.10) parts
23 library (in ASCII dump format, through &quot;decomp&quot; utility) to gEDA component
24 definition in .sym format file.
25 It allow an initial dumb conversion file to file, with one lib converted in
26 multiple .sym file, one per component in library.
27 The converted component file needs little editing to become usable, but in some
28 case needs no editing at all.
31 What olib do.
32 * Convert box shaped component in OrCAD (TM) lib in .sym file in gEDA format
33 * Place pin, pin name, pin type, pin number
34 * Place logic bubble when needed (DOT attribute in OrCAD (TM), for logic nega-
35 tion)
36 * Place clock arrow when needed (CLK attribute)
37 * Place reference, from REFERENCE statement in OrCAD (TM)
38 * Place Part name as label and device name as attribute
39 * Parse and draw non-box component, with LINE, ARC, CIRCLE and TEXT
40 * Add power pin as invisible net=name:pin attribute when detected (in OrCAD (TM)
41 invisible pin has tipically T0 and B0 coords)
42 * Through command line switch, hides pin name in VECTOR drawed symbols, allowing
43 better appearance
44 * Write both new (20020825) and old (20020209) file format for .sym files
45 through a switch on the command line
48 What olib do not.
49 * Do not parse and store alternate component drawing (statement CONVERT in
50 OrCAD (TM))
51 * Do not handle drawing part using VECTOR list from another part (statement
52 VECTOR &#039;partname&#039; in OrCAD (TM))
53 * Do not handle FILL statement in VECTOR statement (incompatible with gEDA, but
54 for what i know is used only for &quot;better&quot; part drawing)
55 * Do not handle multiple part in one package (slots in gEDA)
58 Bugs.
59 More and more. But for the use that I do bugs aren&#039;t so critical.
60 If you find a bug or want improvements to the program, feel free to contact me
61 at the e-mail address at the end of this text.
64 How to obtain last version.
65 Open the URL:
66 http://digilander.libero.it/tailchaser
67 in section &quot;Linux&quot; you can see the main page of olib.
70 Compile and install.
71 [[ Ales here, I have incorperated olib into the ./configure build mechanism,
72 so these instructions only apply if you build from Mario&#039;s distribution ]]
74 To compile program go in directory &#039;src&#039; of the unpacked tarball, and type
75 &#039;make&#039;. This produces the binary executable, named &#039;olib&#039;.
76 Compilation process uses the flex scanner generator to generate the file
77 &#039;olib.c&#039; from the &#039;olib.lex&#039;, and link the library math to the code. The binary
78 included in the distribution is compiled on a P266-MMX with RedHat 7.2, with gcc
79 version 2.96 and flex 2.5.4, but the program don&#039;t require any special feature
80 or critical function, as far as I know. At the end of compilation phase, you can
81 see two warnings:
82 * warning, -s option given but default rule can be matched
83 * warning: `yyunput&#039; defined but not used
84 this is normal, don&#039;t affect program functionality, and you can safely ignore
85 it.
86 Installation is not needed for normal operations, but if you want you can copy
87 only the executable (olib) on a directory in the PATH.
90 Use of olib.
91 To convert library, first convert it to ASCII dump with &#039;decomp&#039; utility
92 included in the OrCAD (TM) distribution. After that invoke the lib converter:
93 olib path/to/file/file_ascii prefix where &#039;prefix&#039; is used to generate file name
94 of every symbol, like:
95 prefix-partname-1.sym
96 During the process, you can see a lot of ugly text scrolling in the terminal,
97 that show the progress of the conversion. If you want to read this text, you can
98 redirect the stderr output to a file:
99 olib path/to/file/file_ascii prefix 2&gt; logfile.txt
100 where &#039;2&gt;&#039; instruct the shell to redirect stderr output to logfile.txt.
101 The converter write one file per part, in the current directory. At the end of
102 the execution you can see a lot of file in the directory, extracted from OrCAD
103 library.
104 In the (not so improbable) case of incomplete conversion of a part (i.e. because
105 of unsupported VECTOR &#039;partname&#039; statement), the file of the incomplete part
106 will be named &#039;prefix-partname-1.sym.part&#039;, stand for partial conversion.
107 If the conversion process stops with the message: &quot;flex scanner jammed&quot;, the
108 converter has encountered an unknown statement, an incompatible version of
109 library, or a bug. If you can, please report the complete log and the library
110 dump, to allow corrections or improvements.
113 Mario Pascucci
114 &lt;m.pas@libero.it&gt;</pre>
116 </div>
117 </body>
118 </html>