local-lib5/man/man3/URI::Heuristic.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "URI::Heuristic 3"
 132 .TH URI::Heuristic 3 "2008-08-21" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 URI::Heuristic \- Expand URI using heuristics
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 6
 138 \& use URI::Heuristic qw(uf_uristr);
 139 \& $u = uf_uristr("perl");             # http://www.perl.com
 140 \& $u = uf_uristr("www.sol.no/sol");   # http://www.sol.no/sol
 141 \& $u = uf_uristr("aas");              # http://www.aas.no
 142 \& $u = uf_uristr("ftp.funet.fi");     # ftp://ftp.funet.fi
 143 \& $u = uf_uristr("/etc/passwd");      # file:/etc/passwd
 144 .Ve
 145 .SH "DESCRIPTION"
 146 .IX Header "DESCRIPTION"
 147 This module provides functions that expand strings into real absolute
 148 URIs using some built-in heuristics.  Strings that already represent
 149 absolute URIs (i.e. that start with a \f(CW\*(C`scheme:\*(C'\fR part) are never modified
 150 and are returned unchanged.  The main use of these functions is to
 151 allow abbreviated URIs similar to what many web browsers allow for URIs
 152 typed in by the user.
 153 .PP
 154 The following functions are provided:
 155 .IP "uf_uristr($str)" 4
 156 .IX Item "uf_uristr($str)"
 157 Tries to make the argument string
 158 into a proper absolute \s-1URI\s0 string.  The \*(L"uf_\*(R" prefix stands for \*(L"User
 159 Friendly\*(R".  Under MacOS, it assumes that any string with a common \s-1URL\s0
 160 scheme (http, ftp, etc.) is a \s-1URL\s0 rather than a local path.  So don't name
 161 your volumes after common \s-1URL\s0 schemes and expect \fIuf_uristr()\fR to construct
 162 valid file: \s-1URL\s0's on those volumes for you, because it won't.
 163 .IP "uf_uri($str)" 4
 164 .IX Item "uf_uri($str)"
 165 Works the same way as \fIuf_uristr()\fR but
 166 returns a \f(CW\*(C`URI\*(C'\fR object.
 167 .SH "ENVIRONMENT"
 168 .IX Header "ENVIRONMENT"
 169 If the hostname portion of a \s-1URI\s0 does not contain any dots, then
 170 certain qualified guesses are made.  These guesses are governed by
 171 the following two environment variables:
 172 .IP "\s-1COUNTRY\s0" 10
 173 .IX Item "COUNTRY"
 174 The two-letter country code (\s-1ISO\s0 3166) for your location.  If
 175 the domain name of your host ends with two letters, then it is taken
 176 to be the default country. See also Locale::Country.
 177 .IP "\s-1URL_GUESS_PATTERN\s0" 10
 178 .IX Item "URL_GUESS_PATTERN"
 179 Contains a space-separated list of \s-1URL\s0 patterns to try.  The string
 180 \&\*(L"\s-1ACME\s0\*(R" is for some reason used as a placeholder for the host name in
 181 the \s-1URL\s0 provided.  Example:
 182 .Sp
 183 .Vb 2
 184 \& URL_GUESS_PATTERN="www.ACME.no www.ACME.se www.ACME.com"
 185 \& export URL_GUESS_PATTERN
 186 .Ve
 187 .Sp
 188 Specifying \s-1URL_GUESS_PATTERN\s0 disables any guessing rules based on
 189 country.  An empty \s-1URL_GUESS_PATTERN\s0 disables any guessing that
 190 involves host name lookups.
 191 .SH "COPYRIGHT"
 192 .IX Header "COPYRIGHT"
 193 Copyright 1997\-1998, Gisle Aas
 194 .PP
 195 This library is free software; you can redistribute it and/or
 196 modify it under the same terms as Perl itself.