← Back to branch summary

~ubuntu-branches/ubuntu/precise/libisoburn/precise

« back to all changes in this revision

Viewing changes to doc/comments

  • Committer: Bazaar Package Importer
  • Author(s): George Danchev
  • Date: 2011-05-26 16:21:32 UTC
  • mfrom: (9.1.12 sid)
  • Revision ID: james.westby@ubuntu.com-20110526162132-9lzoagfaggnera53
Tags: 1.0.8.pl00-4
* [MA] Improve package descriptions and README.Debian.
* [MA] Migrate to format "3.0 (quilt)" and compatibility 8.
  + debian/control: Drop build-dep on 'cdbs'. Require debhelper (>= 8).
  + debian/rules: Reformulate using 'dh'.
  + debian/libisoburn{1,-dev,-doc}.docs: New files.
  + debian/xorriso.docs: Addition of upstream documents.
* [GD] Make sure doxygen documentaton (doc package) is not built
       when dpkg-buildpackage -B is called (i.e. autobuilders).
* [GD] Move doxygen, graphviz to Build-Depends-Indep.
* [GD] Add missing copyrights for debian packaging.
* [GD] Standards-Version: 3.9.2 (no changes needed).
* [GD] More package description and README.Debian improvements;
       thanks to Tony Mancill <tmancill@debian.org>.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/comments
10
10
write ISO 9660 filesystems with Rock Ridge extensions. Media can be optical
11
11
media or filesystem objects.
12
12
 
13
 
Our scope is currently Linux 2.4 and 2.6, or FreeBSD .
 
13
Our scope is currently Linux 2.4 and 2.6, or FreeBSD, or OpenSolaris.
14
14
 
15
15
libisoburn is an add-on to libburn and libisofs which coordinates both and
16
16
also allows to grow ISO-9660 filesystem images on multi-session media as well
21
21
manipulates and writes ISO 9660 filesystem images with Rock Ridge extensions.
22
22
Manipulation is not only adding or overwriting of files but also deletion,
23
23
renaming, and attribute changing. An incremental backup feature is provided.
24
 
See xorriso/README for more
 
24
The xorriso features are accessible via built-in command interpreters and
 
25
via a C language API.
 
26
 
25
27
 
26
28
SONAME:
27
29
libisoburn.so.1 (since 0.1.0, February 2008).
32
34
Our build system is based on autotools.
33
35
User experience tells us that you will need at least autotools version 1.7.
34
36
 
35
 
To build libisoburn go into its toplevel directory and execute
 
37
To build libisoburn go into its toplevel directory and execute:
36
38
 
37
39
-  ./bootstrap  (needed if you downloaded from SVN)
38
40
 
40
42
 
41
43
-  make
42
44
 
43
 
To make the libraries accessible for running resp. developing applications 
 
45
To make the library and the xorriso application accessible for running resp.
 
46
software development:
44
47
 
45
48
-  make install
46
49
 
47
 
Read libisoburn/libisoburn.h for a description of the API.
48
 
See also README, xorriso/README, and the man page xorriso/xorriso.1 which
49
 
gives an idea of the capabilities provided by Libburnia.
50
 
 
 
50
 
 
51
For direct use as command line tool use the xorriso binary which among many
 
52
other features provides a mkisofs emulation via command "-as mkisofs".
 
53
See man page xorriso/xorriso.1 or GNU info document xorriso/xorriso.info.
 
54
 
 
55
 
 
56
If you want to link an own application with libisoburn, you have
 
57
two alternative APIs for choice:
 
58
 
 
59
-  libisoburn, together with libburn and libisofs.
 
60
 
 
61
-  xorriso, a complete representation of xorriso command line options.
 
62
   It encapsulates the three lower level libraries.
 
63
   Calls of both API families shall not be mixed.
 
64
 
 
65
For a description of the lbisoburn API read libisoburn/libisoburn.h
 
66
See file README for download and installation of a release tarball.
51
67
You will also have to install and understand the two libraries of the 
52
68
Libburnia project which provide fundamental services:
53
69
libburn is the library by which preformatted data get onto optical media.
55
71
libisofs is the library to handle ISO 9660 filesystems with Rock Ridge 
56
72
extensions. Its API is described in libisofs/libisofs.h .
57
73
 
 
74
For xorriso features see its man page xorriso/xorriso.1 or
 
75
its GNU info document xorriso/xorriso.info.
 
76
For the corresponding C language API see libisoburn/xorriso.h (resp.
 
77
xorriso/xorriso.h in the build directory).
 
78
The implementation this API is part of libisoburn.
 
79
The xorriso command line tool gets installed as dynamically linked
 
80
binary together with libisoburn.
 
81
 
 
82
There is also a statically linked release named GNU xorriso.
 
83
See xorriso/README_gnu_xorriso for its download and installation.
 
84
 
58
85
*/