First commit after CVS conversion. Should be just administrative changes.
This commit is contained in:
7
doc/.gitignore
vendored
Normal file
7
doc/.gitignore
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
/Makefile
|
||||
/Makefile.in
|
||||
/libcdio.info
|
||||
/mdate-sh
|
||||
/stamp-vti
|
||||
/texinfo.tex
|
||||
/version.texi
|
||||
46
doc/Makefile.am
Normal file
46
doc/Makefile.am
Normal file
@@ -0,0 +1,46 @@
|
||||
# $Id: Makefile.am,v 1.9 2008/04/17 17:39:47 karl Exp $
|
||||
#
|
||||
# Copyright (C) 2003, 2004, 2008 Rocky Bernstein <rocky@gnu.org>
|
||||
# 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 3 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, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
EXTRA_DIST = doxygen/Doxyfile.in doxygen/run_doxygen
|
||||
info_TEXINFOS = libcdio.texi
|
||||
libcdio_TEXINFOS = fdl.texi glossary.texi
|
||||
|
||||
reference:
|
||||
-( cd ${top_srcdir} && $(MAKE) doxygen )
|
||||
|
||||
pdf: libcdio.pdf
|
||||
|
||||
txt: libcdio.txt
|
||||
|
||||
ps: libcdio.ps
|
||||
|
||||
html: libcdio.html
|
||||
|
||||
%.ps.gz: %.ps
|
||||
gzip -9c $< > $@
|
||||
|
||||
.texi.pdf:
|
||||
texi2pdf $<
|
||||
|
||||
.texi.html:
|
||||
texi2html $<
|
||||
|
||||
.texi.txt:
|
||||
makeinfo --no-headers $< > $@
|
||||
|
||||
all-formats: pdf dvi txt ps html
|
||||
|
||||
MOSTLYCLEANFILES = libcdio.html libcdio.pdf libcdio.ps.gz
|
||||
1
doc/doxygen/.gitignore
vendored
Normal file
1
doc/doxygen/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
/Doxyfile
|
||||
1302
doc/doxygen/Doxyfile.in
Normal file
1302
doc/doxygen/Doxyfile.in
Normal file
File diff suppressed because it is too large
Load Diff
107
doc/doxygen/run_doxygen
Executable file
107
doc/doxygen/run_doxygen
Executable file
@@ -0,0 +1,107 @@
|
||||
#!/bin/sh
|
||||
# $Id: run_doxygen,v 1.1 2003/11/09 14:11:02 rocky Exp $
|
||||
|
||||
# Runs doxygen and massages the output files.
|
||||
# Copyright (C) 2001, 2002, 2003 Free Software Foundation, Inc.
|
||||
#
|
||||
# Synopsis: run_doxygen --mode=[user|maint|man] v3srcdir v3builddir
|
||||
#
|
||||
# Originally hacked together by Phil Edwards <pme@gcc.gnu.org>
|
||||
|
||||
|
||||
# We can check now that the version of doxygen is >= this variable.
|
||||
DOXYVER=1.2.15
|
||||
doxygen=
|
||||
|
||||
find_doxygen() {
|
||||
v_required=`echo $DOXYVER | \
|
||||
awk -F. '{if(NF<3)$3=0;print ($1*100+$2)*100+$3}'`
|
||||
testing_version=
|
||||
# thank you goat book
|
||||
set `IFS=:; X="$PATH:/usr/local/bin:/bin:/usr/bin"; echo $X`
|
||||
for dir
|
||||
do
|
||||
# AC_EXEEXT could come in useful here
|
||||
maybedoxy="$dir/doxygen"
|
||||
test -f "$maybedoxy" && testing_version=`$maybedoxy --version`
|
||||
if test -n "$testing_version"; then
|
||||
v_found=`echo $testing_version | \
|
||||
awk -F. '{if(NF<3)$3=0;print ($1*100+$2)*100+$3}'`
|
||||
if test $v_found -ge $v_required; then
|
||||
doxygen="$maybedoxy"
|
||||
break
|
||||
fi
|
||||
fi
|
||||
done
|
||||
if test -z "$doxygen"; then
|
||||
echo run_doxygen error: Could not find Doxygen $DOXYVER in path. 1>&2
|
||||
print_usage
|
||||
fi
|
||||
}
|
||||
|
||||
print_usage() {
|
||||
cat 1>&2 <<EOF
|
||||
Usage: run_doxygen --mode=MODE [<options>] <v3-src-dir> <v3-build-dir>
|
||||
MODE is one of:
|
||||
user Generate user-level HTML library documentation.
|
||||
maint Generate maintainers' HTML documentation (lots more;
|
||||
exposes non-public members, etc).
|
||||
man Generate user-level man pages.
|
||||
|
||||
more options when i think of them
|
||||
|
||||
Note: Requires Doxygen ${DOXYVER} or later; get it at
|
||||
ftp://ftp.stack.nl/pub/users/dimitri/doxygen-${DOXYVER}.src.tar.gz
|
||||
|
||||
EOF
|
||||
exit 1
|
||||
}
|
||||
|
||||
parse_options() {
|
||||
for o
|
||||
do
|
||||
# Blatantly ripped from autoconf, er, I mean, "gratefully standing
|
||||
# on the shoulders of those giants who have gone before us."
|
||||
case "$o" in
|
||||
-*=*) arg=`echo "$o" | sed 's/[-_a-zA-Z0-9]*=//'` ;;
|
||||
*) arg= ;;
|
||||
esac
|
||||
|
||||
case "$o" in
|
||||
--mode=*)
|
||||
mode=$arg ;;
|
||||
--mode | --help | -h)
|
||||
print_usage ;;
|
||||
*)
|
||||
# this turned out to be a mess, maybe change to --srcdir=, etc
|
||||
if test $srcdir = unset; then
|
||||
srcdir=$o
|
||||
elif test $outdir = unset; then
|
||||
builddir=${o}
|
||||
outdir=${o}/doc/doxygen
|
||||
else
|
||||
echo run_doxygen error: Too many arguments 1>&2
|
||||
exit 1
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
done
|
||||
}
|
||||
|
||||
|
||||
# script begins here
|
||||
mode=unset
|
||||
srcdir=unset
|
||||
outdir=unset
|
||||
do_html=no
|
||||
do_man=no
|
||||
enabled_sections=
|
||||
DATEtext=`date '+%Y-%m-%d'`
|
||||
|
||||
parse_options $*
|
||||
find_doxygen
|
||||
$doxygen ./Doxyfile
|
||||
|
||||
exit 0
|
||||
|
||||
# vim:ts=4:et:
|
||||
451
doc/fdl.texi
Normal file
451
doc/fdl.texi
Normal file
@@ -0,0 +1,451 @@
|
||||
@c The GNU Free Documentation License.
|
||||
@center Version 1.2, November 2002
|
||||
|
||||
@c This file is intended to be included within another document,
|
||||
@c hence no sectioning command or @node.
|
||||
|
||||
@display
|
||||
Copyright @copyright{} 2000,2001,2002 Free Software Foundation, Inc.
|
||||
51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
@end display
|
||||
|
||||
@enumerate 0
|
||||
@item
|
||||
PREAMBLE
|
||||
|
||||
The purpose of this License is to make a manual, textbook, or other
|
||||
functional and useful document @dfn{free} in the sense of freedom: to
|
||||
assure everyone the effective freedom to copy and redistribute it,
|
||||
with or without modifying it, either commercially or noncommercially.
|
||||
Secondarily, this License preserves for the author and publisher a way
|
||||
to get credit for their work, while not being considered responsible
|
||||
for modifications made by others.
|
||||
|
||||
This License is a kind of ``copyleft'', which means that derivative
|
||||
works of the document must themselves be free in the same sense. It
|
||||
complements the GNU General Public License, which is a copyleft
|
||||
license designed for free software.
|
||||
|
||||
We have designed this License in order to use it for manuals for free
|
||||
software, because free software needs free documentation: a free
|
||||
program should come with manuals providing the same freedoms that the
|
||||
software does. But this License is not limited to software manuals;
|
||||
it can be used for any textual work, regardless of subject matter or
|
||||
whether it is published as a printed book. We recommend this License
|
||||
principally for works whose purpose is instruction or reference.
|
||||
|
||||
@item
|
||||
APPLICABILITY AND DEFINITIONS
|
||||
|
||||
This License applies to any manual or other work, in any medium, that
|
||||
contains a notice placed by the copyright holder saying it can be
|
||||
distributed under the terms of this License. Such a notice grants a
|
||||
world-wide, royalty-free license, unlimited in duration, to use that
|
||||
work under the conditions stated herein. The ``Document'', below,
|
||||
refers to any such manual or work. Any member of the public is a
|
||||
licensee, and is addressed as ``you''. You accept the license if you
|
||||
copy, modify or distribute the work in a way requiring permission
|
||||
under copyright law.
|
||||
|
||||
A ``Modified Version'' of the Document means any work containing the
|
||||
Document or a portion of it, either copied verbatim, or with
|
||||
modifications and/or translated into another language.
|
||||
|
||||
A ``Secondary Section'' is a named appendix or a front-matter section
|
||||
of the Document that deals exclusively with the relationship of the
|
||||
publishers or authors of the Document to the Document's overall
|
||||
subject (or to related matters) and contains nothing that could fall
|
||||
directly within that overall subject. (Thus, if the Document is in
|
||||
part a textbook of mathematics, a Secondary Section may not explain
|
||||
any mathematics.) The relationship could be a matter of historical
|
||||
connection with the subject or with related matters, or of legal,
|
||||
commercial, philosophical, ethical or political position regarding
|
||||
them.
|
||||
|
||||
The ``Invariant Sections'' are certain Secondary Sections whose titles
|
||||
are designated, as being those of Invariant Sections, in the notice
|
||||
that says that the Document is released under this License. If a
|
||||
section does not fit the above definition of Secondary then it is not
|
||||
allowed to be designated as Invariant. The Document may contain zero
|
||||
Invariant Sections. If the Document does not identify any Invariant
|
||||
Sections then there are none.
|
||||
|
||||
The ``Cover Texts'' are certain short passages of text that are listed,
|
||||
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
|
||||
the Document is released under this License. A Front-Cover Text may
|
||||
be at most 5 words, and a Back-Cover Text may be at most 25 words.
|
||||
|
||||
A ``Transparent'' copy of the Document means a machine-readable copy,
|
||||
represented in a format whose specification is available to the
|
||||
general public, that is suitable for revising the document
|
||||
straightforwardly with generic text editors or (for images composed of
|
||||
pixels) generic paint programs or (for drawings) some widely available
|
||||
drawing editor, and that is suitable for input to text formatters or
|
||||
for automatic translation to a variety of formats suitable for input
|
||||
to text formatters. A copy made in an otherwise Transparent file
|
||||
format whose markup, or absence of markup, has been arranged to thwart
|
||||
or discourage subsequent modification by readers is not Transparent.
|
||||
An image format is not Transparent if used for any substantial amount
|
||||
of text. A copy that is not ``Transparent'' is called ``Opaque''.
|
||||
|
||||
Examples of suitable formats for Transparent copies include plain
|
||||
@sc{ascii} without markup, Texinfo input format, La@TeX{} input
|
||||
format, @acronym{SGML} or @acronym{XML} using a publicly available
|
||||
@acronym{DTD}, and standard-conforming simple @acronym{HTML},
|
||||
PostScript or @acronym{PDF} designed for human modification. Examples
|
||||
of transparent image formats include @acronym{PNG}, @acronym{XCF} and
|
||||
@acronym{JPG}. Opaque formats include proprietary formats that can be
|
||||
read and edited only by proprietary word processors, @acronym{SGML} or
|
||||
@acronym{XML} for which the @acronym{DTD} and/or processing tools are
|
||||
not generally available, and the machine-generated @acronym{HTML},
|
||||
PostScript or @acronym{PDF} produced by some word processors for
|
||||
output purposes only.
|
||||
|
||||
The ``Title Page'' means, for a printed book, the title page itself,
|
||||
plus such following pages as are needed to hold, legibly, the material
|
||||
this License requires to appear in the title page. For works in
|
||||
formats which do not have any title page as such, ``Title Page'' means
|
||||
the text near the most prominent appearance of the work's title,
|
||||
preceding the beginning of the body of the text.
|
||||
|
||||
A section ``Entitled XYZ'' means a named subunit of the Document whose
|
||||
title either is precisely XYZ or contains XYZ in parentheses following
|
||||
text that translates XYZ in another language. (Here XYZ stands for a
|
||||
specific section name mentioned below, such as ``Acknowledgements'',
|
||||
``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title''
|
||||
of such a section when you modify the Document means that it remains a
|
||||
section ``Entitled XYZ'' according to this definition.
|
||||
|
||||
The Document may include Warranty Disclaimers next to the notice which
|
||||
states that this License applies to the Document. These Warranty
|
||||
Disclaimers are considered to be included by reference in this
|
||||
License, but only as regards disclaiming warranties: any other
|
||||
implication that these Warranty Disclaimers may have is void and has
|
||||
no effect on the meaning of this License.
|
||||
|
||||
@item
|
||||
VERBATIM COPYING
|
||||
|
||||
You may copy and distribute the Document in any medium, either
|
||||
commercially or noncommercially, provided that this License, the
|
||||
copyright notices, and the license notice saying this License applies
|
||||
to the Document are reproduced in all copies, and that you add no other
|
||||
conditions whatsoever to those of this License. You may not use
|
||||
technical measures to obstruct or control the reading or further
|
||||
copying of the copies you make or distribute. However, you may accept
|
||||
compensation in exchange for copies. If you distribute a large enough
|
||||
number of copies you must also follow the conditions in section 3.
|
||||
|
||||
You may also lend copies, under the same conditions stated above, and
|
||||
you may publicly display copies.
|
||||
|
||||
@item
|
||||
COPYING IN QUANTITY
|
||||
|
||||
If you publish printed copies (or copies in media that commonly have
|
||||
printed covers) of the Document, numbering more than 100, and the
|
||||
Document's license notice requires Cover Texts, you must enclose the
|
||||
copies in covers that carry, clearly and legibly, all these Cover
|
||||
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
|
||||
the back cover. Both covers must also clearly and legibly identify
|
||||
you as the publisher of these copies. The front cover must present
|
||||
the full title with all words of the title equally prominent and
|
||||
visible. You may add other material on the covers in addition.
|
||||
Copying with changes limited to the covers, as long as they preserve
|
||||
the title of the Document and satisfy these conditions, can be treated
|
||||
as verbatim copying in other respects.
|
||||
|
||||
If the required texts for either cover are too voluminous to fit
|
||||
legibly, you should put the first ones listed (as many as fit
|
||||
reasonably) on the actual cover, and continue the rest onto adjacent
|
||||
pages.
|
||||
|
||||
If you publish or distribute Opaque copies of the Document numbering
|
||||
more than 100, you must either include a machine-readable Transparent
|
||||
copy along with each Opaque copy, or state in or with each Opaque copy
|
||||
a computer-network location from which the general network-using
|
||||
public has access to download using public-standard network protocols
|
||||
a complete Transparent copy of the Document, free of added material.
|
||||
If you use the latter option, you must take reasonably prudent steps,
|
||||
when you begin distribution of Opaque copies in quantity, to ensure
|
||||
that this Transparent copy will remain thus accessible at the stated
|
||||
location until at least one year after the last time you distribute an
|
||||
Opaque copy (directly or through your agents or retailers) of that
|
||||
edition to the public.
|
||||
|
||||
It is requested, but not required, that you contact the authors of the
|
||||
Document well before redistributing any large number of copies, to give
|
||||
them a chance to provide you with an updated version of the Document.
|
||||
|
||||
@item
|
||||
MODIFICATIONS
|
||||
|
||||
You may copy and distribute a Modified Version of the Document under
|
||||
the conditions of sections 2 and 3 above, provided that you release
|
||||
the Modified Version under precisely this License, with the Modified
|
||||
Version filling the role of the Document, thus licensing distribution
|
||||
and modification of the Modified Version to whoever possesses a copy
|
||||
of it. In addition, you must do these things in the Modified Version:
|
||||
|
||||
@enumerate A
|
||||
@item
|
||||
Use in the Title Page (and on the covers, if any) a title distinct
|
||||
from that of the Document, and from those of previous versions
|
||||
(which should, if there were any, be listed in the History section
|
||||
of the Document). You may use the same title as a previous version
|
||||
if the original publisher of that version gives permission.
|
||||
|
||||
@item
|
||||
List on the Title Page, as authors, one or more persons or entities
|
||||
responsible for authorship of the modifications in the Modified
|
||||
Version, together with at least five of the principal authors of the
|
||||
Document (all of its principal authors, if it has fewer than five),
|
||||
unless they release you from this requirement.
|
||||
|
||||
@item
|
||||
State on the Title page the name of the publisher of the
|
||||
Modified Version, as the publisher.
|
||||
|
||||
@item
|
||||
Preserve all the copyright notices of the Document.
|
||||
|
||||
@item
|
||||
Add an appropriate copyright notice for your modifications
|
||||
adjacent to the other copyright notices.
|
||||
|
||||
@item
|
||||
Include, immediately after the copyright notices, a license notice
|
||||
giving the public permission to use the Modified Version under the
|
||||
terms of this License, in the form shown in the Addendum below.
|
||||
|
||||
@item
|
||||
Preserve in that license notice the full lists of Invariant Sections
|
||||
and required Cover Texts given in the Document's license notice.
|
||||
|
||||
@item
|
||||
Include an unaltered copy of this License.
|
||||
|
||||
@item
|
||||
Preserve the section Entitled ``History'', Preserve its Title, and add
|
||||
to it an item stating at least the title, year, new authors, and
|
||||
publisher of the Modified Version as given on the Title Page. If
|
||||
there is no section Entitled ``History'' in the Document, create one
|
||||
stating the title, year, authors, and publisher of the Document as
|
||||
given on its Title Page, then add an item describing the Modified
|
||||
Version as stated in the previous sentence.
|
||||
|
||||
@item
|
||||
Preserve the network location, if any, given in the Document for
|
||||
public access to a Transparent copy of the Document, and likewise
|
||||
the network locations given in the Document for previous versions
|
||||
it was based on. These may be placed in the ``History'' section.
|
||||
You may omit a network location for a work that was published at
|
||||
least four years before the Document itself, or if the original
|
||||
publisher of the version it refers to gives permission.
|
||||
|
||||
@item
|
||||
For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve
|
||||
the Title of the section, and preserve in the section all the
|
||||
substance and tone of each of the contributor acknowledgements and/or
|
||||
dedications given therein.
|
||||
|
||||
@item
|
||||
Preserve all the Invariant Sections of the Document,
|
||||
unaltered in their text and in their titles. Section numbers
|
||||
or the equivalent are not considered part of the section titles.
|
||||
|
||||
@item
|
||||
Delete any section Entitled ``Endorsements''. Such a section
|
||||
may not be included in the Modified Version.
|
||||
|
||||
@item
|
||||
Do not retitle any existing section to be Entitled ``Endorsements'' or
|
||||
to conflict in title with any Invariant Section.
|
||||
|
||||
@item
|
||||
Preserve any Warranty Disclaimers.
|
||||
@end enumerate
|
||||
|
||||
If the Modified Version includes new front-matter sections or
|
||||
appendices that qualify as Secondary Sections and contain no material
|
||||
copied from the Document, you may at your option designate some or all
|
||||
of these sections as invariant. To do this, add their titles to the
|
||||
list of Invariant Sections in the Modified Version's license notice.
|
||||
These titles must be distinct from any other section titles.
|
||||
|
||||
You may add a section Entitled ``Endorsements'', provided it contains
|
||||
nothing but endorsements of your Modified Version by various
|
||||
parties---for example, statements of peer review or that the text has
|
||||
been approved by an organization as the authoritative definition of a
|
||||
standard.
|
||||
|
||||
You may add a passage of up to five words as a Front-Cover Text, and a
|
||||
passage of up to 25 words as a Back-Cover Text, to the end of the list
|
||||
of Cover Texts in the Modified Version. Only one passage of
|
||||
Front-Cover Text and one of Back-Cover Text may be added by (or
|
||||
through arrangements made by) any one entity. If the Document already
|
||||
includes a cover text for the same cover, previously added by you or
|
||||
by arrangement made by the same entity you are acting on behalf of,
|
||||
you may not add another; but you may replace the old one, on explicit
|
||||
permission from the previous publisher that added the old one.
|
||||
|
||||
The author(s) and publisher(s) of the Document do not by this License
|
||||
give permission to use their names for publicity for or to assert or
|
||||
imply endorsement of any Modified Version.
|
||||
|
||||
@item
|
||||
COMBINING DOCUMENTS
|
||||
|
||||
You may combine the Document with other documents released under this
|
||||
License, under the terms defined in section 4 above for modified
|
||||
versions, provided that you include in the combination all of the
|
||||
Invariant Sections of all of the original documents, unmodified, and
|
||||
list them all as Invariant Sections of your combined work in its
|
||||
license notice, and that you preserve all their Warranty Disclaimers.
|
||||
|
||||
The combined work need only contain one copy of this License, and
|
||||
multiple identical Invariant Sections may be replaced with a single
|
||||
copy. If there are multiple Invariant Sections with the same name but
|
||||
different contents, make the title of each such section unique by
|
||||
adding at the end of it, in parentheses, the name of the original
|
||||
author or publisher of that section if known, or else a unique number.
|
||||
Make the same adjustment to the section titles in the list of
|
||||
Invariant Sections in the license notice of the combined work.
|
||||
|
||||
In the combination, you must combine any sections Entitled ``History''
|
||||
in the various original documents, forming one section Entitled
|
||||
``History''; likewise combine any sections Entitled ``Acknowledgements'',
|
||||
and any sections Entitled ``Dedications''. You must delete all
|
||||
sections Entitled ``Endorsements.''
|
||||
|
||||
@item
|
||||
COLLECTIONS OF DOCUMENTS
|
||||
|
||||
You may make a collection consisting of the Document and other documents
|
||||
released under this License, and replace the individual copies of this
|
||||
License in the various documents with a single copy that is included in
|
||||
the collection, provided that you follow the rules of this License for
|
||||
verbatim copying of each of the documents in all other respects.
|
||||
|
||||
You may extract a single document from such a collection, and distribute
|
||||
it individually under this License, provided you insert a copy of this
|
||||
License into the extracted document, and follow this License in all
|
||||
other respects regarding verbatim copying of that document.
|
||||
|
||||
@item
|
||||
AGGREGATION WITH INDEPENDENT WORKS
|
||||
|
||||
A compilation of the Document or its derivatives with other separate
|
||||
and independent documents or works, in or on a volume of a storage or
|
||||
distribution medium, is called an ``aggregate'' if the copyright
|
||||
resulting from the compilation is not used to limit the legal rights
|
||||
of the compilation's users beyond what the individual works permit.
|
||||
When the Document is included in an aggregate, this License does not
|
||||
apply to the other works in the aggregate which are not themselves
|
||||
derivative works of the Document.
|
||||
|
||||
If the Cover Text requirement of section 3 is applicable to these
|
||||
copies of the Document, then if the Document is less than one half of
|
||||
the entire aggregate, the Document's Cover Texts may be placed on
|
||||
covers that bracket the Document within the aggregate, or the
|
||||
electronic equivalent of covers if the Document is in electronic form.
|
||||
Otherwise they must appear on printed covers that bracket the whole
|
||||
aggregate.
|
||||
|
||||
@item
|
||||
TRANSLATION
|
||||
|
||||
Translation is considered a kind of modification, so you may
|
||||
distribute translations of the Document under the terms of section 4.
|
||||
Replacing Invariant Sections with translations requires special
|
||||
permission from their copyright holders, but you may include
|
||||
translations of some or all Invariant Sections in addition to the
|
||||
original versions of these Invariant Sections. You may include a
|
||||
translation of this License, and all the license notices in the
|
||||
Document, and any Warranty Disclaimers, provided that you also include
|
||||
the original English version of this License and the original versions
|
||||
of those notices and disclaimers. In case of a disagreement between
|
||||
the translation and the original version of this License or a notice
|
||||
or disclaimer, the original version will prevail.
|
||||
|
||||
If a section in the Document is Entitled ``Acknowledgements'',
|
||||
``Dedications'', or ``History'', the requirement (section 4) to Preserve
|
||||
its Title (section 1) will typically require changing the actual
|
||||
title.
|
||||
|
||||
@item
|
||||
TERMINATION
|
||||
|
||||
You may not copy, modify, sublicense, or distribute the Document except
|
||||
as expressly provided for under this License. Any other attempt to
|
||||
copy, modify, sublicense or distribute the Document 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.
|
||||
|
||||
@item
|
||||
FUTURE REVISIONS OF THIS LICENSE
|
||||
|
||||
The Free Software Foundation may publish new, revised versions
|
||||
of the GNU Free Documentation 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. See
|
||||
@uref{http://www.gnu.org/copyleft/}.
|
||||
|
||||
Each version of the License is given a distinguishing version number.
|
||||
If the Document specifies that a particular numbered version of this
|
||||
License ``or any later version'' applies to it, you have the option of
|
||||
following the terms and conditions either of that specified version or
|
||||
of any later version that has been published (not as a draft) by the
|
||||
Free Software Foundation. If the Document does not specify a version
|
||||
number of this License, you may choose any version ever published (not
|
||||
as a draft) by the Free Software Foundation.
|
||||
@end enumerate
|
||||
|
||||
@page
|
||||
@heading ADDENDUM: How to use this License for your documents
|
||||
|
||||
To use this License in a document you have written, include a copy of
|
||||
the License in the document and put the following copyright and
|
||||
license notices just after the title page:
|
||||
|
||||
@smallexample
|
||||
@group
|
||||
Copyright (C) @var{year} @var{your name}.
|
||||
Permission is granted to copy, distribute and/or modify this document
|
||||
under the terms of the GNU Free Documentation License, Version 1.2
|
||||
or any later version published by the Free Software Foundation;
|
||||
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
||||
Texts. A copy of the license is included in the section entitled ``GNU
|
||||
Free Documentation License''.
|
||||
@end group
|
||||
@end smallexample
|
||||
|
||||
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
|
||||
replace the ``with@dots{}Texts.'' line with this:
|
||||
|
||||
@smallexample
|
||||
@group
|
||||
with the Invariant Sections being @var{list their titles}, with
|
||||
the Front-Cover Texts being @var{list}, and with the Back-Cover Texts
|
||||
being @var{list}.
|
||||
@end group
|
||||
@end smallexample
|
||||
|
||||
If you have Invariant Sections without Cover Texts, or some other
|
||||
combination of the three, merge those two alternatives to suit the
|
||||
situation.
|
||||
|
||||
If your document contains nontrivial examples of program code, we
|
||||
recommend releasing these examples in parallel under your choice of
|
||||
free software license, such as the GNU General Public License,
|
||||
to permit their use in free software.
|
||||
|
||||
@c Local Variables:
|
||||
@c ispell-local-pdict: "ispell-dict"
|
||||
@c End:
|
||||
|
||||
360
doc/glossary.texi
Normal file
360
doc/glossary.texi
Normal file
@@ -0,0 +1,360 @@
|
||||
See also @uref{http://www.dvdrhelp.com/glossary}.
|
||||
|
||||
@table @dfn
|
||||
|
||||
@item ASPI
|
||||
@cindex ASPI
|
||||
See @acronym{Win32 ASPI}
|
||||
|
||||
@item ATA
|
||||
|
||||
Advanced Technology Attachment (ATA). The same things as IDE.
|
||||
|
||||
@item ATAPI
|
||||
|
||||
Advanced Technology Attachment (ATA) Packet Interface. The interface
|
||||
provides a mechanism for transferring and executing SCSI CDBs on IDE
|
||||
CD Drives and DVD Drives.
|
||||
|
||||
IDE (also called ATA) was originally designed for hard drives only,
|
||||
but with help of ATAPI it is possible to connect other devices, in
|
||||
particular CD-ROMS to the IDE/EIDE connections.
|
||||
|
||||
The ATAPI CD-ROM drives understand a subset of MMC commands. In
|
||||
particular multi-initiator commands are neither needed nor deviced for
|
||||
ATAPI devices.
|
||||
|
||||
@item BIN/CUE
|
||||
|
||||
A CD-image format developed by Jeff Arnold for CDRWIN software on
|
||||
Microsoft Windows. Many other programs subsequently support using this
|
||||
format. The @code{.CUE} file is a text file which contains CD format
|
||||
and track layout information, while the @code{.BIN} file holds the
|
||||
actual data of each track.
|
||||
|
||||
@item CD
|
||||
Compact Disc
|
||||
|
||||
@item CD-DA
|
||||
@cindex CD-DA
|
||||
Compact Disc Digital Audio, described in the ``Red Book'' or IEC 60908
|
||||
(formerly IEC 908). This commonly referred to as an audio @acronym{CD}
|
||||
and what most people think of when you play a @acronym{CD} as it was
|
||||
the first to use the @acronym{CD} medium.
|
||||
|
||||
See @url{http://en.wikipedia.org/wiki/Red_Book_(audio_CD_standard)}
|
||||
|
||||
@item CD+G
|
||||
@cindex CD+G
|
||||
|
||||
Compact Disc + Graphics. An extension of the CD audio format contains
|
||||
a limited amount of graphics in subcode channels. This disc works in
|
||||
all audio players but the graphics portion is only available in a
|
||||
special CD+G or Karaoke player.
|
||||
|
||||
@item CD-i
|
||||
@cindex CD-i
|
||||
|
||||
Compact Disc Interactive. An extension of the CD format designed
|
||||
around a set-top computer that connects to a TV to provide interactive
|
||||
home entertainment, including digital audio and video, video games,
|
||||
and software applications. Defined by the ``Green Book'' standard.
|
||||
@uref{http://www.icdia.org/}. CD-i for video and video music has
|
||||
largely (if not totally) been superceded by VCDs.
|
||||
|
||||
@item CD-i Bridge
|
||||
@cindex CD-i Bridge
|
||||
|
||||
A standard allowing CD-ROM XA discs to play on CD-i. Kodak PhotoCDs
|
||||
are CD-XA Bridge discs.
|
||||
|
||||
@item CD-ROM
|
||||
@cindex CD-ROM
|
||||
|
||||
Compact Disc Read Only Memory or ``Yellow Book'' describe in Standards
|
||||
ISO/IEC 10149. The data stored on it can be either in the form of
|
||||
audio, computer or video files.
|
||||
|
||||
@item CD-ROM Mode 1 and Mode2
|
||||
|
||||
The Yellow Book specifies two types of tracks, Mode 1 and Mode 2. Mode
|
||||
1 is used for computer data and text and has an extra error correction
|
||||
layer. Mode 2 is for audio and video data and has no extra correction
|
||||
layer. CD-ROM/XA An expansion of the CD-ROM Mode 2 format that allows
|
||||
both computer and audio/video to be mixed in the same track.
|
||||
|
||||
@item CD Text
|
||||
@cindex CD Text
|
||||
|
||||
CD Text is a technology developed by Sony Corporation and Philips
|
||||
Electronics in 1996 that allows storing in an audio CD and its tracks
|
||||
information such as artist name, title, songwriter, composer, or
|
||||
arranger. Commercially available audio CDs sometimes contain CD Text
|
||||
information.
|
||||
|
||||
@item CD XA
|
||||
@cindex CD XA
|
||||
|
||||
CD-ROM EXtended Architecture. A modification to the CD-ROM
|
||||
specification that defines two new types of sectors. CD-ROM XA was
|
||||
developed jointly by Sony, Philips, and Microsoft, and announced in
|
||||
August 1988. Its specifications were published in an extension to the
|
||||
Yellow Book. CD-i, Photo CD, Video CD and CD-EXTRA have all
|
||||
subsequently been based on CD-ROM XA.
|
||||
|
||||
CD-XA defines another way of formatting sectors on a CD-ROM, including
|
||||
headers in the sectors that describe the type (audio, video, data) and
|
||||
some additional info (markers, resolution in case of a video or audio
|
||||
sector, file numbers, etc).
|
||||
|
||||
The data written on a CD-XA is consistent with and can be in ISO-9660
|
||||
file system format and therefore be readable by ISO-9660 file system
|
||||
translators. But also a CD-I player can also read CD-XA discs even if
|
||||
its own `Green Book' file system only resembles ISO 9660 and isn't
|
||||
fully compatible.
|
||||
|
||||
@item Command Packet
|
||||
@cindex Command Packet
|
||||
|
||||
The data structure that is used to issue an ATAPI command. The same
|
||||
thing as a SCSI Command Descriptor Block (CDB).
|
||||
|
||||
@item FSF
|
||||
@cindex FSF
|
||||
|
||||
Free Software Foundation, @uref{http://www.fsf.org/}
|
||||
|
||||
@item GNU
|
||||
@cindex GNU
|
||||
|
||||
@acronym{GNU} is not @acronym{UNIX}, @uref{http://www.gnu.org/}
|
||||
|
||||
@item IDE
|
||||
|
||||
Integrated Drive Electronics. This is a commonly used interface for
|
||||
hard disk drives and CD-ROM drives. It is less expensive than SCSI,
|
||||
but offers slightly less in terms of performance.
|
||||
|
||||
@item ISO
|
||||
@cindex ISO
|
||||
|
||||
International Standards Organization.
|
||||
|
||||
@item ISO 9660
|
||||
@cindex ISO 9660
|
||||
|
||||
The ISO 9660 is an operating-system independent filesystem format for
|
||||
CD-ROM media and DVD-ROMs. It was standardized in 1988 and replaced the
|
||||
High Sierra standard for the logical format on CD-ROM media (ISO 9660
|
||||
and High Sierra are identical in content, but the exact format is
|
||||
different).
|
||||
|
||||
There are several specification levels. In Level 1, file names must be
|
||||
in the 8.3 format (no more than eight characters in the name, no more
|
||||
than three characters in the suffix) and in capital letters. Directory
|
||||
names can be no longer than eight characters. There can be no more
|
||||
than eight nested directory levels. Level 2 and 3 specifications allow
|
||||
file names up to 32 characters long.
|
||||
|
||||
ECMA-119
|
||||
(@uref{http://www.ecma-international.org/publications/standards/Ecma-119.htm}
|
||||
is the European specification which is identical to ISO 9660.
|
||||
ISO 13490 is basically ISO 9660 with multisession support.
|
||||
|
||||
@item Joliet extensions
|
||||
@cindex Joliet extensions
|
||||
|
||||
This ISO-9660 upward-compatible standard was developed for Windows 95
|
||||
and Windows NT by Microsoft as an extension of ISO 9600 which allows
|
||||
the use of Unicode characters and supports file names up to 64
|
||||
characters.
|
||||
|
||||
See @uref{http://bmrc.berkeley.edu/people/chaffee/jolspec.html} for
|
||||
the Joliet Specification.
|
||||
|
||||
The name Joliet comes from the city in Illinois (U.S) that the
|
||||
standard was defined.
|
||||
|
||||
@item LBA
|
||||
@cindex LBA
|
||||
|
||||
Logical Block Addressing. Mapped integer numbers from CD Red Book
|
||||
Addressing MSF. The starting sector is -150 and ending sector is
|
||||
449849, which correlates directly to MSF: 00:00:00 to 99:59:74.
|
||||
Because an LBA is a single number it is often easier to work with in
|
||||
programming than an MSF.
|
||||
|
||||
@item Lead in
|
||||
@cindex lead in
|
||||
|
||||
The area of a CD where the Table Of Contents (TOC) and CD Text are
|
||||
stored. I think it is supposed to be around 4500 (1 min) or more
|
||||
sectors in length. On a CDR(W) the lead-in length is variable,
|
||||
because each manufacturer will have a different starting position
|
||||
indicated by the ATIP start of lead-in position that is recorded in
|
||||
the ATIP groove on the disk.
|
||||
|
||||
@item LSN
|
||||
@cindex LSN
|
||||
|
||||
Logical Sector Number. Mapped integer numbers from CD Red Book
|
||||
Addressing MSF. The starting sector is 0 and ending sector is 449699,
|
||||
which correlates to MSF: 00:00:00 to 99:59:74. Because an LSN is a
|
||||
single number it is often easier to work with in programming than an
|
||||
MSF. Because it starts at 0 rather than -150 as is the case of an LBA
|
||||
it can be represented as an unsigned value.
|
||||
|
||||
@item MCN
|
||||
@cindex MCN
|
||||
|
||||
Media Catalog Number. A identification number on an audio CD. Also
|
||||
called a UPC. Another identification number is ISRC.
|
||||
|
||||
@item MMC
|
||||
@cindex MMC (Multimedia Commands)
|
||||
|
||||
MMC (Multimedia Commands). A SCSI programming specification made by
|
||||
the SCSI committee T10 organization @url{http://www.t10.org/}. MMC
|
||||
are raw commands for communicating with CDROM drives, CD-Rewriters,
|
||||
DVD-Rewriters, etc.
|
||||
|
||||
Many manufacturers have adopted this standard and it also applies to
|
||||
ATAPI versions of their drives.
|
||||
|
||||
@item Mixed Mode CD
|
||||
@cindex Mixed Mode CD
|
||||
|
||||
A Mixed Mode is a CD that contains tracks of differing CD-ROM Mode
|
||||
formats. In particular the first track may contain both computer data
|
||||
(Yellow Book) CD ROM data while the remaining tracks are audio or
|
||||
video data. Video CD's can be Mixed Mode CDs.
|
||||
|
||||
@item Multisession
|
||||
@cindex Multisession
|
||||
|
||||
A way of writing to a CD that allows more data to be
|
||||
added to readable discs at a later time.
|
||||
|
||||
@item Nero NRG format file
|
||||
@cindex Nero NRG, CD-Image format
|
||||
|
||||
A proprietary CD image file format use by a popular program for
|
||||
Microsoft Windows, Ahead Nero. The specification of this format is
|
||||
not to our knowlege published.
|
||||
|
||||
@item Rock Ridge Extensions
|
||||
@cindex Rock Ridge extensions
|
||||
|
||||
An extension to the ISO-9660 standard which adds POSIX information to files.
|
||||
|
||||
@item SCSI
|
||||
@cindex SCSI
|
||||
|
||||
Small Computer System Interface. A set of ANSI standard electronic
|
||||
interfaces (originally developed at Apple Computer) that allow
|
||||
personal computers to communicate with peripheral hardware such as
|
||||
CD-ROM drives, disk drives, printers, etc.
|
||||
|
||||
@item SCSI CDB
|
||||
@cindex SCSI CDB
|
||||
|
||||
SCSI Command Descriptor Block. The data structure that is used to
|
||||
issue a SCSI command.
|
||||
|
||||
@item SCSI Pass Through Interface.
|
||||
@cindex SCSI Pass Through Interface.
|
||||
|
||||
Yet another way of issuing MMC commands for accessing a CD-ROM. As
|
||||
with MMC or ASPI, the CD-ROM doesn't necessarily have to be a
|
||||
SCSI-attached drive. See also @acronym{MMC} and @acronym{ASPI}.
|
||||
|
||||
@item Session
|
||||
|
||||
A fully readable complete recording that contains one or more tracks
|
||||
of computer data or audio on a CD.
|
||||
|
||||
@item SVCD
|
||||
@cindex Super VCD (SVCD)
|
||||
|
||||
Super @acronym{VCD}
|
||||
|
||||
An improvement of Video CD 2.0 specification which includes most
|
||||
notably a switch from @acronym{MPEG}-1 (constant bit rate encoding) to
|
||||
@acronym{MPEG}-2 (variable bit rate encoding) for the video stream.
|
||||
|
||||
Also added was higher video-stream resolution, up to 4 overlay
|
||||
graphics and text (@dfn{OGT}) sub-channels for user switchable
|
||||
subtitle displaying, closed caption text, and command lists for
|
||||
controlling the @acronym{SVCD} virtual machine.
|
||||
|
||||
See @uref{http://www.dvdrhelp.com/svcd}
|
||||
|
||||
@item TOC
|
||||
@cindex TOC (CD Table of Contents)
|
||||
|
||||
(Compact Disc) Table of Contents. The TOC contains the starting track
|
||||
number, last track number individual track starting time, and some
|
||||
track flags (copy protection, linear audio preemphasis, track format:
|
||||
CDDA or data). Every CD must have at least 1 TOC, the first TOC is
|
||||
always recorded at the start of the CD (lead-in area). A
|
||||
multi-session CD may have several TOCs.
|
||||
|
||||
@item Track
|
||||
@cindex track
|
||||
|
||||
A unit of data of a CD. The size of a track can vary; it can occupy
|
||||
the entire contents of the CD. Most CD standards however require that
|
||||
tracks have a 150 frame (or ``2 second'') lead-in gap.
|
||||
|
||||
@item VCD
|
||||
@cindex Video CD (VCD)
|
||||
|
||||
The Video Compact Disc (@dfn{Video CD} or @dfn{VCD}) is a standardized
|
||||
digital video storage format. It is based on the commonly available
|
||||
Compact Disc technology, which allows for low-cost video authoring.
|
||||
Video CD's can be played in most @acronym{DVD} standalone player,
|
||||
dedicated VCD players and finally, modern Personal Computers with
|
||||
multimedia support.
|
||||
|
||||
A Video CD is made up of @acronym{CD-ROM XA} sectors,
|
||||
i.e. @acronym{CD-ROM} mode 2 form 1 & 2 sectors. Non-@acronym{MPEG} data
|
||||
is stored in mode 2 form 1 sectors with a user data area of 2048 byte,
|
||||
which have a similiar L2 error correction and detection
|
||||
(@acronym{ECC}/@acronym{EDC}) to @acronym{CD-ROM} mode 1 sectors. While
|
||||
realtime @acronym{MPEG} streams is stored in @acronym{CD-ROM} mode 2
|
||||
form 2 sectors, which by have no L2 @acronym{ECC}, yield a ~14% greater
|
||||
user data area consisting of 2324 bytes@footnote{actually raw mode 2
|
||||
sectors have a 2336 byte user data area, but parts of it are used for
|
||||
error codes and headers when using the mode 2 form 1 or form 2
|
||||
configurations.}
|
||||
|
||||
@uref{http://www.dvdrhelp.com/vcd}
|
||||
|
||||
@item Win32 ASPI
|
||||
@cindex ASPI
|
||||
|
||||
The ASPI interface specification was developed by Adaptec for
|
||||
sending commands to a SCSI host adapter (such as those controlling CD
|
||||
and DVD drives) and used on Window 9x/NT and later. Emulation for
|
||||
ATAPI drives was added so that the same sets of commands worked those
|
||||
even though the drives might not be SCSI nor might there even be a
|
||||
SCSI controller attached.
|
||||
|
||||
However in Windows NT/2K/XP, Microsoft provides their Win32 ioctl
|
||||
interface, and has take steps to make using ASPI more inaccessible
|
||||
(e.g. requiring adminstrative access to use ASPI).
|
||||
|
||||
See also @acronym{MMC}
|
||||
|
||||
@item Win32 ioctl driver
|
||||
|
||||
Ioctl (Input Output ConTroLs). A Win32 function, implemented in all
|
||||
Microsoft Windows. It is used for sending commands to devices using
|
||||
defined codes and structures.
|
||||
|
||||
@item XA
|
||||
@cindex XA
|
||||
|
||||
See @acronym{CD-ROM XA}
|
||||
|
||||
@end table
|
||||
2421
doc/libcdio.texi
Normal file
2421
doc/libcdio.texi
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user