man-pages/man3/URI::Split.3pm.html
2021-03-31 01:06:50 +01:00

109 lines
2.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of URI::Split</TITLE>
</HEAD><BODY>
<H1>URI::Split</H1>
Section: User Contributed Perl Documentation (3pm)<BR>Updated: 2020-02-08<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>
URI::Split - Parse and compose URI strings
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
use URI::Split qw(uri_split uri_join);
($scheme, $auth, $path, $query, $frag) = uri_split($uri);
$uri = uri_join($scheme, $auth, $path, $query, $frag);
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
Provides functions to parse and compose <FONT SIZE="-1">URI</FONT>
strings. The following functions are provided:
<DL COMPACT>
<DT id="1">($scheme, $auth, $path, $query, $frag) = uri_split($uri)<DD>
Breaks up a <FONT SIZE="-1">URI</FONT> string into its component
parts. An <TT>&quot;undef&quot;</TT> value is returned for those parts that are not
present. The <TT>$path</TT> part is always present (but can be the empty
string) and is thus never returned as <TT>&quot;undef&quot;</TT>.
<P>
No sensible value is returned if this function is called in a scalar
context.
<DT id="2">$uri = uri_join($scheme, $auth, $path, $query, $frag)<DD>
Puts together a <FONT SIZE="-1">URI</FONT> string from its parts.
Missing parts are signaled by passing <TT>&quot;undef&quot;</TT> for the corresponding
argument.
<P>
Minimal escaping is applied to parts that contain reserved chars
that would confuse a parser. For instance, any occurrence of '?' or '#'
in <TT>$path</TT> is always escaped, as it would otherwise be parsed back
as a query or fragment.
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>SEE ALSO</H2>
<FONT SIZE="-1">URI</FONT>, URI::Escape
<A NAME="lbAF">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright 2003, Gisle Aas
<P>
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="3"><A HREF="#lbAB">NAME</A><DD>
<DT id="4"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="5"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="6"><A HREF="#lbAE">SEE ALSO</A><DD>
<DT id="7"><A HREF="#lbAF">COPYRIGHT</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:59 GMT, March 31, 2021
</BODY>
</HTML>