~ubuntu-branches/ubuntu/trusty/geda-utils/trusty

« back to all changes in this revision

Viewing changes to docs/README.olib

  • Committer: Bazaar Package Importer
  • Author(s): Hamish Moffatt
  • Date: 2005-03-15 23:04:53 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20050315230453-x3x6qtw9qv17zbnf
Tags: 20050313-1
New upstream release

Show diffs side-by-side

added added

removed removed

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