~ubuntu-branches/ubuntu/utopic/tcm/utopic

« back to all changes in this revision

Viewing changes to INSTALL_

  • Committer: Bazaar Package Importer
  • Author(s): Otavio Salvador
  • Date: 2003-07-03 20:08:21 UTC
  • Revision ID: james.westby@ubuntu.com-20030703200821-se4xtqx25e5miczi
Tags: upstream-2.20
ImportĀ upstreamĀ versionĀ 2.20

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
BINARY TAR.GZ DISTRIBUTIONS.
 
2
============================
 
3
 
 
4
To install a TCM distribution (tar.gz file) with binaries: unzip and untar 
 
5
the TCM distribution by:
 
6
 
 
7
tar xzvfp <filename>                         or 
 
8
gunzip -c <filename> | tar xvfp -            or
 
9
zcat <filename> | tar xvfp -            
 
10
 
 
11
This creates a new directory named tcm-<version>/ in the current
 
12
directory.
 
13
 
 
14
Every user of TCM should set the TCM_HOME environment variable to the
 
15
directory where TCM is installed. It is recommended that they add
 
16
$TCM_HOME/bin to their PATH and add $TCM_HOME/man to their MANPATH
 
17
environment variable.
 
18
 
 
19
The distributions for Solaris contain shared object libraries. If you
 
20
have one of these distributions and you have TCM installed in a directory
 
21
other than /opt/tcm, each user should set the LD_LIBRARY_PATH
 
22
variable like this: LD_LIBRARY_PATH=$TCM_HOME/lib:$LD_LIBRARY_PATH.
 
23
Users of Linux do not need to set LD_LIBRARY_PATH.
 
24
 
 
25
Finally, test the TCM startup tool called tcm and at least one of the editors
 
26
(e.g. tgd, tefd, tssd etc).
 
27
 
 
28
To configure amongst others the path names of some external Unix programs that 
 
29
are used by TCM you can modify the $TCM_HOME/lib/tcm.conf file.
 
30
 
 
31
For more information you are referred to our extensive user's guide which 
 
32
can be found via $TCM_HOME/doc/usersguide.html and in
 
33
$TCM_HOME/doc/usersguide-<version>.ps.gz (gzipped-Postscript).
 
34
 
 
35
 
 
36
BINARY RPM DISTRIBUTIONS.
 
37
=========================
 
38
 
 
39
These distributions are made and tested with Redhat 6.0 and Redhat 6.1.
 
40
 
 
41
Install the distribution by:
 
42
rpm --install tcm-<version>.i386.rpm
 
43
 
 
44
Or upgrade an existing distribution by:
 
45
rpm --upgrade tcm-<version>.i386.rpm
 
46
 
 
47
By default TCM is installed in /opt/tcm. With the rpm option
 
48
'--prefix <dir>' you can install it in a different directory. Some of the 
 
49
documentation will be installed by default in /usr/doc/tcm-<version>.
 
50
 
 
51
There are two sorts of binary RPMs. One contains the name 'statmotif'
 
52
and the other 'dynmotif'. The first sort has Motif statically 
 
53
linked into the executables. The 'dynmotif' RPMs are dynamically
 
54
linked against Motif 1.2. It uses the libXm.so (version 1.2) of Motif
 
55
or Lesstif on your system.
 
56
 
 
57
The RPM installation creates some initialization scripts for TCM in 
 
58
/etc/profile.d. It is therefore not necessary to set yourself environment
 
59
variables like for the tar.gz distribution.
 
60
You only have to login again before you start using TCM.
 
61
 
 
62
 
 
63
SOURCE TAR.GZ DISTRIBUTIONS
 
64
===========================
 
65
 
 
66
You untar the file in the same way as for binary distributions and you
 
67
set the variables $TCM_HOME and $PATH.
 
68
 
 
69
Go to $TCM_HOME and enter 'make'. This tries to configure some things
 
70
and then writes some instructions to standard output for how to proceed.
 
71
 
 
72
If the above method does not work well on your system or you are only
 
73
interested in compiling some part of the sources then do the following:
 
74
 
 
75
1. Change to the directory ./src of the distribution.
 
76
2. Make a softlink named Config.tmpl to Config.tmpl_YOURPLATFORM.
 
77
3. Check and, if necessary, update the settings in Config.tmpl.
 
78
4. Make a softlink named Makefile to Makefile_YOURCOMPILER.
 
79
5. make clean 
 
80
6. make depend
 
81
7. make all or make <someexecutable> or make <somelibrary>.
 
82
   (step 7 can be repeated an infinite number of times).
 
83
 
 
84
 
 
85
Additional technical information about compiling the software and
 
86
about the internal structure of the software, see the document
 
87
$TCM_HOME/doc/developersguide/index.html or 
 
88
$TCM_HOME/doc/developersguide-<version>.ps.gz (gzipped PostScript).
 
89
 
 
90
 
 
91
USER INTERFACE
 
92
==============
 
93
 
 
94
For compiling TCM you either need a developer version of Motif or the 
 
95
free Motif-clone Lesstif (www.lesstif.org). 
 
96
 
 
97
For running TCM binaries you need a Motif or Lesstif runtime library, 
 
98
unless you have downloaded a distribution with 'statmotif' as
 
99
substring in the file name.
 
100
 
 
101
The looks of TCM is sometimes subject of discussion. For users who 
 
102
liked how TCM looked last century there is an option in tcm.conf:
 
103
        { GUIstyle Classic }
 
104
 
 
105
 
 
106
MOUSE ISSUES
 
107
==============
 
108
 
 
109
TCM needs a 3-button mouse. The left and middle buttons are the most 
 
110
essential for drawing nodes and edges and the right button is only used 
 
111
for a pop-up menu. Most 2-button mice emulate the middle button by 
 
112
pressing both buttons at the same time or by pressing the left button 
 
113
together with the Shift- or Ctrl-key. A possibly better solution is to 
 
114
change the function of the right and middle mouse button with: 
 
115
xmodmap -e "pointer = 1 3 2".
 
116
 
 
117
If you're using a so-called 5-button mouse (IntelliMouse with wheel-button), 
 
118
you can change the function of the right and middle mouse button with: 
 
119
xmodmap -e "pointer = 1 3 2 4 5". 
 
120
 
 
121
! NEW !
 
122
As of version 1.98 the middle mouse button is not required anymore.
 
123
Pressing or dragging with the left mouse button while you are pressing the
 
124
Shift-key has the same effect as pressing or dragging the middle button. 
 
125
 
 
126
 
 
127
FONT AND COLOR ISSUES
 
128
=====================
 
129
 
 
130
In $TCM_HOME/lib/tcm.conf you can see which (types of) fonts are used for 
 
131
the TCM documents by default. If you wish some other font you can edit this
 
132
file (or better, put the options in a personal file $HOME/.tcmrc ). 
 
133
 
 
134
TCM uses scalable X fonts. If these are not installed or don't look good
 
135
for your tastes then you can tell TCM to work with unscalable fonts by 
 
136
specifying:
 
137
       { ScalableFonts False }. 
 
138
If you wish fonts of a certain foundry, e.g. only Adobe fonts, then specify 
 
139
that with the following line in $TCM_HOME/lib/tcm.conf or $HOME/.tcmrc :
 
140
       { FontFoundry Adobe }
 
141
 
 
142
In $TCM_HOME/lib/TCM you can see which fonts and colors are being used for
 
143
the Motif GUI of TCM. These can be overridden too if you wish. Changes to 
 
144
these defaults can be added to your .Xdefaults or .Xresources file or 
 
145
loaded for the current X session with the 'xrdb' command.
 
146
 
 
147
 
 
148
EXPORT FORMATS
 
149
==============
 
150
 
 
151
TCM is able to generate Xfig format and PNG graphics format from a diagram.
 
152
For the generation of PNG we rely on the fig2dev tool. You should have a fairly
 
153
recent version of transfig (fig2dev is part of transfig). If you want to download 
 
154
a recent version of fig2dev and you use Linux with RPM support, you could get one 
 
155
of the 'transfig' packages from http://www.rpmfind.net. The sources can be 
 
156
downloaded from: ftp://epb1.lbl.gov/xfig/. At these sites you can also find
 
157
the sources or binaries of the Xfig drawing program.