← Back to branch summary

~ubuntu-branches/ubuntu/hoary/kdemultimedia/hoary

« back to all changes in this revision

Viewing changes to doc/kscd/workman-docs/html/install.html

  • Committer: Bazaar Package Importer
  • Author(s): Martin Schulze
  • Date: 2003-01-22 15:00:51 UTC
  • Revision ID: james.westby@ubuntu.com-20030122150051-uihwkdoxf15mi1tn
Tags: upstream-2.2.2
Import upstream version 2.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/kscd/workman-docs/html/install.html
 
1
<html>
 
2
<head>
 
3
<!-- @(#)install.html   1.2 04 Jun 1995 -->
 
4
<title>Installing WorkMan</title>
 
5
</head>
 
6
 
 
7
<body>
 
8
<h1>How to Install WorkMan</h1>
 
9
 
 
10
<h2>Prerequisites</h2>
 
11
 
 
12
<p>
 
13
WorkMan requires XView version 3 or higher.  This is supplied by default on Sun
 
14
systems (though you may have to select the "OpenWindows Developers" category
 
15
from your SunOS or Solaris CD to get the necessary files for compiling) and is
 
16
available as part of the "contrib" distribution in X11R5 and X11R6 for other
 
17
systems.
 
18
 
 
19
<p>
 
20
Some of the Makefiles assume that OPENWINHOME is set to the Sun OpenWindows 3.x
 
21
home directory.  Some tweaking will probably be required if you're not using
 
22
OpenWindows; OPENWINHOME is used to locate the XView include files and
 
23
libraries.
 
24
 
 
25
<h2>Building</h2>
 
26
 
 
27
<p>
 
28
How you build WorkMan depends on which platform you're trying to build it on.
 
29
The following are the quick-and-dirty instructions, and will often suffice,
 
30
but you should follow the link on your platform's name for more information.
 
31
 
 
32
<p>
 
33
On most platforms, you can configure WorkMan to use a database library from
 
34
4.4BSD to look CDs up very quickly.  More details on that
 
35
<a href="#libdb">below.</a>
 
36
 
 
37
<dl>
 
38
<dt>SunOS 4.x
 
39
<dd>
 
40
        Edit "Makefile" and comment out the Solaris 2 lines (SOL2, LIBLOC,
 
41
        and EXTRA_LIBS).  Then
 
42
        type "make".  You may want to use the "-e" option when you run
 
43
        WorkMan; see the manpage.
 
44
 
 
45
<p>
 
46
<dt><a href="notes-solaris2.html">Solaris 2.x</a>
 
47
<dd>
 
48
        If you're not using gcc, adjust the Makefile accordingly.  Then type
 
49
        "make".
 
50
 
 
51
<p>
 
52
<dt><a href="notes-ultrix.html">ULTRIX</a><br>
 
53
    <a href="notes-news.html">NEWS-OS</a><br>
 
54
    <a href="notes-bsd386.html">BSD/386</a><br>
 
55
    <a href="notes-freebsd.html">FreeBSD</a>
 
56
<dd>
 
57
        Run "imake" or "xmkmf" to convert the supplied Imakefile to a Makefile.
 
58
        Or edit the Makefile to point to the right directories.
 
59
 
 
60
<p>
 
61
<dt><a href="notes-hpux.html">HP-UX</a>
 
62
<dd>
 
63
        Edit "Makefile.hpux" to point to the correct directories, then type
 
64
        "make -f Makefile.hpux" to build WorkMan.  You may want to use the
 
65
        "-e" option when you run WorkMan; see the manpage.
 
66
 
 
67
<p>
 
68
<dt><a href="notes-linux.html">Linux</a>
 
69
<dd>
 
70
        Edit "Makefile.linux" to point to the correct directories.  Uncomment
 
71
        the PASS line if appropriate (see the Makefile.)
 
72
        Then type "make -f Makefile.linux" to build WorkMan.
 
73
 
 
74
<p>
 
75
<dt><a href="notes-svr4.html">SVr4 4.0</a>
 
76
<dd>
 
77
        Edit "Makefile.svr4" to point to the right directories, then type
 
78
        "make -f Makefile.svr4".
 
79
 
 
80
<p>
 
81
<dt><a href="notes-osf1.html">OSF/1</a>
 
82
<dd>
 
83
        <em>Note: OSF/1 is not officially supported; the code is known to
 
84
        have problems on many systems.</em>
 
85
        Edit "Makefile.osf1" to point to the right directories, then type
 
86
        "make -f Makefile.osf1".  Note that this port is preliminary and
 
87
        there are known problems (see README.osf1 for details).
 
88
 
 
89
</dl>
 
90
 
 
91
<h3><a name="libdb">Using the libdb package</a></h3>
 
92
 
 
93
WorkMan can optionally make use of the 4.4BSD "libdb" package to speed up
 
94
database lookups tremendously.  Here's how to use it.
 
95
 
 
96
<ol>
 
97
   <li> For now, you have to get libdb separately; it's available on
 
98
        <a href="ftp://ftp.cs.berkeley.edu/ucb/4bsd/">ftp.cs.berkeley.edu</a>
 
99
        in /ucb/4bsd.
 
100
 
 
101
   <li> Unpack libdb in the WorkMan source directory.  A subdirectory called
 
102
        "db.1.85" will be created.  
 
103
 
 
104
   <li> <code>cd db.1.85/PORT</code>
 
105
 
 
106
   <li> Have a look at the README file if you like.
 
107
 
 
108
   <li> There are a bunch of system-specific directories in PORT.  Look for
 
109
        the system name that most closely resembles yours.  Go into it.
 
110
 
 
111
   <li> <code>make</code>
 
112
 
 
113
   <li> Go back to the WorkMan source directory (<code>cd ../../..</code>).
 
114
 
 
115
   <li> Edit your system's Makefile, or the Imakefile if that's what you're
 
116
        using.  You'll see a comment about libdb; the lines below that define
 
117
        some compiler options and the path to the libdb library.  Uncomment
 
118
        those lines and make sure the paths point to the PORT directory you
 
119
        built libdb in.
 
120
 
 
121
   <li> <code>make</code> (with appropriate arguments, e.g.
 
122
        <code>-f Makefile.linux</code>, for your system.)
 
123
 
 
124
</ol>
 
125
 
 
126
<p>
 
127
If you have an old WorkMan database sitting around, you should build an index
 
128
file for it; WorkMan itself only writes to the index file when you save or
 
129
update a CD.  There's a program called "buildindex" to build index files.
 
130
Type "<code>make buildindex</code>" (specifying an alternate Makefile as
 
131
appropriate) after you've built WorkMan.  To run buildindex, just give it the
 
132
path to your database file as an argument, e.g. "<code>buildindex
 
133
$HOME/.workmandb</code>".
 
134
 
 
135
<p>
 
136
One thing to be careful of is using libdb on a database you're sharing via NFS
 
137
on a system without working file locking.  If you run WorkMan with the "-n"
 
138
option to bypass the file locking code, you risk corrupting the index file if
 
139
two people save CDs at once.  If you're the only one using a CD database, or
 
140
the only one with write access to it, you can safely use -n in conjunction
 
141
with libdb; it's only when two or more entries are saved simultaneously that
 
142
problems can occur.  In that case the best solution is to bug your sysadmin,
 
143
or your UNIX vendor, to give you working file locking.
 
144
 
 
145
<h2>Installing</h2>
 
146
 
 
147
<p>
 
148
Once the executable is built, install it in your favorite directory for such
 
149
things.  The file "workman.info" should be placed in the XView help directory,
 
150
usually $OPENWINHOME/lib/help.  If you put it somewhere else, be sure to set
 
151
your HELPPATH environment variable to point to that directory.  This is
 
152
necessary if you want to use the Help key to see the controls' descriptions.
 
153
Run "make install" to install everything under $OPENWINHOME.  You will probably
 
154
need to be root to do this.
 
155
 
 
156
<p>
 
157
Once all that's done, you're ready to rock and roll (or jazz, or...)
 
158
 
 
159
<p>
 
160
<hr>
 
161
<a href="index.html">To the WorkMan home page</a>
 
162
 
 
163
<h5>Last update: 04 Jun 1995</h5>
 
164
</body>
 
165
</html>