ヤミRoot VoidGate

Viewing: PDF::Parse.3pm

.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PDF::Parse 3"
.TH PDF::Parse 3 "2000-02-08" "perl v5.16.3" "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"
PDF::Parse \- Library with parsing functions for PDF library
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use PDF::Parse;
\&
\&  $pdf\->TargetFile($filename);
\&  $pdf\->LoadPageInfo;
\&
\&  $version = $pdf\->Version;
\&  $bool = $pdf\->IsaPDF;
\&  $bool = $pdf\->IscryptPDF;
\&
\&  $info = $pdf\->GetInfo ($key);
\&  $pagenum = $pdf\->Pages;
\&
\&  @size = $pdf\->PageSize ($page);
\&  # or
\&  @size = $pdf\->PageSize;
\&
\&  $rotation = $pdf\->PageRotation ($page);
\&  # or
\&  $rotation = $pdf\->PageRotation;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The main purpose of the PDF::Parse library is to provide parsing functions
for the more general \s-1PDF\s0 library.
.SH "Methods"
.IX Header "Methods"
The available methods are:
.SS "TargetFile ( filename )"
.IX Subsection "TargetFile ( filename )"
This method links the filename to the pdf descriptor and parses all
kind of header information.
.SS "LoadPageInfo"
.IX Subsection "LoadPageInfo"
This function loads the information for all pages. This process can
take some time for big PDF-files.
.SS "Version"
.IX Subsection "Version"
Returns the \s-1PDF\s0 version used for writing the object file.
.SS "IsaPDF"
.IX Subsection "IsaPDF"
Returns true, if the file could be parsed and is a PDF-file.
.SS "IscryptPDF"
.IX Subsection "IscryptPDF"
Returns true if the \s-1PDF\s0 contains a crypt object. This indicates that
the data of the PDF-File is encrypted. In this case, not all function
work as expected.
.SS "GetInfo ( key )"
.IX Subsection "GetInfo ( key )"
Returns the various information contained in the info section of a \s-1PDF\s0
file (if present). A \s-1PDF\s0 file can have:
.PP
.Vb 8
\&  a title ==> GetInfo ("Title")
\&  a subject ==> GetInfo ("Subject")
\&  an author ==> GetInfo("Author")
\&  a creation date ==> GetInfo("CreationDate")
\&  a creator ==> GetInfo("Creator")
\&  a producer ==> GetInfo("Producer")
\&  a modification date ==> GetInfo("ModDate")
\&  some keywords ==> GetInfo("Keywords")
.Ve
.SS "Pages"
.IX Subsection "Pages"
Returns the number of pages of the PDF-file.
.SS "PageSize ( [ page ] )"
.IX Subsection "PageSize ( [ page ] )"
Returns the size of a page in the PDF-file. If no parameter is given,
the default size of the root page will be returned. This value may be
overridden for any page.
.PP
If the size of an individual page is requested and the page data is
not already loaded, the method \fBLoadPageInfo\fR will be executed. This
may take some time for large PDF-files. The size of the root page is
always available and will never execute \fBLoadPageInfo\fR.
.SS "PageRotation ( [ page ] )"
.IX Subsection "PageRotation ( [ page ] )"
Returns the rotation of a page in the PDF-file. If no parameter is given,
the default rotation of the root page will be returned. This value may be
overridden for any page.
.PP
If the rotation of an individual page is requested and the page data is
not already loaded, the method \fBLoadPageInfo\fR will be executed. This
may take some time for large PDF-files. The rotation of the root page is
always available and will never execute \fBLoadPageInfo\fR.
.SH "Variables"
.IX Header "Variables"
The only available variable is :
.ie n .IP "\fB\fB$PDF::Parse::VERSION\fB\fR" 4
.el .IP "\fB\f(CB$PDF::Parse::VERSION\fB\fR" 4
.IX Item "$PDF::Parse::VERSION"
Contains the version of the library installed
.SH "Copyright"
.IX Header "Copyright"
.Vb 1
\&  Copyright (c) 1998 \- 2000 Antonio Rosella Italy antro@tiscalinet.it, Johannes Blach dw235@yahoo.com
.Ve
.PP
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.SH "Availability"
.IX Header "Availability"
The latest version of this library is likely to be available from:
.PP
http://www.geocities.com/CapeCanaveral/Hangar/4794/
User / IP	: 216.73.216.110
Host / Server	: 146.88.233.70 / dev.loger.cm
System	: Linux hybrid1120.fr.ns.planethoster.net 3.10.0-957.21.2.el7.x86_64 #1 SMP Wed Jun 5 14:26:44 UTC 2019 x86_64