Completing documentation
This commit is contained in:
parent
44ddb22abe
commit
63fa76fd82
280
libisoburn/trunk/COPYING
Normal file
280
libisoburn/trunk/COPYING
Normal file
@ -0,0 +1,280 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
||||
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Library General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
22
libisoburn/trunk/COPYRIGHT
Normal file
22
libisoburn/trunk/COPYRIGHT
Normal file
@ -0,0 +1,22 @@
|
||||
Vreixo Formoso <metalpain2002@yahoo.es>
|
||||
Thomas Schmitt <scdbackup@gmx.net>
|
||||
libisoburn is Copyright (C) 2007-2008 Vreixo Formoso, Thomas Schmitt
|
||||
xorriso is Copyright (C) 2007-2008 Thomas Schmitt
|
||||
libisofs (if included) is Copyright (C) 2007-2008 Vreixo Formoso
|
||||
libburn (if included) is Copyright (C) 2002-2006 Derek Foreman, Ben Jansens
|
||||
and Copyright (C) 2006-2008 Mario Danic, Thomas Schmitt
|
||||
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
237
libisoburn/trunk/INSTALL
Normal file
237
libisoburn/trunk/INSTALL
Normal file
@ -0,0 +1,237 @@
|
||||
|
||||
See file README for libisoburn and xorriso specific installation instructions.
|
||||
This file here is rather a manual for advanced usage of ./configure
|
||||
|
||||
-------------------------------------------------------------------
|
||||
|
||||
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
|
||||
2006 Free Software Foundation, Inc.
|
||||
|
||||
This file is free documentation; the Free Software Foundation gives
|
||||
unlimited permission to copy, distribute and modify it.
|
||||
|
||||
Basic Installation
|
||||
==================
|
||||
|
||||
Briefly, the shell commands `./configure; make; make install' should
|
||||
configure, build, and install this package. The following
|
||||
more-detailed instructions are generic; see the `README' file for
|
||||
instructions specific to this package.
|
||||
|
||||
The `configure' shell script attempts to guess correct values for
|
||||
various system-dependent variables used during compilation. It uses
|
||||
those values to create a `Makefile' in each directory of the package.
|
||||
It may also create one or more `.h' files containing system-dependent
|
||||
definitions. Finally, it creates a shell script `config.status' that
|
||||
you can run in the future to recreate the current configuration, and a
|
||||
file `config.log' containing compiler output (useful mainly for
|
||||
debugging `configure').
|
||||
|
||||
It can also use an optional file (typically called `config.cache'
|
||||
and enabled with `--cache-file=config.cache' or simply `-C') that saves
|
||||
the results of its tests to speed up reconfiguring. Caching is
|
||||
disabled by default to prevent problems with accidental use of stale
|
||||
cache files.
|
||||
|
||||
If you need to do unusual things to compile the package, please try
|
||||
to figure out how `configure' could check whether to do them, and mail
|
||||
diffs or instructions to the address given in the `README' so they can
|
||||
be considered for the next release. If you are using the cache, and at
|
||||
some point `config.cache' contains results you don't want to keep, you
|
||||
may remove or edit it.
|
||||
|
||||
The file `configure.ac' (or `configure.in') is used to create
|
||||
`configure' by a program called `autoconf'. You need `configure.ac' if
|
||||
you want to change it or regenerate `configure' using a newer version
|
||||
of `autoconf'.
|
||||
|
||||
The simplest way to compile this package is:
|
||||
|
||||
1. `cd' to the directory containing the package's source code and type
|
||||
`./configure' to configure the package for your system.
|
||||
|
||||
Running `configure' might take a while. While running, it prints
|
||||
some messages telling which features it is checking for.
|
||||
|
||||
2. Type `make' to compile the package.
|
||||
|
||||
3. Optionally, type `make check' to run any self-tests that come with
|
||||
the package.
|
||||
|
||||
4. Type `make install' to install the programs and any data files and
|
||||
documentation.
|
||||
|
||||
5. You can remove the program binaries and object files from the
|
||||
source code directory by typing `make clean'. To also remove the
|
||||
files that `configure' created (so you can compile the package for
|
||||
a different kind of computer), type `make distclean'. There is
|
||||
also a `make maintainer-clean' target, but that is intended mainly
|
||||
for the package's developers. If you use it, you may have to get
|
||||
all sorts of other programs in order to regenerate files that came
|
||||
with the distribution.
|
||||
|
||||
Compilers and Options
|
||||
=====================
|
||||
|
||||
Some systems require unusual options for compilation or linking that the
|
||||
`configure' script does not know about. Run `./configure --help' for
|
||||
details on some of the pertinent environment variables.
|
||||
|
||||
You can give `configure' initial values for configuration parameters
|
||||
by setting variables in the command line or in the environment. Here
|
||||
is an example:
|
||||
|
||||
./configure CC=c99 CFLAGS=-g LIBS=-lposix
|
||||
|
||||
*Note Defining Variables::, for more details.
|
||||
|
||||
Compiling For Multiple Architectures
|
||||
====================================
|
||||
|
||||
You can compile the package for more than one kind of computer at the
|
||||
same time, by placing the object files for each architecture in their
|
||||
own directory. To do this, you can use GNU `make'. `cd' to the
|
||||
directory where you want the object files and executables to go and run
|
||||
the `configure' script. `configure' automatically checks for the
|
||||
source code in the directory that `configure' is in and in `..'.
|
||||
|
||||
With a non-GNU `make', it is safer to compile the package for one
|
||||
architecture at a time in the source code directory. After you have
|
||||
installed the package for one architecture, use `make distclean' before
|
||||
reconfiguring for another architecture.
|
||||
|
||||
Installation Names
|
||||
==================
|
||||
|
||||
By default, `make install' installs the package's commands under
|
||||
`/usr/local/bin', include files under `/usr/local/include', etc. You
|
||||
can specify an installation prefix other than `/usr/local' by giving
|
||||
`configure' the option `--prefix=PREFIX'.
|
||||
|
||||
You can specify separate installation prefixes for
|
||||
architecture-specific files and architecture-independent files. If you
|
||||
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
|
||||
PREFIX as the prefix for installing programs and libraries.
|
||||
Documentation and other data files still use the regular prefix.
|
||||
|
||||
In addition, if you use an unusual directory layout you can give
|
||||
options like `--bindir=DIR' to specify different values for particular
|
||||
kinds of files. Run `configure --help' for a list of the directories
|
||||
you can set and what kinds of files go in them.
|
||||
|
||||
If the package supports it, you can cause programs to be installed
|
||||
with an extra prefix or suffix on their names by giving `configure' the
|
||||
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
|
||||
|
||||
Optional Features
|
||||
=================
|
||||
|
||||
Some packages pay attention to `--enable-FEATURE' options to
|
||||
`configure', where FEATURE indicates an optional part of the package.
|
||||
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
|
||||
is something like `gnu-as' or `x' (for the X Window System). The
|
||||
`README' should mention any `--enable-' and `--with-' options that the
|
||||
package recognizes.
|
||||
|
||||
For packages that use the X Window System, `configure' can usually
|
||||
find the X include and library files automatically, but if it doesn't,
|
||||
you can use the `configure' options `--x-includes=DIR' and
|
||||
`--x-libraries=DIR' to specify their locations.
|
||||
|
||||
Specifying the System Type
|
||||
==========================
|
||||
|
||||
There may be some features `configure' cannot figure out automatically,
|
||||
but needs to determine by the type of machine the package will run on.
|
||||
Usually, assuming the package is built to be run on the _same_
|
||||
architectures, `configure' can figure that out, but if it prints a
|
||||
message saying it cannot guess the machine type, give it the
|
||||
`--build=TYPE' option. TYPE can either be a short name for the system
|
||||
type, such as `sun4', or a canonical name which has the form:
|
||||
|
||||
CPU-COMPANY-SYSTEM
|
||||
|
||||
where SYSTEM can have one of these forms:
|
||||
|
||||
OS KERNEL-OS
|
||||
|
||||
See the file `config.sub' for the possible values of each field. If
|
||||
`config.sub' isn't included in this package, then this package doesn't
|
||||
need to know the machine type.
|
||||
|
||||
If you are _building_ compiler tools for cross-compiling, you should
|
||||
use the option `--target=TYPE' to select the type of system they will
|
||||
produce code for.
|
||||
|
||||
If you want to _use_ a cross compiler, that generates code for a
|
||||
platform different from the build platform, you should specify the
|
||||
"host" platform (i.e., that on which the generated programs will
|
||||
eventually be run) with `--host=TYPE'.
|
||||
|
||||
Sharing Defaults
|
||||
================
|
||||
|
||||
If you want to set default values for `configure' scripts to share, you
|
||||
can create a site shell script called `config.site' that gives default
|
||||
values for variables like `CC', `cache_file', and `prefix'.
|
||||
`configure' looks for `PREFIX/share/config.site' if it exists, then
|
||||
`PREFIX/etc/config.site' if it exists. Or, you can set the
|
||||
`CONFIG_SITE' environment variable to the location of the site script.
|
||||
A warning: not all `configure' scripts look for a site script.
|
||||
|
||||
Defining Variables
|
||||
==================
|
||||
|
||||
Variables not defined in a site shell script can be set in the
|
||||
environment passed to `configure'. However, some packages may run
|
||||
configure again during the build, and the customized values of these
|
||||
variables may be lost. In order to avoid this problem, you should set
|
||||
them in the `configure' command line, using `VAR=value'. For example:
|
||||
|
||||
./configure CC=/usr/local2/bin/gcc
|
||||
|
||||
causes the specified `gcc' to be used as the C compiler (unless it is
|
||||
overridden in the site shell script).
|
||||
|
||||
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
|
||||
an Autoconf bug. Until the bug is fixed you can use this workaround:
|
||||
|
||||
CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
|
||||
|
||||
`configure' Invocation
|
||||
======================
|
||||
|
||||
`configure' recognizes the following options to control how it operates.
|
||||
|
||||
`--help'
|
||||
`-h'
|
||||
Print a summary of the options to `configure', and exit.
|
||||
|
||||
`--version'
|
||||
`-V'
|
||||
Print the version of Autoconf used to generate the `configure'
|
||||
script, and exit.
|
||||
|
||||
`--cache-file=FILE'
|
||||
Enable the cache: use and save the results of the tests in FILE,
|
||||
traditionally `config.cache'. FILE defaults to `/dev/null' to
|
||||
disable caching.
|
||||
|
||||
`--config-cache'
|
||||
`-C'
|
||||
Alias for `--cache-file=config.cache'.
|
||||
|
||||
`--quiet'
|
||||
`--silent'
|
||||
`-q'
|
||||
Do not print messages saying which checks are being made. To
|
||||
suppress all normal output, redirect it to `/dev/null' (any error
|
||||
messages will still be shown).
|
||||
|
||||
`--srcdir=DIR'
|
||||
Look for the package's source code in directory DIR. Usually
|
||||
`configure' can determine that directory automatically.
|
||||
|
||||
`configure' also accepts some other, not widely useful, options. Run
|
||||
`configure --help' for more details.
|
||||
|
147
libisoburn/trunk/README
Normal file
147
libisoburn/trunk/README
Normal file
@ -0,0 +1,147 @@
|
||||
------------------------------------------------------------------------------
|
||||
libburnia-project.org
|
||||
------------------------------------------------------------------------------
|
||||
libisoburn. By Vreixo Formoso <metalpain2002@yahoo.es>
|
||||
and Thomas Schmitt <scdbackup@gmx.net>
|
||||
Integrated sub project of libburnia-project.org.
|
||||
Copyright (C) 2006-2008 Vreixo Formoso, Thomas Schmitt.
|
||||
Provided under GPL version 2.
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
libisoburn is a frontend for libraries libburn and libisofs which enables
|
||||
creation and expansion of ISO-9660 filesystems on all CD/DVD media supported
|
||||
by libburn. This includes media like DVD+RW, which do not support multi-session
|
||||
management on media level and even plain disk files or block devices.
|
||||
|
||||
The price for that is thorough specialization on data files in ISO-9660
|
||||
filesystem images. So libisoburn is not suitable for audio (CD-DA) or any
|
||||
other CD layout which does not entirely consist of ISO-9660 sessions.
|
||||
|
||||
Currently it is only supported on Linux with kernels >= 2.4.
|
||||
|
||||
By using this software you agree to the disclaimer at the end of this text:
|
||||
"... without even the implied warranty ..."
|
||||
|
||||
|
||||
Compilation, First Glimpse, Installation
|
||||
|
||||
Dynamic library and compile time header requirements for libisoburn-0.1.0 :
|
||||
- libburn.so.4 , version libburn-0.4.2 or higher
|
||||
- libisofs.so.6 , version libisofs-0.6.2 or higher
|
||||
libisoburn and xorriso will not start with libraries which are older than their
|
||||
headers seen at compile time. So compile in the oldest possible installation
|
||||
setup unless you have reason to enforce a newer bug fix level.
|
||||
|
||||
Obtain libisoburn-0.1.0.tar.gz, take it to a directory of your choice and do:
|
||||
|
||||
tar xzf libisoburn-0.1.0.tar.gz
|
||||
cd libisoburn-0.1.0
|
||||
|
||||
Within that directory execute:
|
||||
|
||||
./configure --prefix=/usr
|
||||
make
|
||||
|
||||
Then become superuser and execute
|
||||
make install
|
||||
which will make available libisoburn.so.1 .
|
||||
|
||||
For the API concepts and calls see
|
||||
./libisoburn/libisoburn.h
|
||||
as well as
|
||||
/usr/lib/libisofs/libisofs.h
|
||||
/usr/lib/libburn/libburn.h
|
||||
|
||||
|
||||
libisoburn includes a command line and dialog application named xorriso,
|
||||
which offers a substantial part of libisoburn features to shell scripts and
|
||||
users.
|
||||
After installation its documentation is available via
|
||||
man xorriso
|
||||
|
||||
|
||||
|
||||
Drives and Disk File Objects
|
||||
|
||||
The user of libisoburn applications needs rw-permission for the CD/DVD burner
|
||||
devices which shall be used.
|
||||
A list of rw-accessible drives can be obtained by
|
||||
xorriso -devices
|
||||
resp. by libburn API call
|
||||
burn_drive_scan()
|
||||
|
||||
|
||||
A possible source of problems are hald or other automounters.
|
||||
If you can spot a process "hald-addon-storage" with the address of
|
||||
your desired drive, then consider to kill it.
|
||||
|
||||
If you cannot get rid of the automounter that easily, try whether it helps
|
||||
to always load the drive tray manually before starting a write run of
|
||||
xorriso. Wait until the drive light is off.
|
||||
Better try to unmount an eventually mounted media before a write run.
|
||||
|
||||
|
||||
Besides true optical drives, libisoburn can also address disk files as input or
|
||||
output drives. The addresses of the disk files have to be preceded by "stdio:".
|
||||
Like:
|
||||
"stdio:/tmp/pseudo_drive"
|
||||
|
||||
|
||||
Testing
|
||||
|
||||
We are quite sure that libisofs produces accurate representations of the disk
|
||||
files. This opinion is founded on a lot of test burns and checks by a little
|
||||
test program which compares files from the mounted image with the orignals
|
||||
on disk. It uses the normal POSIX filesystem calls, i.e. no libburnia stuff.
|
||||
|
||||
This program is not installed systemwide but stays in the installation
|
||||
directory of the xorriso tarball as test/compare_file . Usually it is
|
||||
run as -exec payload of a find command. It demands at least three arguments:
|
||||
The path of the first file to compare, the prefix1 to be cut off from path
|
||||
and the prefix2 which gets prepended afterwards to obtain the path of the
|
||||
second file to compare.
|
||||
As further argument there can be -no_ctime which suppresses the comparison
|
||||
of ctime date stamps.
|
||||
The exit value is 0 if no difference was detected, non-0 else.
|
||||
|
||||
Example: After
|
||||
xorriso ... -pathspecs on -add /=/original/dir --
|
||||
mount /media/dvd
|
||||
cd test
|
||||
compare tree /media/dvd with tree /original/dir :
|
||||
find /original/dir -exec ./compare_file '{}' /original/dir /media/dvd ';' \
|
||||
| less
|
||||
and vice versa:
|
||||
find /media/dvd -exec ./compare_file '{}' /media/dvd /original/dir ';' \
|
||||
| less
|
||||
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License version 2 as
|
||||
published by the Free Software Foundation.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
Based on and sub project of:
|
||||
libburnia-project.org
|
||||
By Mario Danic <mario.danic@gmail.com>,
|
||||
Vreixo Formoso <metalpain2002@yahoo.es>
|
||||
Thomas Schmitt <scdbackup@gmx.net>
|
||||
Copyright (C) 2006-2008 Mario Danic, Vreixo Formoso, Thomas Schmitt.
|
||||
|
||||
libburnia-project.org is inspired by and in other components still containing
|
||||
parts of old
|
||||
Libburn. By Derek Foreman <derek@signalmarketing.com> and
|
||||
Ben Jansens <xor@orodu.net>
|
||||
Copyright (C) 2002-2006 Derek Foreman and Ben Jansens
|
||||
|
@ -17,6 +17,15 @@ The price for that is thorough specialization on data files in ISO-9660
|
||||
filesystem images. So libisoburn is not suitable for audio (CD-DA) or any
|
||||
other CD layout which does not entirely consist of ISO-9660 sessions.
|
||||
|
||||
|
||||
Connector functions
|
||||
|
||||
libisofs and libburn do not depend on each other but share some interfaces
|
||||
by which they can cooperate.
|
||||
libisoburn establishes the connection between both modules by creating the
|
||||
necessary interface objects and attaching them to the right places.
|
||||
|
||||
|
||||
Wrapper functions
|
||||
|
||||
The priciple of this frontend is that you may use any call of libisofs or
|
||||
@ -33,10 +42,11 @@ are appropriate for particular target drives and media states.
|
||||
To learn about them you have to read both API descriptions: the one of
|
||||
the wrapper and the one of the underlying libburn or libisofs call.
|
||||
|
||||
Usage model
|
||||
Macros BURN_* and functions burn_*() are documented in <libburn/libburn.h>
|
||||
Macros ISO_* and functions iso_*() are documented in <libisofs/libisofs.h>
|
||||
|
||||
Additionally there are own libisoburn API calls which allow to implement the
|
||||
following usage model (see also man xorriso for a end user's view):
|
||||
|
||||
Usage model
|
||||
|
||||
There may be an input drive and an output drive. Either of them may be missing
|
||||
with the consequence that no reading resp. writing is possible.
|
||||
@ -64,10 +74,11 @@ settings. The application does not have to analyze media state and write
|
||||
job parameters. It rather states its desires which libisoburn tries to
|
||||
fulfill, or else will refuse to start the write run.
|
||||
|
||||
|
||||
Setup for Growing or Modifying
|
||||
|
||||
There are two alternative API calls for performing the setup for two
|
||||
alternative image generation strategies.
|
||||
The connector function family offers two alternative API calls for performing
|
||||
the setup for two alternative image generation strategies.
|
||||
|
||||
Growing:
|
||||
If input and output drive is the same, then isoburn_prepare_disc() is to
|
||||
@ -98,7 +109,7 @@ At some time, the output drive will be BURN_DRIVE_IDLE indicating that
|
||||
writing has ended.
|
||||
One should inquire isoburn_drive_wrote_well() to learn about overall success.
|
||||
|
||||
Finally one must call isoburn_activate_session() which will finalize any
|
||||
Finally one must call isoburn_activate_session() which will complete any
|
||||
eventual multi-session emulation.
|
||||
|
||||
*/
|
||||
@ -109,8 +120,9 @@ eventual multi-session emulation.
|
||||
|
||||
/** Initialize libisoburn, libisofs and libburn.
|
||||
Wrapper for : iso_init() and burn_initialize()
|
||||
@param reason A character array for eventual messages (e.g. with errors)
|
||||
@param flag Bitfield for control purposes (unused yet, submit 0)
|
||||
@since 0.1.0
|
||||
@param msg A character array for eventual messages (e.g. with errors)
|
||||
@param flag Bitfield for control purposes (unused yet, submit 0)
|
||||
@return 1 indicates success, 0 is failure
|
||||
*/
|
||||
int isoburn_initialize(char msg[1024], int flag);
|
||||
@ -126,6 +138,7 @@ int isoburn_initialize(char msg[1024], int flag);
|
||||
isoburn_header_version_minor,
|
||||
isoburn_header_version_micro, 0))
|
||||
...refuse to start the program with this dynamic library version...
|
||||
@since 0.1.0
|
||||
@param major obtained at build time
|
||||
@param minor obtained at build time
|
||||
@param micro obtained at build time
|
||||
@ -143,6 +156,7 @@ int isoburn_is_compatible(int major, int minor, int micro, int flag);
|
||||
i.e. possibly not before run time.
|
||||
Better do not base the fundamental compatibility decision of an application
|
||||
on these numbers. For a reliable check use isoburn_is_compatible().
|
||||
@since 0.1.0
|
||||
@param major The maturity version (0 for now, as we are still learning)
|
||||
@param minor The development goal version.
|
||||
@param micro The development step version. This has an additional meaning:
|
||||
@ -156,11 +170,14 @@ int isoburn_is_compatible(int major, int minor, int micro, int flag);
|
||||
So micro revisions {1,3,5,7,9} should never be used for
|
||||
dynamic linking unless the proper library match can be
|
||||
guaranteed by external circumstances.
|
||||
@return 1 success, <=0 might in future become an error indication
|
||||
*/
|
||||
void isoburn_version(int *major, int *minor, int *micro);
|
||||
|
||||
|
||||
/** The minimum version of libisofs to be used with this version of libisoburn
|
||||
at compile time.
|
||||
@since 0.1.0
|
||||
*/
|
||||
#define isoburn_libisofs_req_major 0
|
||||
#define isoburn_libisofs_req_minor 6
|
||||
@ -168,6 +185,7 @@ void isoburn_version(int *major, int *minor, int *micro);
|
||||
|
||||
/** The minimum version of libburn to be used with this version of libisoburn
|
||||
at compile time.
|
||||
@since 0.1.0
|
||||
*/
|
||||
#define isoburn_libburn_req_major 0
|
||||
#define isoburn_libburn_req_minor 4
|
||||
@ -178,6 +196,11 @@ void isoburn_version(int *major, int *minor, int *micro);
|
||||
at runtime. This is checked already in isoburn_initialize() which will
|
||||
refuse on outdated version. So this call is for information purposes after
|
||||
successful startup only.
|
||||
@since 0.1.0
|
||||
@param major isoburn_libisofs_req_major as seen at build time
|
||||
@param minor as seen at build time
|
||||
@param micro as seen at build time
|
||||
@return 1 success, <=0 might in future become an error indication
|
||||
*/
|
||||
int isoburn_libisofs_req(int *major, int *minor, int *micro);
|
||||
|
||||
@ -186,14 +209,19 @@ int isoburn_libisofs_req(int *major, int *minor, int *micro);
|
||||
at runtime. This is checked already in isoburn_initialize() which will
|
||||
refuse on outdated version. So this call is for information purposes after
|
||||
successful startup only.
|
||||
@since 0.1.0
|
||||
@param major isoburn_libburn_req_major as seen at build time
|
||||
@param minor as seen at build time
|
||||
@param micro as seen at build time
|
||||
@return 1 success, <=0 might in future become an error indication
|
||||
*/
|
||||
int isoburn_libburn_req(int *major, int *minor, int *micro);
|
||||
|
||||
|
||||
|
||||
/** These three release version numbers tell the revision of this header file
|
||||
and of the API it describes. They are memorized by applications at build
|
||||
time.
|
||||
@since 0.1.0
|
||||
*/
|
||||
#define isoburn_header_version_major 0
|
||||
#define isoburn_header_version_minor 0
|
||||
@ -254,6 +282,15 @@ see libisoburn/burn_wrap.c : isoburn_initialize()
|
||||
/** Aquire a target drive by its filesystem path resp. libburn persistent
|
||||
address.
|
||||
Wrapper for: burn_drive_scan_and_grab()
|
||||
@since 0.1.0
|
||||
@param drive_infos On success returns a one element array with the drive
|
||||
(cdrom/burner). Thus use with driveno 0 only. On failure
|
||||
the array has no valid elements at all.
|
||||
The returned array should be freed via burn_drive_info_free()
|
||||
when the drive is no longer needed.
|
||||
@param adr The persistent address of the desired drive.
|
||||
@param load 1 attempt to load the disc tray. 0 no attempt,rather failure.
|
||||
@return 1 = success , 0 = drive not found , <0 = other error
|
||||
*/
|
||||
int isoburn_drive_scan_and_grab(struct burn_drive_info *drive_infos[],
|
||||
char* adr, int load);
|
||||
@ -262,6 +299,10 @@ int isoburn_drive_scan_and_grab(struct burn_drive_info *drive_infos[],
|
||||
/** Aquire a drive from the burn_drive_info[] array which was obtained by
|
||||
a previous call of burn_drive_scan().
|
||||
Wrapper for: burn_drive_grab()
|
||||
@since 0.1.0
|
||||
@param drive The drive to grab. E.g. drive_infos[1].drive .
|
||||
@param load 1 attempt to load the disc tray. 0 no attempt, rather failure.
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
int isoburn_drive_grab(struct burn_drive *drive, int load);
|
||||
|
||||
@ -270,12 +311,19 @@ int isoburn_drive_grab(struct burn_drive *drive, int load);
|
||||
with multi-session media. Emulated states with random access media are
|
||||
BURN_DISC_BLANK and BURN_DISC_APPENDABLE.
|
||||
Wrapper for: burn_disc_get_status()
|
||||
@since 0.1.0
|
||||
@param drive The drive to inquire.
|
||||
@return The status of the drive, or what kind of disc is in it.
|
||||
Note: BURN_DISC_UNGRABBED indicates wrong API usage
|
||||
*/
|
||||
enum burn_disc_status isoburn_disc_get_status(struct burn_drive *drive);
|
||||
|
||||
|
||||
/** Tells whether the media can be treated by isoburn_disc_erase().
|
||||
Wrapper for: burn_disc_erasable()
|
||||
@since 0.1.0
|
||||
@param drive The drive to inquire.
|
||||
@return 0=not erasable , else erasable
|
||||
*/
|
||||
int isoburn_disc_erasable(struct burn_drive *d);
|
||||
|
||||
@ -285,6 +333,10 @@ int isoburn_disc_erasable(struct burn_drive *d);
|
||||
filesystem will get invalidated by altering its start blocks on media.
|
||||
In case of success, the media is in status BURN_DISC_BLANK afterwards.
|
||||
Wrapper for: burn_disc_erase()
|
||||
@since 0.1.0
|
||||
@param drive The drive with the media to erase.
|
||||
@param fast 1=fast erase, 0=thorough erase
|
||||
With DVD-RW, fast erase yields media incapable of multi-session.
|
||||
*/
|
||||
void isoburn_disc_erase(struct burn_drive *drive, int fast);
|
||||
|
||||
@ -304,13 +356,18 @@ void isoburn_disc_erase(struct burn_drive *drive, int fast);
|
||||
struct isoburn_read_opts;
|
||||
|
||||
/** Produces a set of image read options, initialized with default values.
|
||||
@since 0.1.0
|
||||
@param o the newly created option set object
|
||||
@param flag Bitfield for control purposes. Submit 0 for now.
|
||||
@return 1=ok , <0 = failure
|
||||
*/
|
||||
int isoburn_ropt_new(struct isoburn_read_opts **o, int flag);
|
||||
|
||||
|
||||
/** Deletes an option set which was created by isoburn_ropt_new().
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param flag Bitfield for control purposes. Submit 0 for now.
|
||||
@return 1= **o destroyed , 0= *o was already NULL (harmless)
|
||||
*/
|
||||
int isoburn_ropt_destroy(struct isoburn_read_opts **o, int flag);
|
||||
@ -319,6 +376,7 @@ int isoburn_ropt_destroy(struct isoburn_read_opts **o, int flag);
|
||||
/** Which existing ISO 9660 extensions in the image to read or not to read.
|
||||
Whether to read the content of an existing image at all.
|
||||
The bits can be combined by | resp. inquired by &.
|
||||
@since 0.1.0
|
||||
@param ext Bitfield:
|
||||
bit0= norock
|
||||
Do not read Rock Ridge extensions
|
||||
@ -331,6 +389,7 @@ int isoburn_ropt_destroy(struct isoburn_read_opts **o, int flag);
|
||||
tree is used. If you prefer using Joliet, set this to 1.
|
||||
bit4= pretend_blank
|
||||
Always create empty image.Ignore any image on input drive.
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
#define isoburn_ropt_norock 1
|
||||
#define isoburn_ropt_nojoliet 2
|
||||
@ -342,11 +401,14 @@ int isoburn_ropt_get_extensions(struct isoburn_read_opts *o, int *ext);
|
||||
|
||||
|
||||
/** Default attributes to use if no RockRidge extension gets loaded.
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param uid user id number (see /etc/passwd)
|
||||
@param gid group id number (see /etc/group)
|
||||
@param mode permissions (not file type) as of man 2 stat.
|
||||
With directories, r-permissions will automatically imply
|
||||
x-permissions. See isoburn_ropt_set_default_dirperms() below.
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
int isoburn_ropt_set_default_perms(struct isoburn_read_opts *o,
|
||||
uid_t uid, gid_t gid, mode_t mode);
|
||||
@ -359,6 +421,10 @@ int isoburn_ropt_get_default_perms(struct isoburn_read_opts *o,
|
||||
x-permissions to r-permissions for directories. This call here may
|
||||
be done afterwards to set independend permissions for directories,
|
||||
especially to override the automatically added x-permissions.
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param mode permissions (not file type) as of man 2 stat.
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
int isoburn_ropt_set_default_dirperms(struct isoburn_read_opts *o,
|
||||
mode_t mode);
|
||||
@ -368,10 +434,13 @@ int isoburn_ropt_get_default_dirperms(struct isoburn_read_opts *o,
|
||||
|
||||
|
||||
/** Set the character set for reading RR file names from ISO images.
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param input_charset Set this to NULL to use the default locale charset.
|
||||
For selecting a particular character set, submit its
|
||||
name, e.g. as listed by program iconv -l.
|
||||
Example: "UTF-8".
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
int isoburn_ropt_set_input_charset(struct isoburn_read_opts *o,
|
||||
char *input_charset);
|
||||
@ -383,6 +452,8 @@ int isoburn_ropt_get_input_charset(struct isoburn_read_opts *o,
|
||||
available in the option set.
|
||||
This info can be obtained as bits in parameter has_what. Like:
|
||||
joliet_available = (has_what & isoburn_ropt_has_joliet);
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param size Number of image data blocks, 2048 bytes each.
|
||||
@param has_what Bitfield:
|
||||
bit0= has_rockridge
|
||||
@ -394,6 +465,7 @@ int isoburn_ropt_get_input_charset(struct isoburn_read_opts *o,
|
||||
This is rather exotic.
|
||||
bit3= has_el_torito
|
||||
El-Torito boot record is present
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
#define isoburn_ropt_has_rockridge 1
|
||||
#define isoburn_ropt_has_joliet 2
|
||||
@ -424,28 +496,38 @@ struct isoburn_imgen_opts;
|
||||
|
||||
/** Produces a set of generation and transfer options, initialized with default
|
||||
values.
|
||||
@since 0.1.0
|
||||
@param o the newly created option set object
|
||||
@param flag Bitfield for control purposes. Submit 0 for now.
|
||||
@return 1=ok , <0 = failure
|
||||
*/
|
||||
int isoburn_igopt_new(struct isoburn_imgen_opts **o, int flag);
|
||||
|
||||
|
||||
/** Deletes an option set which was created by isoburn_igopt_new().
|
||||
@since 0.1.0
|
||||
@param o The option set to give up
|
||||
@param flag Bitfield for control purposes. Submit 0 for now.
|
||||
@return 1= **o destroyed , 0= *o was already NULL (harmless)
|
||||
*/
|
||||
int isoburn_igopt_destroy(struct isoburn_imgen_opts **o, int flag);
|
||||
|
||||
|
||||
/** ISO level to write at.
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param level is a term of the ISO 9660 standard. It should be one of:
|
||||
1= filenames restricted to form 8.3
|
||||
2= filenames allowed up to 31 characters
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
int isoburn_igopt_set_level(struct isoburn_imgen_opts *o, int level);
|
||||
int isoburn_igopt_get_level(struct isoburn_imgen_opts *o, int *level);
|
||||
|
||||
|
||||
/** Which extensions to support.
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param ext Bitfield:
|
||||
bit0= rockridge
|
||||
Rock Ridge extensions add POSIX file attributes like
|
||||
@ -456,6 +538,7 @@ int isoburn_igopt_get_level(struct isoburn_imgen_opts *o, int *level);
|
||||
Weaker than RockRidge, but also readable with Linux.
|
||||
bit2= iso1999
|
||||
This is rather exotic. Better do not surprise the readers.
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
#define isoburn_igopt_rockridge 1
|
||||
#define isoburn_igopt_joliet 2
|
||||
@ -465,6 +548,8 @@ int isoburn_igopt_get_extensions(struct isoburn_imgen_opts *o, int *ext);
|
||||
|
||||
/** Relaxed constraints. Setting any of the bits to 1 break the specifications,
|
||||
but it is supposed to work on most moderns systems. Use with caution.
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param relax Bitfield:
|
||||
bit0= omit_version_numbers
|
||||
Omit the version number (";1") at the end of the
|
||||
@ -498,6 +583,7 @@ int isoburn_igopt_get_extensions(struct isoburn_imgen_opts *o, int *ext);
|
||||
bit7= joliet_longer_paths
|
||||
Allow paths in the Joliet tree to have more than
|
||||
240 characters.
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
#define isoburn_igopt_omit_version_numbers 1
|
||||
#define isoburn_igopt_allow_deep_paths 2
|
||||
@ -512,10 +598,13 @@ int isoburn_igopt_get_relaxed(struct isoburn_imgen_opts *o, int *relax);
|
||||
|
||||
|
||||
/** Whether and how files should be sorted.
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param value Bitfield: bit0= sort_files_by_weight
|
||||
files should be sorted based on their weight.
|
||||
Weight is attributed to files in the image
|
||||
by libisofs call iso_node_set_sort_weight().
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
#define isoburn_igopt_sort_files_by_weight 1
|
||||
int isoburn_igopt_set_sort_files(struct isoburn_imgen_opts *o, int value);
|
||||
@ -531,10 +620,13 @@ int isoburn_igopt_get_sort_files(struct isoburn_imgen_opts *o, int *value);
|
||||
With value 2, the attrib. will be changed with the value specified
|
||||
in the corresponding *_mode options. Note that only the permissions
|
||||
are set, the file type remains unchanged.
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param replace_dir_mode whether and how to override directories
|
||||
@param replace_file_mode whether and how to override files of other type
|
||||
@param dir_mode Mode to use on dirs with replace_dir_mode == 2.
|
||||
@param file_mode; Mode to use on files with replace_file_mode == 2.
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
int isoburn_igopt_set_over_mode(struct isoburn_imgen_opts *o,
|
||||
int replace_dir_mode, int replace_file_mode,
|
||||
@ -546,10 +638,13 @@ int isoburn_igopt_get_over_mode(struct isoburn_imgen_opts *o,
|
||||
/** Set the override values values for group id and user id.
|
||||
The rules are like with above overriding of mode values. replace_* controls
|
||||
whether and how. The other two parameters provide values for eventual use.
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param replace_uid whether and how to override user ids
|
||||
@param replace_gid whether and how to override group ids
|
||||
@param uid User id to use with replace_uid == 2.
|
||||
@param gid Group id to use on files with replace_gid == 2.
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
int isoburn_igopt_set_over_ugid(struct isoburn_imgen_opts *o,
|
||||
int replace_uid, int replace_gid,
|
||||
@ -559,10 +654,13 @@ int isoburn_igopt_get_over_ugid(struct isoburn_imgen_opts *o,
|
||||
uid_t *uid, gid_t *gid);
|
||||
|
||||
/** Set the charcter set to use for representing filenames in the image.
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param output_charset Set this to NULL to use the default output charset.
|
||||
For selecting a particular character set, submit its
|
||||
name, e.g. as listed by program iconv -l.
|
||||
Example: "UTF-8".
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
int isoburn_igopt_set_out_charset(struct isoburn_imgen_opts *o,
|
||||
char *output_charset);
|
||||
@ -576,27 +674,36 @@ int isoburn_igopt_get_out_charset(struct isoburn_imgen_opts *o,
|
||||
MMC drive.
|
||||
The size will be rounded up to the next full 2048.
|
||||
Minimum is 64kiB, maximum is 1 GiB (but that is too much anyway).
|
||||
@since 0.1.0
|
||||
@param o The option set to work on
|
||||
@param fifo_size Number of bytes to use
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
int isoburn_igopt_set_fifo_size(struct isoburn_imgen_opts *o, int fifo_size);
|
||||
int isoburn_igopt_get_fifo_size(struct isoburn_imgen_opts *o, int *fifo_size);
|
||||
|
||||
|
||||
/* ----------------------------------------------------------------------- */
|
||||
/* End of Options for image generation */
|
||||
/* ----------------------------------------------------------------------- */
|
||||
|
||||
|
||||
/** Get the image attached to a drive, if any.
|
||||
@since 0.1.0
|
||||
@param d The drive to inquire
|
||||
@return A reference to attached image, or NULL if the drive has no image
|
||||
attached. This reference needs to be released via iso_image_unref()
|
||||
when it is not longer needed.
|
||||
*/
|
||||
IsoImage *isoburn_get_attached_image(struct burn_drive *d);
|
||||
|
||||
|
||||
/** Load the ISO filesystem directory tree from the media in the given drive.
|
||||
This will give libisoburn the base on which it can let libisofs perform
|
||||
image growing or image modification. The loaded volset gets attached
|
||||
to the drive object and handed out to the application.
|
||||
Not a wrapper, but peculiar to libisoburn.
|
||||
@since 0.1.0
|
||||
@param d The drive which holds an existing ISO filesystem or blank media.
|
||||
d is allowed to be NULL which produces an empty ISO image. In
|
||||
this case one has to call before writing isoburn_attach_volset()
|
||||
@ -618,7 +725,6 @@ int isoburn_read_image(struct burn_drive *d,
|
||||
struct isoburn_read_opts *read_opts,
|
||||
IsoImage **image);
|
||||
|
||||
/* @since 0.1.0 */
|
||||
/** Set a callback function for producing pacifier messages during the lengthy
|
||||
process of image reading. The callback function and the application handle
|
||||
are stored until they are needed for the underlying call to libisofs.
|
||||
@ -627,15 +733,19 @@ int isoburn_read_image(struct burn_drive *d,
|
||||
valid until isoburn_read_image() is done. It has to be detached by
|
||||
isoburn_set_read_pacifier(drive, NULL, NULL);
|
||||
before it may be removed from memory.
|
||||
@since 0.1.0
|
||||
@param drive The drive which will be used with isoburn_read_image()
|
||||
It has to be aquired by an isoburn_* wrapper call.
|
||||
@param read_pacifier The callback function
|
||||
@param app_handle The app handle which the callback function can obtain
|
||||
via iso_image_get_attached_data() from its IsoImage*
|
||||
@return 1 success, <=0 failure
|
||||
*/
|
||||
int isoburn_set_read_pacifier(struct burn_drive *drive,
|
||||
int (*read_pacifier)(IsoImage*, IsoFileSource*),
|
||||
void *app_handle);
|
||||
|
||||
|
||||
/** Set the IsoImage to be used with a drive. This eventually releases
|
||||
the reference to the old IsoImage attached to the drive.
|
||||
Caution: Use with care. It hardly makes sense to replace an image that
|
||||
@ -643,6 +753,7 @@ int isoburn_set_read_pacifier(struct burn_drive *drive,
|
||||
This call is rather intended for writing a newly created and populated
|
||||
image to blank media. The use case in xorriso is to let an image survive
|
||||
the change or demise of the outdev target drive.
|
||||
@since 0.1.0
|
||||
@param d The drive which shall be write target of the volset.
|
||||
@param image The image that represents the image to be written.
|
||||
This image pointer MUST already be a valid reference suitable
|
||||
@ -661,6 +772,7 @@ int isoburn_attach_image(struct burn_drive *d, IsoImage *image);
|
||||
from the capacity estimation given by burn_disc_available_space().
|
||||
Negative results get defaulted to 0.
|
||||
Wrapper for: burn_disc_available_space()
|
||||
@since 0.1.0
|
||||
@param d The drive to query.
|
||||
@param o If not NULL: write parameters to be set on drive before query
|
||||
@return number of most probably available free bytes
|
||||
@ -674,6 +786,10 @@ off_t isoburn_disc_available_space(struct burn_drive *d,
|
||||
not a guarantee that there is a ISO-9660 image at all. The call will fail,
|
||||
nevertheless,if isoburn_disc_get_status() returns not BURN_DISC_APPENDABLE.
|
||||
Wrapper for: burn_disc_get_msc1()
|
||||
@since 0.1.0
|
||||
@param d The drive to inquire
|
||||
@param start_lba Contains on success the start address in 2048 byte blocks
|
||||
@return <=0 error , 1 = success
|
||||
*/
|
||||
int isoburn_disc_get_msc1(struct burn_drive *d, int *start_lba);
|
||||
|
||||
@ -681,6 +797,13 @@ int isoburn_disc_get_msc1(struct burn_drive *d, int *start_lba);
|
||||
/** Use this with trackno==0 to obtain the predicted start block number of the
|
||||
new session. The interesting number is returned in parameter nwa.
|
||||
Wrapper for: burn_disc_track_lba_nwa()
|
||||
@since 0.1.0
|
||||
@param d The drive to inquire
|
||||
@param o If not NULL: write parameters to be set on drive before query
|
||||
@param trackno Submit 0.
|
||||
@param lba return value: start lba
|
||||
@param nwa return value: Next Writeable Address
|
||||
@return 1=nwa is valid , 0=nwa is not valid , -1=error
|
||||
*/
|
||||
int isoburn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o,
|
||||
int trackno, int *lba, int *nwa);
|
||||
@ -689,6 +812,7 @@ int isoburn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o,
|
||||
/** Obtain the size which was attributed to an emulated appendable on actually
|
||||
overwriteable media. This value is supposed to be <= 2048 * nwa as of
|
||||
isoburn_disc_track_lba_nwa().
|
||||
@since 0.1.0
|
||||
@param drive The drive holding the media.
|
||||
@param start_byte The reply value counted in bytes, not in sectors.
|
||||
@param flag Unused yet. Submit 0.
|
||||
@ -704,9 +828,11 @@ int isoburn_get_min_start_byte(struct burn_drive *d, off_t *start_byte,
|
||||
use by a subsequent call to isoburn_disc_write().
|
||||
After this asynchronous writing has ended and the drive is BURN_DRIVE_IDLE
|
||||
again, the burn_disc object has to be disposed by burn_disc_free().
|
||||
@since 0.1.0
|
||||
@param drive The combined source and target drive, grabbed with
|
||||
isoburn_drive_scan_and_grab(). .
|
||||
@param disc Returns the newly created burn_disc object.
|
||||
@param opts Image generation options, see isoburn_igopt_*()
|
||||
@return <=0 error , 1 = success
|
||||
*/
|
||||
int isoburn_prepare_disc(struct burn_drive *drive, struct burn_disc **disc,
|
||||
@ -722,6 +848,7 @@ int isoburn_prepare_disc(struct burn_drive *drive, struct burn_disc **disc,
|
||||
The resulting burn_disc object has to be disposed when all its writing
|
||||
is done and the drive is BURN_DRIVE_IDLE again after asynchronous
|
||||
burn_disc_write().
|
||||
@since 0.1.0
|
||||
@param in_drive The input drive,grabbed with isoburn_drive_scan_and_grab().
|
||||
@param disc Returns the newly created burn_disc object.
|
||||
@param opts Options for image generation and data transport to media.
|
||||
@ -745,6 +872,7 @@ int isoburn_prepare_new_image(struct burn_drive *in_drive,
|
||||
image stream when one of above two calls is performed. It is mandatory to
|
||||
either run isoburn_disc_write() or to revoke the preparations by the
|
||||
call described here.
|
||||
@since 0.1.0
|
||||
@param input_drive The drive resp. in_drive which was used with the
|
||||
preparation call.
|
||||
@param output_drive The out_drive used with isoburn_prepare_new_image(),
|
||||
@ -762,6 +890,11 @@ int isoburn_cancel_prepared_write(struct burn_drive *input_drive,
|
||||
to be watched by a loop with call burn_drive_get_status() until
|
||||
BURN_DRIVE_IDLE is returned.
|
||||
Wrapper for: burn_disc_write()
|
||||
@since 0.1.0
|
||||
@param o Options which control the burn process. See burnwrite_opts_*()
|
||||
in libburn.h.
|
||||
@param disc Disc object created either by isoburn_prepare_disc() or by
|
||||
isoburn_prepare_new_image().
|
||||
*/
|
||||
void isoburn_disc_write(struct burn_write_opts *o, struct burn_disc *disc);
|
||||
|
||||
@ -774,6 +907,7 @@ void isoburn_disc_write(struct burn_write_opts *o, struct burn_disc *disc);
|
||||
parameter out_drive must have announced the track output drive.
|
||||
Hint: If only burn_write_opts and not burn_drive is known, then the drive
|
||||
can be obtained by burn_write_opts_get_drive().
|
||||
@since 0.1.0
|
||||
@parm d The drive to which the track with the fifo gets burned.
|
||||
@param size The total size of the fifo
|
||||
@param free_bytes The current free capacity of the fifo
|
||||
@ -795,6 +929,9 @@ int isoburn_get_fifo_status(struct burn_drive *d, int *size, int *free_bytes,
|
||||
|
||||
/** Inquire whether the most recent write run was successful.
|
||||
Wrapper for: burn_drive_wrote_well()
|
||||
@since 0.1.0
|
||||
@param d The drive to inquire
|
||||
@return 1=burn seems to have went well, 0=burn failed
|
||||
*/
|
||||
int isoburn_drive_wrote_well(struct burn_drive *d);
|
||||
|
||||
@ -803,6 +940,9 @@ int isoburn_drive_wrote_well(struct burn_drive *d);
|
||||
indicates success. It will eventually complete the emulation of
|
||||
multi-session functionality, if needed at all. Let libisoburn decide.
|
||||
Not a wrapper, but peculiar to libisoburn.
|
||||
@since 0.1.0
|
||||
@param d The output drive to which the session was written
|
||||
@return 1 success , <=0 failure
|
||||
*/
|
||||
int isoburn_activate_session(struct burn_drive *drive);
|
||||
|
||||
@ -812,6 +952,7 @@ int isoburn_activate_session(struct burn_drive *drive);
|
||||
threads and freed resource reservations.
|
||||
This call is not mandatory. But without it, messages from the ending
|
||||
threads might appear after the application ended its write procedure.
|
||||
@since 0.1.0
|
||||
@param input_drive The drive resp. in_drive which was used with the
|
||||
preparation call.
|
||||
@param output_drive The out_drive used with isoburn_prepare_new_image(),
|
||||
@ -840,12 +981,16 @@ int isoburn_perform_write(struct burn_write_opts *o,
|
||||
|
||||
/** Release an aquired drive.
|
||||
Wrapper for: burn_drive_release()
|
||||
@since 0.1.0
|
||||
@param drive The drive to be released
|
||||
@param eject 1= eject media from drive , 0= do not eject
|
||||
*/
|
||||
void isoburn_drive_release(struct burn_drive *drive, int eject);
|
||||
|
||||
|
||||
/** Shutdown all three libraries.
|
||||
Wrapper for : iso_finish() and burn_finish().
|
||||
@since 0.1.0
|
||||
*/
|
||||
void isoburn_finish(void);
|
||||
|
||||
@ -858,6 +1003,8 @@ void isoburn_finish(void);
|
||||
|
||||
/** Inquire wether the media needs emulation or would be suitable for
|
||||
generic multi-session via libburn.
|
||||
@since 0.1.0
|
||||
@param d The drive to inquire
|
||||
@return 0 is generic multi-session
|
||||
1 is emulated multi-session
|
||||
-1 is not suitable for isoburn
|
||||
|
@ -1 +1 @@
|
||||
#define Xorriso_timestamP "2008.02.12.215327"
|
||||
#define Xorriso_timestamP "2008.02.14.084342"
|
||||
|
Loading…
Reference in New Issue
Block a user