--- /dev/null
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.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. | will give a
+.\" real vertical bar. \*(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-|\(bv\*(Tr
+.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" ''
+'br\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.\"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "Module::Install::PAR 3"
+.TH Module::Install::PAR 3 "2009-05-27" "perl v5.8.7" "User Contributed Perl Documentation"
+.SH "NAME"
+Module::Install::PAR \- Module::Install Support for PAR::Dist packages
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+To offer your users the possibility to install binaries if no C
+compiler was found, you could use this simplistic stub:
+.PP
+.Vb 1
+\& use inc::Module::Install;
+.Ve
+.PP
+.Vb 2
+\& name 'Foo';
+\& all_from 'lib/Foo.pm';
+.Ve
+.PP
+.Vb 2
+\& # Which CPAN directory do we fetch binaries from?
+\& par_base 'SMUELLER';
+.Ve
+.PP
+.Vb 6
+\& unless ( can_cc() ) {
+\& my $okay = extract_par( fetch_par );
+\& if (not $okay) {
+\& die "No compiler and no binary package found. Aborting.\en";
+\& }
+\& }
+.Ve
+.PP
+.Vb 1
+\& WriteAll;
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+This module adds a couple of directives to Module::Install
+related to installing and creating PAR::Dist distributions.
+.Sh "par_base"
+.IX Subsection "par_base"
+This directive sets the \s-1CPAN\s0 \s-1ID\s0 from whose \s-1CPAN\s0 directory to
+fetch binaries from. For example, you can choose to download
+binaries from http://www.cpan.org/authors/id/S/SM/SMUELLER/
+or its ftp counterpart by writing:
+.PP
+.Vb 1
+\& par_base 'SMUELLER';
+.Ve
+.PP
+By default, the name of the file to fetch is generated from
+the distribution name, its version, your platform name and your
+perl version concatenated with dashes.
+.PP
+The directive, however, takes an optional second
+argument which specifies the name of the file to fetch.
+(Though \f(CW\*(C`par_base\*(C'\fR does not fetch files itself, see below.)
+.PP
+.Vb 1
+\& par_base 'SMUELLER', 'foo';
+.Ve
+.PP
+Once \f(CW\*(C`fetch_par\*(C'\fR is called, the file 'foo' will be downloaded
+from \s-1SMUELLER\s0's \s-1CPAN\s0 directory. (It doesn't exist.)
+.PP
+The second argument could be used to fetch platform-agnostic
+binaries:
+.PP
+.Vb 1
+\& par_base 'SMUELLER', "Some\-Distribution\-0.01.par";
+.Ve
+.PP
+(Documentation \s-1TODO:\s0 Use the previously defined distribution
+name and version in example.)
+.Sh "fetch_par"
+.IX Subsection "fetch_par"
+Fetches the .par file previously referenced in the documentation
+of the \f(CW\*(C`par_base\*(C'\fR directive.
+.PP
+\&\f(CW\*(C`fetch_par\*(C'\fR can be used without arguments given the \f(CW\*(C`par_base\*(C'\fR
+directive was used before. It will return the name of the file it
+fetched.
+.PP
+If the first argument is an \s-1URL\s0 or a \s-1CPAN\s0 user \s-1ID\s0, the file is
+fetched from that directory unless an \s-1URL\s0 has been previously set.
+(Read that again.)
+.PP
+If the second argument is a file name
+it is used as the name of the file to download.
+.PP
+If the file could not be fetched, a suitable error message
+about no package being available, yada yada yada, is printed.
+You can turn this off by specifying a true third argument.
+.PP
+.Vb 3
+\& # Try to fetch the package (see par_base) but
+\& # don't be verbose about failures
+\& my $file = fetch_par('', '', undef);
+.Ve
+.Sh "extract_par"
+.IX Subsection "extract_par"
+Takes the name of a PAR::Dist archive file as first argument. The 'blib/'
+directory of this archive is extracted and the 'pm_to_blib' is created.
+.PP
+Typical shorthand usage:
+.PP
+.Vb 1
+\& extract_par( fetch_par ) or die "Could not install PAR::Dist archive.";
+.Ve
+.Sh "make_par"
+.IX Subsection "make_par"
+This directive requires PAR::Dist (version 0.03 or up) on your system.
+(And checks that it is available before continuing.)
+.PP
+Creates a PAR::Dist archive from the 'blib/' subdirectory.
+.PP
+First argument must be the name of the PAR::Dist archive to create.
+.PP
+If your Makefile.PL has a \f(CW\*(C`par_base\*(C'\fR directive, the \f(CW\*(C`make par\*(C'\fR
+make target will be available. It uses this \f(CW\*(C`make_par\*(C'\fR directive
+internally, so on your development system, you can do this to create
+a .par binary archive for your platform:
+.PP
+.Vb 3
+\& perl Makefile.PL
+\& make
+\& make par
+.Ve
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Audrey Tang <cpan@audreyt.org>
+.PP
+With documentation from Steffen Mueller <smueller@cpan.org>
+.SH "COPYRIGHT"
+.IX Header "COPYRIGHT"
+Copyright (c) 2006. Audrey Tang.
+.PP
+This program is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+.PP
+See <http://www.perl.com/perl/misc/Artistic.html>
projects / catagits/Gitalist.git / blobdiff