gitchangelog.sh: state inside comments that GNU sed is required
[cdimgtools:cdimgtools.git] / README
1 README for CDimgtools
2 =====================
3
4 CDimgtools is a set of command line tools to inspect and manipulate CD/DVD
5 optical disc images of formats uncommon on free UNIX-like systems (like
6 GNU/Linux or BSD).
7
8 One sort of tool is concerned with a certain special image file format,
9 possibly a non open one.  It can print information about an image file in this
10 format, or extract parts of its data (e.g. audio tracks or disc sessions) to
11 files in ``raw'' format, so that they can be further processed by more widely
12 available tools (e.g. for the purpose of playing audio, reading files, burning
13 tracks or sessions to optical media).
14
15 * NRG is the only supported format for the present.
16
17 Another sort of tool is concerned with the processing of files in a ``raw''
18 format.  It can convert between different variations of formats of the same
19 type, or convert from a raw format to an equivalent well-known self-describing
20 format, or modify the raw data without changing its format.  For the present it
21 is possible:
22
23 * to demultiplex RAW+96 image files containing both stream data and sub-channel
24   data,
25
26 * to decrypt CSS-scrambled VOB files,
27
28 * and to decrypt CSS-scrambled DVD Video image files.
29
30 CDimgtools was mainly written under a GNU/Linux OS but should work under other
31 UNIX flavours, and perhaps even on other platforms, albeit maybe only partially
32 (see the file link:INSTALL.html['INSTALL'] for a list of dependencies).
33
34
35 Commands in the package
36 -----------------------
37
38 linkpage:raw96cdconv[1]::
39         This command is a Perl script that demultiplexes/multiplexes stream data
40         (audio, raw data or .iso format data) and sub-channel data from a RAW+96
41         image file.  It handles optical disc images containing stream data and
42         sub-channel data of a given sector at contiguous positions; this kind of
43         image file may be either directly created by a ripping program like
44         readcd(1) or cdrdao(1), or extracted from another image file by nrgtool(1).
45
46 linkpage:nrgtool[1]::
47         This command is a Perl script that reads .nrg images (created by Nero),
48         prints the metadata about the image, and extracts, for each track, the raw
49         data to a separate file; disc types such as CDDA, CD-extra and
50         (multi-session) CD-ROM/DVD-ROM are supported.
51
52 linkpage:cssdec[1]::
53         This command decrypts CSS-scrambled VOB files or streams found on DVD Video
54         discs; the title key is obtained transparently by libdvdcss.
55
56 linkpage:dvdimgdecss[1]::
57         This command decrypts CSS-scrambled DVD Video discs or image files; it
58         writes a similar image file containing the same data at the same location;
59         the UDF filesystem of the disc is left intact.
60
61
62 Resources
63 ---------
64 * The official homepage is at link:https://gna.org/projects/cdimgtools[Gna!].
65   There you might find up-to-date information and releases.
66
67 * UNIX manual pages that contain usage examples are available for each command.
68
69 * Known bugs and limitations are mentioned in the section about <<bugs, issues>>.
70
71 * Release notes listing important user-visible changes are available in a
72   separate file link:NEWS.html['NEWS'].
73
74
75 [[dependencies]]
76 Installation instructions
77 -------------------------
78 Download and installation instructions and a list of dependencies can be found
79 in the file link:INSTALL.html['INSTALL'].
80
81
82 // Information about bugs and limitations can be found in the file 'BUGS'.
83 include::BUGS[]
84
85
86 Credits & License
87 -----------------
88 CDimgtools was written by GĂ©raud Meyer (g_raud chez gna.org).
89
90 CDimgtools is free software; you can redistribute it and/or modify it under the
91 terms of the GNU General Public License version 2 as published by the Free
92 Software Foundation.
93
94 This package is distributed in the hope that it will be useful, but WITHOUT ANY
95 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
96 PARTICULAR PURPOSE.  See the GNU General Public License for more details.
97
98 The full text of the license can be found in the root directory of the project
99 sources, in the file 'COPYING'.  Otherwise see <http://www.gnu.org/licenses/>.