.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Device::Cdio::ISO9660::IFS 3pm" .TH Device::Cdio::ISO9660::IFS 3pm "2017-11-02" "perl v5.26.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Device::Cdio::ISO9660::IFS \- Class for ISO 9660 Filesystem image reading .SH "SYNOPSIS" .IX Header "SYNOPSIS" This encapsulates \s-1ISO 9660\s0 Filesystem Image handling. The class is often used in conjunction with Device::Cdio::ISO9660. .PP .Vb 2 \& use Device::Cdio::ISO9660; \& use Device::Cdio::ISO9660::IFS; \& \& $iso = Device::Cdio::ISO9660::IFS\->new(\-source=>\*(Aqcopying.iso\*(Aq); \& \& my $id = $iso\->get_application_id(); \& $id = $iso\->get_preparer_id(); \& $id = $iso\->get_publisher_id(); \& $id = $iso\->get_system_id(); \& $id = $iso\->get_volume_id(); \& $id = $iso\->get_volumeset_id(); \& \& my $path = \*(Aq/\*(Aq; \& @file_stats = $iso\->readdir($path); \& foreach my $href (@file_stats) { \& printf "%s [LSN %6d] %8d %s %s%s\en", \& $href\->{is_dir} ? "d" : "\-", \& $href\->{LSN}, $href\->{size}, \& $href\->{tm}\->{year}, \& $path, \& Device::Cdio::ISO9660::name_translate($href\->{filename}); \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is an Object-Oriented interface to the \s-1GNU CD\s0 Input and Control library (\f(CW\*(C`libcdio\*(C'\fR) which is written in C. This class handles \s-1ISO 9660\s0 aspects of an \s-1ISO 9600\s0 image. .PP An \s-1ISO\-9660\s0 image is distinct from a \s-1CD\s0 in a CD-ROM which has \s-1ISO\-9660\s0 tracks; the latter contains other CD-like information (e.g. tracks, information or associated with the \s-1CD\s0). An \s-1ISO\-9660\s0 filesystem image on the other hand doesn't and is generally file in some file system, sometimes with the file extension \*(L".iso\*(R"; perhaps it can be burned into a \s-1CD\s0 with a suitable tool, perhaps is can be \*(L"mounted\*(R" as a filesystem on some \s-1OS\s0's. .SS "\s-1CALLING ROUTINES\s0" .IX Subsection "CALLING ROUTINES" Routines accept named parameters as well as positional parameters. For named parameters, each argument name is preceded by a dash. For example: .PP .Vb 1 \& Device::Cdio::ISO9660::IFS\->new(\-source=>\*(AqMYISO.ISO\*(Aq) .Ve .PP Each argument name is preceded by a dash. Neither case nor order matters in the argument list. \-driver_id, \-Driver_ID, and \-DRIVER_ID are all acceptable. In fact, only the first argument needs to begin with a dash. If a dash is present in the first argument, we assume dashes for the subsequent parameters. .PP In the documentation below and elsewhere in this package the parameter name that can be used in this style of call is given in the parameter list. For example, for \*(L"open\*(R" the documentation below reads: .PP .Vb 1 \& open(source, iso_mask=$pyiso9660::EXTENSION_NONE)\->bool .Ve .PP So the parameters are \*(L"source\*(R", and \*(L"is_mask\*(R". The iso_mask parameter is not required and if not specified a value of \&\f(CW$perliso9660:EXTENSION_NON\fR will be used. .PP The older, more traditional style of positional parameters is also supported. So the "have_driver example from above can also be written: .PP .Vb 1 \& Cdio::open($s, $i) .Ve .PP Finally, since no parameter name can be confused with an integer, negative values will not get confused as a named parameter. .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" .Vb 1 \& new(source, iso_mask)\->$iso9660_object .Ve .PP Create a new \s-1ISO 9660\s0 object. Source or iso_mask is optional. .PP If source is given, \fIopen()\fR is called using that and the optional iso_mask parameter; iso_mask is used only if source is specified. If source is given but opening fails, undef is returned. If source is not given, an object is always returned. .SS "close" .IX Subsection "close" .Vb 1 \& close()\->bool .Ve .PP Close previously opened \s-1ISO 9660\s0 image and free resources associated with \s-1ISO9660.\s0 Call this when done using using an \s-1ISO 9660\s0 image. .SS "find_lsn" .IX Subsection "find_lsn" .Vb 1 \& find_lsn(lsn)\->$stat_href .Ve .PP Find the filesystem entry that contains \s-1LSN\s0 and return file stat information about it. \f(CW\*(C`undef\*(C'\fR is returned on error. .SS "get_application_id" .IX Subsection "get_application_id" .Vb 1 \& get_application_id()\->$id .Ve .PP Get the application \s-1ID\s0 stored in the Primary Volume Descriptor. undef is returned if there is some problem. .SS "get_preparer_id" .IX Subsection "get_preparer_id" .Vb 1 \& get_preparer_id()\->$id .Ve .PP Get the preparer \s-1ID\s0 stored in the Primary Volume Descriptor. undef is returned if there is some problem. .SS "get_publisher_id" .IX Subsection "get_publisher_id" .Vb 1 \& get_publisher_id()\->$id .Ve .PP Get the publisher \s-1ID\s0 stored in the Primary Volume Descriptor. undef is returned if there is some problem. .SS "get_root_lsn" .IX Subsection "get_root_lsn" .Vb 1 \& get_root_lsn()\->$lsn .Ve .PP Get the Root \s-1LSN\s0 stored in the Primary Volume Descriptor. undef is returned if there is some problem. .SS "get_system_id" .IX Subsection "get_system_id" .Vb 1 \& get_system_id()\->$id .Ve .PP Get the Volume \s-1ID\s0 stored in the Primary Volume Descriptor. undef is returned if there is some problem. .SS "get_volume_id" .IX Subsection "get_volume_id" .Vb 1 \& get_volume_id()\->$id .Ve .PP Get the Volume \s-1ID\s0 stored in the Primary Volume Descriptor. undef is returned if there is some problem. .SS "get_volumeset_id" .IX Subsection "get_volumeset_id" .Vb 1 \& get_volume_id()\->$id .Ve .PP Get the Volume \s-1ID\s0 stored in the Primary Volume Descriptor. undef is returned if there is some problem. .SS "open" .IX Subsection "open" .Vb 1 \& open(source, iso_mask=$perliso9660::EXTENSION_NONE)\->bool .Ve .PP Open an \s-1ISO 9660\s0 image for reading. Subsequent operations will read from this \s-1ISO 9660\s0 image. .PP This should be called before using any other routine except possibly new. It is implicitly called when a new is done specifying a source. .PP If device object was previously opened it is closed first. .PP See also open_fuzzy. .SS "open_fuzzy" .IX Subsection "open_fuzzy" open_fuzzy(source, iso_mask=$perliso9660::EXTENSION_NONE, fuzz=20)\->bool .PP Open an \s-1ISO 9660\s0 image for reading. Subsequent operations will read from this \s-1ISO 9660\s0 image. Some tolerence allowed for positioning the \&\s-1ISO9660\s0 image. We scan for \f(CW$perliso9660::STANDARD_ID\fR and use that to set the eventual offset to adjust by (as long as that is <= \f(CW$fuzz\fR). .PP This should be called before using any other routine except possibly new (which must be called first. It is implicitly called when a new is done specifying a source. .PP See also open. .SS "read_fuzzy_superblock" .IX Subsection "read_fuzzy_superblock" read_fuzzy_superblock(iso_mask=$perliso9660::EXTENSION_NONE, fuzz=20)\->bool .PP Read the Super block of an \s-1ISO 9660\s0 image but determine framesize and datastart and a possible additional offset. Generally here we are not reading an \s-1ISO 9660\s0 image but a CD-Image which contains an \s-1ISO 9660\s0 filesystem. .SS "readdir" .IX Subsection "readdir" readdir(dirname)\->@iso_stat .PP Read path (a directory) and return a list of iso9660 stat references .PP See \*(L"stat_array_to_href\*(R" in Device::Cdio::ISO9660 for description of each hash refererence in \f(CW@stat\fR that is returned. .PP If you look at iso9660.h you'll see more fields, such as for Rock-Ridge specific fields or \s-1XA\s0 specific fields. Volunteers? .SS "read_pvd" .IX Subsection "read_pvd" .Vb 1 \& read_pvd()\->pvd .Ve .PP Read the Super block of an \s-1ISO 9660\s0 image. This is the Primary Volume Descriptor (\s-1PVD\s0) and perhaps a Supplemental Volume Descriptor if (Joliet) extensions are acceptable. .SS "read_superblock" .IX Subsection "read_superblock" .Vb 1 \& read_superblock(iso_mask=$perliso9660::EXTENSION_NONE)\->bool .Ve .PP Read the Super block of an \s-1ISO 9660\s0 image. This is the Primary Volume Descriptor (\s-1PVD\s0) and perhaps a Supplemental Volume Descriptor if (Joliet) extensions are acceptable. .SS "seek_read" .IX Subsection "seek_read" seek_read(start, size=1)\->(size, str) .PP Seek to a position and then read n bytes. Size read is returned. .SS "stat" .IX Subsection "stat" stat(path, translate=0)\->\e%stat .PP Return file status for path name psz_path. \f(CW\*(C`undef\*(C'\fR is returned on error. .PP If translate is 1, version numbers in the \s-1ISO 9660\s0 name are dropped, i.e. ;1 is removed and if level 1 \s-1ISO\-9660\s0 names are lowercased. .PP See \*(L"stat_array_to_href\*(R" in Device::Cdio::ISO9660 for description of \f(CW\*(C`\e%stat\*(C'\fR hash reference that is returned. .SH "SEE ALSO" .IX Header "SEE ALSO" See also Device::Cdio for module information, Device::Cdio::ISO9660::FS and Device::Cdio::Device for device objects and Device::Cdio::Track for track objects. .PP perliso9660 is the lower-level interface to \f(CW\*(C`libiso9660\*(C'\fR, the \s-1ISO 9660\s0 library of . .PP is documentation via doxygen of \f(CW\*(C`libiso9660\*(C'\fR. doxygen. .SH "AUTHORS" .IX Header "AUTHORS" Rocky Bernstein \f(CW\*(C`\*(C'\fR. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2006, 2007, 2008, 2017 Rocky Bernstein .PP This program is free software: you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \&\s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this program. If not, see The \s-1GNU\s0 General Public License .