INSTALL 6.82 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
Installation of the dvdisaster source code distribution
=======================================================
[don't edit - generated from documentation/install.template]

Contents

1. Required tools and libraries
1.1 C compiler, make and other build tools
1.2 Gtk+ and localozation support

2. Operating system specific issues
12 13 14 15
2.1 FreeBSD
2.1.1 Required packages
2.2 NetBSD
2.2.1 Required packages
16 17 18 19 20 21 22 23 24 25

3. Compiling the source code
3.1 Unpacking the source code archive
3.2 Configuring the package
3.3 Compiling the package

4. Installation
4.1 Installation of the program
4.2 Removing an installation

26 27 28 29
5 Running the program
5.1 Program documentation
5.2 FreeBSD hints
5.3 NetBSD hints
30 31 32 33 34 35 36 37 38 39 40

=======================================================

1. Required tools and libraries
===============================

1.1 C compiler, make and other build tools
------------------------------------------

dvdisaster requires the usual GNU development tools for compiling 
C programs. You must have gcc, GNU make, the bash shell and the
41 42 43 44
GNU fileutils and textutils packages installed.
Using other compilers and tools is currently not tested,
recommended or supported in any way. Patches for them will
not be accepted.
45 46 47 48 49 50

FreeBSD, Linux and NetBSD typically come with suitable packages on 
their installation media. Sometimes these packages are not installed
completely by default; you may need to install their development versions
also. The additional packages are usually suffixed with "-devel" or "-dev".

51 52 53 54
See Section 3.2 for information on configuring the build process,
and for specifying the compiler.


55 56 57 58 59 60 61 62 63 64
1.2 Gtk+ and localization support
---------------------------------

Depending on your operating system you will also need:

- The gettext library			http://www.gnu.org/software/gettext/
- The pkgconfig tool			http://www.freedesktop.org/software/pkgconfig/releases
- The GTK+ library version 2.2 or better,    http://www.gtk.org
  including all auxiliary libraries.

65
Again, the supported Unices should have suitable packages on their distribution media.
66 67 68 69 70


2. Operating system specific issues
===================================

71
2.1 FreeBSD
72 73
-----------

74
2.1.1 Required packages
75

76 77
For your convenience, building dvdisaster required
the following packages under FreeBSD 10.1:
78

79 80 81 82 83 84
# pkg install bash
# pkg install gmake
# pkg install gettext
# pkg install gcc
# pkg install pkgconf
# pkg install gtk2
85

86 87
2.2 NetBSD
----------
88

89
2.2.1 Required packages
90

91 92
For your convenience, building dvdisaster required
the following packages under NetBSD 9.0:
93

94 95 96 97
# pkg_add bash
# pkg_add gmake
# pkg_add pkg-config
# pkg_add gtk2+
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113


3. Compiling the source code
============================

It is recommended to compile the source code as a normal
user, not root. In the following instructions, user@host>
denotes the shell prompt.

3.1 Unpacking the source code archive
-------------------------------------

Please change into a directory which is writeable
for you and unpack the source code archive:

user@host> cd /var/tmp
114
user@host> tar xjf dvdisaster-0.79.6.tar.bz2
115 116 117

Then change into the newly created directory:

118
user@host> cd /var/tmp/dvdisaster-0.79.6
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137

3.2. Configuring the package
----------------------------

Please note that the dvdisaster configure script is not 
generated by GNU autoconf, but should behave in a similar way.

Call the configuration script in the usual way:

user@host> ./configure

The script will possibly print some errors about missing libraries.
Type "configure --help" to learn about pointing configure 
to the correct path of already installed libraries.

The "--help" option will also give information about some
options which are useful if you plan to install the package
to a certain location.

138
Please note that the --buildroot=DIR option is mainly useful for
139 140 141
package maintainers, but will mess up things when trying a direct
install via "make install".

142 143 144 145 146 147 148 149 150 151 152
If your gcc compiler resides in an unusual place, specify it
by setting the CC environment variable for the ./configure
script. Example (may be helpful for FreeBSD):

CC=/usr/local/bin/gcc48 ./configure

Please note that changing CC at a later time, e.g. when doing
the make step, has no effect.

After ./configure has been run, do a "make show" to review
the settings obtained by the configuration.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176

3.3 Compiling the package
-------------------------

When the configuration script finishes without error messages,
compile the source code into the executable program:

user@host> gmake

On some systems, GNU make must be invoked as "make".

Invoke the program for a quick test:

user@linux> ./dvdisaster

After a short moment the main window should open an the program
is ready for use. Working with the program from the current 
directory (e.g. without installation) is okay.


4. Installation
===============

4.1 Installation of the program
177
-------------------------------
178 179 180 181 182 183 184 185 186 187 188 189

To install the program and documentation permanently
on your system, become root and do:

root@host# gmake install

Before doing the install, please review the output of the "configure" script
or type "gmake show" to learn about the target directories of the installation.
Enter "bash configure --help" to get information on changing the installation
paths.

4.2. Removing an installation
190
-----------------------------
191 192 193 194 195 196 197 198 199 200 201

During the installation process a shell script is created
which can be used to remove dvdisaster from your system:

root@host# dvdisaster-uninstall.sh

In order to remove the source code distribution,
please remove the directory you have created as described
in section 3.1:

user@host> cd /var/tmp
202
user@host> rm -rf dvdisaster-0.79.6
203

204 205
5. Running the program
======================
206

207 208
5.1 Program documentation
-------------------------
209 210

The online documentation is located in the
211
sub directory documentation/manual.pdf
212 213 214
You can also press the respective toolbar button 
in dvdisaster to view the online docs.

215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
5.2 FreeBSD hints
-----------------

Running as an unpriviledged user

If you want to run dvdisaster as an unpriviledged
user (which is recommended), make sure that the
respective user is member of the "operator" group
and that he has read _and_ write permission on the
optical drive, e.g. /dev/pass1.

Use camcontrol to find out which passthrough device
is assigned to your drive:

root@freebsd# camcontrol devlist
230
<NAME OF YOUR DRIVE>  at scbus1 target 0 lun 0 (pass0,cd0)
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254


Avoid copy-on-write filesystems

dvdisaster assumes that ISO images are laid out
sequentially on the hard disk, and that it can
rewrite sectors in place. Therefore avoid
processing images on ZFS volumes, as reading and
recovering defective images may lead to serious
fragmentation and performance hits.


5.3 NetBSD hints
----------------

Running as an unpriviledged user

If you want to run dvdisaster as an unpriviledged
user (which is recommended), make sure that the
respective user is member of the "operator" group
and that he has read _and_ write permission on the
optical drive, e.g. /dev/rcd0d.


255 256 257 258

Enjoy using dvdisaster!