| 1 |
------------------------------------------------------------------------------ |
| 2 |
libisofs |
| 3 |
------------------------------------------------------------------------------ |
| 4 |
|
| 5 |
Released under GNU General Public License version 2 or later. |
| 6 |
See COPYING file for details. |
| 7 |
|
| 8 |
Copyright (C) 2008 - 2026 Vreixo Formoso, |
| 9 |
Mario Danic, |
| 10 |
Vladimir Serbinenko, |
| 11 |
Thomas Schmitt |
| 12 |
|
| 13 |
libisofs is part of the libburnia project (libburnia-project.org) |
| 14 |
------------------------------------------------------------------------------ |
| 15 |
|
| 16 |
Download, Build and Installation |
| 17 |
|
| 18 |
libisofs code is maintained in a git repository at dev.lovelyhq.com |
| 19 |
(https://dev.lovelyhq.com/libburnia/libisofs). You can download it with: |
| 20 |
|
| 21 |
$ git clone https://dev.lovelyhq.com/libburnia/libisofs.git |
| 22 |
|
| 23 |
Our build system is based on autotools. For preparing the build you will need |
| 24 |
autotools of at least version 1.7. If you have downloaded the code from the |
| 25 |
repository, first of all you need to execute |
| 26 |
|
| 27 |
./bootstrap |
| 28 |
|
| 29 |
in the toplevel directory ./libisofs, in order to execute autotools. |
| 30 |
|
| 31 |
Alternatively you may unpack a release tarball for which you do not need |
| 32 |
autotools installed. For the most recent release of libisofs see: |
| 33 |
https://dev.lovelyhq.com/libburnia/web/wiki/Releases |
| 34 |
|
| 35 |
To build libisofs go into its toplevel directory and execute |
| 36 |
|
| 37 |
./configure --prefix=/usr |
| 38 |
make |
| 39 |
|
| 40 |
To make the libraries accessible for running and developing applications |
| 41 |
make install |
| 42 |
|
| 43 |
On GNU/Linux it will try to run program ldconfig with the library installation |
| 44 |
directory as only argument. Failure to do so will not abort installation. |
| 45 |
One may disable ldconfig by ./configure option --disable-ldconfig-at-install . |
| 46 |
|
| 47 |
By use of a version script, the libisofs.so library exposes no other function |
| 48 |
names but those of the API definitions in <libisofs/libisofs.h>. |
| 49 |
If -Wl,--version-script=... makes problems with the local compiler, then |
| 50 |
disable this encapsulation feature by |
| 51 |
./configure --disable-versioned-libs |
| 52 |
make clean ; make |
| 53 |
|
| 54 |
The ./configure script checks for the availability of supporting libraries. |
| 55 |
If found, they will become mandatory for the emerging libisofs.so and all |
| 56 |
applications which use it. This dependency can be avoided by configure options |
| 57 |
--disable-libacl avoid use of ACL functions like acl_to_text() |
| 58 |
--disable-xattr avoid use of xattr functions like listxattr() |
| 59 |
--disable-zlib avoid use of zlib functions like compress2() |
| 60 |
--disable-libjte avoid use of libjte functions |
| 61 |
|
| 62 |
See INSTALL file for general options of ./configure. |
| 63 |
|
| 64 |
|
| 65 |
------------------------------------------------------------------------------ |
| 66 |
|
| 67 |
libisofs is a library to create an ISO-9660 filesystem, supports extensions |
| 68 |
like RockRidge or Joliet, and introduces an own extension AAIP. |
| 69 |
It is a full featured ISO-9660 editor which composes and changes the directory |
| 70 |
tree of an ISO image. This tree and its newly imported data file contents get |
| 71 |
then written as independent single-session image or as add-on session for the |
| 72 |
image from where the tree was originally loaded. |
| 73 |
|
| 74 |
Features: |
| 75 |
--------- |
| 76 |
|
| 77 |
- Image creation |
| 78 |
- Creates ISO-9660 images from local files. |
| 79 |
- Support for RockRidge and Joliet extensions. |
| 80 |
- Support for ISO-9660:1999 (version 2). |
| 81 |
- Support for El-Torito bootable images. Tested are: PC-BIOS and EFI. |
| 82 |
- Support for multi-extent data files up to 400 GB (level 3). |
| 83 |
- Full-featured edition of the image files, including: addition of new |
| 84 |
files, removing of existent files, moving files, renaming files, |
| 85 |
change file attributes (permissions, timestamps...) |
| 86 |
- Optional recording per file of non-ISO 9660 features: |
| 87 |
ACL, xattr, content MD5, hard link relations. |
| 88 |
They do not hamper image readability by operating systems but can be |
| 89 |
retrieved only via libisofs. |
| 90 |
- Optional zisofs compression, gzip compression, external filter |
| 91 |
processes. |
| 92 |
- Several options to relax ISO-9660 constraints. |
| 93 |
- Special options for images intended for distribution (suitable |
| 94 |
default modes for files, hiding of real timestamps...). |
| 95 |
- Image reading |
| 96 |
- Image tree and data heap can be verified by stream reading and |
| 97 |
eventually recorded MD5 tags. |
| 98 |
- Directory tree and file attributes of ISO 9660 session get loaded |
| 99 |
into memory for editing or for extraction into local filesystem. |
| 100 |
- File content can be read by applications. |
| 101 |
- Automatic zisofs decompression. |
| 102 |
- Optional application of gzip decompression or external filter |
| 103 |
processes. |
| 104 |
- Eventually recorded MD5 of data file can be obtained, MD5 of data |
| 105 |
stream can be computed and compared. |
| 106 |
- Helper functions for restoring ACL and/or xattr to the local |
| 107 |
filesystem. |
| 108 |
- Multisession |
| 109 |
- Support for growing an existing image on multi-session media. |
| 110 |
- Support for "emulated multisession" on overwriteable media such as |
| 111 |
DVD+RW, USB sticks, regular files. |
| 112 |
- Support for blindly prepared add-on sessions (mkisofs style -M -C) |
| 113 |
suitable for pipes which lead to an external burn program. |
| 114 |
- Image modification |
| 115 |
- Creates a completely new image from files out of another image and |
| 116 |
eventual editing operations. Suitable for any target medium. |
| 117 |
- Others |
| 118 |
- Handling of different input and output charset. |
| 119 |
- Good integration with libburn for image burning. |
| 120 |
- Reliable, good handling of different kind of errors. |
| 121 |
|
| 122 |
Requirements: |
| 123 |
------------- |
| 124 |
|
| 125 |
- iconv() functions for character set conversion must be available. |
| 126 |
Either implicitely as in Linux or by a separate library like libiconv |
| 127 |
on FreeBSD. |
| 128 |
|
| 129 |
Know bugs: |
| 130 |
---------- |
| 131 |
|
| 132 |
Multisession and image growing can lead to undesired results in several cases: |
| 133 |
|
| 134 |
a) Images with unsupported features, such as: |
| 135 |
- UDF. |
| 136 |
- HSF/HFS+ or other Mac extensions. |
| 137 |
- ECMA-119 Extended attributes. |
| 138 |
- ... |
| 139 |
In all these cases, the resulting new image (or new session) could lack some |
| 140 |
features of the original image. Nevertheless, the ECMA-119 System Area with |
| 141 |
an eventual Master Boot Record gets preserved by default. |
| 142 |
In some cases libisofs will issue warning messages, or even refuse to grow |
| 143 |
or modify the image. Others remain undetected. Images created with libisofs |
| 144 |
do not have this problems. |
| 145 |
|
| 146 |
b) Bootable El-Torito images may have problems, that result in a new image that |
| 147 |
is not bootable, or that boots from an outdated session. In some cases it |
| 148 |
might be necessary to add boot info again in a new first session. |
| 149 |
- There is no safe way to modify hidden boot images, as the size of the |
| 150 |
boot image can't be figured out. |
| 151 |
|
| 152 |
c) Generated images could have different ECMA-119 low level names, due to |
| 153 |
different way to mangle names, to new files added that force old files to |
| 154 |
be renamed, to different relaxed contraints... This only affect the |
| 155 |
ISO-9660 info, not the RR names, so it shouldn't be a problem in most |
| 156 |
cases. If your app. relies on low level ISO-9660 names, you will need to |
| 157 |
ensure all node names are valid ISO names (maybe together with some |
| 158 |
relaxed contraints), otherwise libisofs might arbitrarily change the names. |
| 159 |
|
| 160 |
|
| 161 |
------------------------------------------------------------------------------ |
| 162 |
|
| 163 |
This program is free software; you can redistribute it and/or modify |
| 164 |
it under the terms of the GNU General Public License version 2 or later |
| 165 |
as published by the Free Software Foundation. |
| 166 |
|
| 167 |
This program is distributed in the hope that it will be useful, |
| 168 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 169 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 170 |
GNU General Public License for more details. |
| 171 |
|
| 172 |
You should have received a copy of the GNU General Public License |
| 173 |
along with this program; if not, write to the Free Software |
| 174 |
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 175 |
|
| 176 |
------------------------------------------------------------------------------ |
| 177 |
Clarification in my name and in the name of Mario Danic, upcoming copyright |
| 178 |
holders on toplevel of libburnia. To be fully in effect after the remaining |
| 179 |
other copyrighted code has been replaced by ours and by copyright-free |
| 180 |
contributions of our friends. |
| 181 |
|
| 182 |
Note: |
| 183 |
In the particular case of libisofs there is no foreign copyright involved. |
| 184 |
As of 2010 foreign copyright is only in component libburn. |
| 185 |
------------------------------------------------------------------------------ |
| 186 |
|
| 187 |
We will not raise any legal protest to dynamic linking of our libraries |
| 188 |
with applications that are not under GPL, as long as they fulfill |
| 189 |
the condition of offering the library source code used, whether |
| 190 |
altered or unaltered, under the GPLv2+, along with the application. |
| 191 |
Nevertheless, the safest legal position is not to link libburn with |
| 192 |
non-GPL compatible programs. |
| 193 |
|
| 194 |
We ask you politely to use our work in open source spirit |
| 195 |
and with the due reference to the entire open source community. |
| 196 |
|
| 197 |
If there should really arise the case where above clarification |
| 198 |
does not suffice to fulfill a clear and neat request in open source |
| 199 |
spirit that would otherwise be declined for mere formal reasons, |
| 200 |
only in that case we will duely consider to issue a special license |
| 201 |
covering only that special case. |
| 202 |
It is the open source idea of responsible freedom which will be |
| 203 |
decisive and you will have to prove that you exhausted all own |
| 204 |
means to qualify for GPL. |
| 205 |
|
| 206 |
We are firmly committed to allow GPLv2+ now and with future releases. |
| 207 |
|
| 208 |
Signed: Mario Danic, Thomas Schmitt |
| 209 |
Agreement joined later by: Vreixo Formoso |
| 210 |
|
| 211 |
Public contact: <[email protected]> |
| 212 |
|