man-pages/man3/Dpkg::Source::Format.3perl.html
2021-03-31 01:06:50 +01:00

139 lines
2.9 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of Dpkg::Source::Format</TITLE>
</HEAD><BODY>
<H1>Dpkg::Source::Format</H1>
Section: libdpkg-perl (3perl)<BR>Updated: 2020-03-23<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
Dpkg::Source::Format - manipulate debian/source/format files
<A NAME="lbAC">&nbsp;</A>
<H2>DESCRIPTION</H2>
This module provides an object that can manipulate Debian source
package <I>debian/source/format</I> files.
<A NAME="lbAD">&nbsp;</A>
<H2>METHODS</H2>
<DL COMPACT>
<DT id="1">$f = Dpkg::Source::Format-&gt;new(%opts)<DD>
Creates a new object corresponding to a source package's
<I>debian/source/format</I> file. When the key <B>filename</B> is set, it will
be used to parse and set the format. Otherwise if the <B>format</B> key is
set it will be validated and used to set the format.
<DT id="2">$f-&gt;set_from_parts($major[, $minor[, $variant]])<DD>
Sets the source format from its parts. The <TT>$major</TT> part is mandatory.
The <TT>$minor</TT> and <TT>$variant</TT> parts are optional.
<P>
<B>Notice</B>: This function performs no validation.
<DT id="3">($major, $minor, $variant) = $f-&gt;set($format)<DD>
Sets (and validates) the source <TT>$format</TT> specified. Will return the parsed
format parts as a list, the optional <TT>$minor</TT> and <TT>$variant</TT> parts might be
undef.
<DT id="4">($major, $minor, $variant) = $f-&gt;<B>get()</B><DD>
<DT id="5">$format = $f-&gt;<B>get()</B><DD>
Gets the source format, either as properly formatted scalar, or as a list
of its parts, where the optional <TT>$minor</TT> and <TT>$variant</TT> parts might be undef.
<DT id="6">$count = $f-&gt;parse($fh, $desc)<DD>
Parse the source format string from <TT>$fh</TT>, with filehandle description <TT>$desc</TT>.
<DT id="7">$count = $f-&gt;load($filename)<DD>
Parse <TT>$filename</TT> contents for a source package format string.
<DT id="8">$str = $f-&gt;output([$fh])<DD>
<DT id="9">&quot;$f&quot;<DD>
Returns a string representing the source package format version.
If <TT>$fh</TT> is set, it prints the string to the filehandle.
<DT id="10">$f-&gt;save($filename)<DD>
Save the source package format into the given <TT>$filename</TT>.
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>CHANGES</H2>
<A NAME="lbAF">&nbsp;</A>
<H3>Version 1.00 (dpkg 1.19.3)</H3>
Mark the module as public.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="11"><A HREF="#lbAB">NAME</A><DD>
<DT id="12"><A HREF="#lbAC">DESCRIPTION</A><DD>
<DT id="13"><A HREF="#lbAD">METHODS</A><DD>
<DT id="14"><A HREF="#lbAE">CHANGES</A><DD>
<DL>
<DT id="15"><A HREF="#lbAF">Version 1.00 (dpkg 1.19.3)</A><DD>
</DL>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:39 GMT, March 31, 2021
</BODY>
</HTML>