.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" 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 "URI::Split 3pm" .TH URI::Split 3pm "2016-01-11" "perl v5.22.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" URI::Split \- Parse and compose URI strings .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use URI::Split qw(uri_split uri_join); \& ($scheme, $auth, $path, $query, $frag) = uri_split($uri); \& $uri = uri_join($scheme, $auth, $path, $query, $frag); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Provides functions to parse and compose \s-1URI\s0 strings. The following functions are provided: .ie n .IP "($scheme, $auth, $path, $query, $frag) = uri_split($uri)" 4 .el .IP "($scheme, \f(CW$auth\fR, \f(CW$path\fR, \f(CW$query\fR, \f(CW$frag\fR) = uri_split($uri)" 4 .IX Item "($scheme, $auth, $path, $query, $frag) = uri_split($uri)" Breaks up a \s-1URI\s0 string into its component parts. An \f(CW\*(C`undef\*(C'\fR value is returned for those parts that are not present. The \f(CW$path\fR part is always present (but can be the empty string) and is thus never returned as \f(CW\*(C`undef\*(C'\fR. .Sp No sensible value is returned if this function is called in a scalar context. .ie n .IP "$uri = uri_join($scheme, $auth, $path, $query, $frag)" 4 .el .IP "\f(CW$uri\fR = uri_join($scheme, \f(CW$auth\fR, \f(CW$path\fR, \f(CW$query\fR, \f(CW$frag\fR)" 4 .IX Item "$uri = uri_join($scheme, $auth, $path, $query, $frag)" Puts together a \s-1URI\s0 string from its parts. Missing parts are signaled by passing \f(CW\*(C`undef\*(C'\fR for the corresponding argument. .Sp Minimal escaping is applied to parts that contain reserved chars that would confuse a parser. For instance, any occurrence of '?' or '#' in \f(CW$path\fR is always escaped, as it would otherwise be parsed back as a query or fragment. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\s-1URI\s0, URI::Escape .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2003, Gisle Aas .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.