.\" 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 3pm" .TH Device::Cdio::ISO9660 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 \- Module for ISO 9660 handling .SH "SYNOPSIS" .IX Header "SYNOPSIS" This encapsulates \s-1IS9660\s0 filesystem handling. This library however needs to be used in conjunction with Device::Cdio, Device::Cdio::ISO9660::IFS and Device::Cdio::ISO9660::FS. .PP .Vb 3 \& use Device::Cdio::ISO9660; \& $name = Device::Cdio::ISO9660::name_translate(\*(AqCOPYING.;1\*(Aq); \& $bool = Device::Cdio::ISO9660::is_achar(\*(AqA\*(Aq); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is an Object-Oriented Perl interface to the \s-1GNU CD\s0 Input and Control library's \s-1ISO 9660\s0 library, \f(CW\*(C`libiso9660\*(C'\fR. .PP Encapsulation is done in two parts. The lower-level Perl interface is called perliso9660 and is generated by \s-1SWIG.\s0 .PP The more object-oriented package Device::Cdio::ISO9660 and uses \&\f(CW\*(C`perliso9660\*(C'\fR. Actually, there are no objects in Device::Cdio::ISO9660, but there are in its sub packages Device::Cdio::ISO9660::IFS, Device::Cdio::ISO9660::FS (and in the future Device::Cdio::ISO9660::PVD). .PP Although \f(CW\*(C`perliso9660\*(C'\fR is perfectly usable on its own, it is expected that these module and classes are what most people will use. As perliso9660 more closely models the C interface, it is conceivable (if unlikely) that die-hard \f(CW\*(C`libiso9660\*(C'\fR C users who are very familiar with that interface could prefer that. .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::is_achar(\-achar=>\*(AqM\*(Aq) .Ve .PP Each argument name is preceded by a dash. Neither case nor order matters in the argument list. \-achar, \-AChar, and \-ACHAR 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 \f(CW\*(C`name_translate\*(C'\fR the documentation below reads: .PP .Vb 1 \& name_translate(name, joliet_level=0) \-> $str .Ve .PP So the parameter names are \*(L"name\*(R" and \*(L"joliet_level\*(R". Only the \*(L"name\*(R" parameter is required. If \*(L"joliet_level\*(R" is not specified, a value of 0 will be used. The return value is a string. .PP The older, more traditional style of positional parameters is also supported which is shown in the synopsis above. .PP Finally, since no parameter name can be confused with a an integer, negative values will not get confused as a named parameter. .SH "SUBROUTINES" .IX Header "SUBROUTINES" .SS "dirname_valid_p" .IX Subsection "dirname_valid_p" .Vb 1 \& dirname_valid_p(path)\->bool .Ve .PP Check that path is a valid \s-1ISO\-9660\s0 directory name. .PP A valid directory name should not start out with a slash (/), dot (.) or null byte, should be less than 37 characters long, have no more than 8 characters in a directory component which is separated by a /, and consist of only DCHARs. .PP True is returned if path is valid. .SS "is_achar" .IX Subsection "is_achar" .Vb 1 \& is_dchar(achar)\->bool .Ve .PP Return 1 if \f(CW$achar\fR is an \s-1ACHAR.\s0 \f(CW$achar\fR should either be a string of length one or the \fIord()\fR of a string of length 1. .PP These are the \s-1DCHAR\s0's plus some \s-1ASCII\s0 symbols including the space symbol. .SS "is_dchar" .IX Subsection "is_dchar" .Vb 1 \& is_dchar(dchar)\->bool .Ve .PP Return 1 if \f(CW$dchar\fR is a \s-1DCHAR\s0 \- a character that can appear in an an \&\s-1ISO\-9600\s0 level 1 directory name. These are the \s-1ASCII\s0 capital letters A\-Z, the digits 0\-9 and an underscore. .PP \&\f(CW$dchar\fR should either be a string of length one or the \fIord()\fR of a string of length 1. .SS "pathname_valid_p" .IX Subsection "pathname_valid_p" .Vb 1 \& pathname_valid_p(path)\->bool .Ve .PP Check that path is a valid \s-1ISO\-9660\s0 pathname. .PP A valid pathname contains a valid directory name, if one appears and the filename portion should be no more than 8 characters for the file prefix and 3 characters in the extension (or portion after a dot). There should be exactly one dot somewhere in the filename portion and the filename should be composed of only DCHARs. .PP 1 is returned if path is valid. .SS "name_translate" .IX Subsection "name_translate" .Vb 1 \& name_translate(name, joliet_level=0)\->$str .Ve .PP Convert an \s-1ISO\-9660\s0 file name of the kind that is that stored in a \s-1ISO 9660\s0 directory entry into what's usually listed as the file name in a listing. Lowercase name if no Joliet Extension interpretation. Remove trailing ;1's or .;1's and turn the other ;'s into version numbers. .PP If joliet_level is not given it is 0 which means use no Joliet Extensions. Otherwise use the specified the Joliet level. .PP The translated string is returned and it will be larger than the input filename. .SS "stat_array_to_href" .IX Subsection "stat_array_to_href" .Vb 1 \& stat_array_to_href(values)\->href .Ve .PP Convert a \s-1ISO 9660\s0 array to an hash reference of the values. .PP Used internally in convert from C code. .PP Note, we modify the input parameter. .PP A hash reference which contains: .IP "\s-1LSN\s0" 4 .IX Item "LSN" the Logical sector number (an integer) .IP "size" 4 .IX Item "size" the total size of the file in bytes .IP "sec_size" 4 .IX Item "sec_size" the number of sectors allocated .IP "filename" 4 .IX Item "filename" the file name of the statbuf entry .IP "\s-1XA\s0" 4 .IX Item "XA" if the file has \s-1XA\s0 attributes; 0 if not .IP "is_dir" 4 .IX Item "is_dir" 1 if a directory; '' if a not. .IP "tm" 4 .IX Item "tm" A \s-1POSIX\s0 time structure as often return in unis \f(CW\*(C`localtime()\*(C'\fR or \f(CW\*(C`gmtime()\*(C'\fR. However we adjust the year to be \*(L"normal\*(R", e.g. we use 2017 instead of 117 and months start at 1 (for January), not 0. Fields in \f(CW\*(C`tm\*(C'\fR are: .Sp .Vb 9 \& sec # Seconds (0\-60) \& min # Minutes (0\-59) \& hour # Hours (0\-23) \& mday # Day of the month (1\-31) \& mon # Month (1\-12) \& year # Year, e.g. 2017 \& wday # Day of the week (0\-6, Sunday = 0) \& yday # Day in the year (0\-365, 1 Jan = 0) */ \& isdst # Daylight saving time */ .Ve .SS "strncpy_pad" .IX Subsection "strncpy_pad" .Vb 1 \& strncpy_pad(name, len, check=\*(Aqnocheck\*(Aq)\->str .Ve .PP Pad string \fIname\fR with spaces to size len and return this. If len is less than the length of \fIname\fR, the return value will be truncated to the first \fIlen\fR characters of \fIname\fR. .PP \&\fIname\fR can also be scanned to see if it contains only ACHARs, DCHARs, or 7\-bit \s-1ASCII\s0 chars, and this is specified via the \fIcheck\fR parameter. If the \fIcheck\fR parameter is given it must be one of the 'nocheck', \&'7bit', 'achars' or 'dchars'. Case is not significant. .SH "SEE ALSO" .IX Header "SEE ALSO" Device::Cdio::ISO9660::IFS is the \s-1ISO 96600\s0 filesystem image interface. Device::Cdio::ISO9660::FS is the \s-1ISO 96600\s0 CD-image interface. Device::Cdio has general information on the \s-1CD\s0 Input and Control Library. Device::Cdio::Device is for device objects and Device::Cdio::Track is for track objects. .PP perliso9660 is the lower-level interface to libcdio. .PP has documentation on libcdio including the a manual and the \s-1API\s0 via doxygen. .SH "AUTHORS" .IX Header "AUTHORS" Rocky Bernstein .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2006, 2011, 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 .