← Back to branch summary

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

« back to all changes in this revision

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

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