oodist(1) - Linux man page

See Also

This module is part of $project distribution version $version, built on $today.$web

License

Copyrights $year$author.$contrib

$lictext

__POD_TAIL

   my $pmhead  = eval qq{"$pmheadsrc"};
   die "ERROR in pmhead: $@" if $@;

   my $podtail = eval qq{"$podtailsrc"};
   die "ERROR in podtail: $@" if $@;

   ($pmhead, $podtail);
}

    my $readme   = first { /\breadme$/i } @toplevel;
    return 1 if $readme;

    print "adding README\n" if $verbose;

    my $manifest = first { /\bmanifest$/i } @toplevel;
    open MANIFEST, '>>', $manifest
        or die "ERROR: cannot append to $manifest: $!\n";
    print MANIFEST "README\n";
    close MANIFEST;

    $readme      = File::Spec->catfile($workdir, 'README');

    if($readmefn)
    {   #
        # user provided README
        #

        print "copying $readmefn as README\n" if $verbose;

        copy $readmefn, $readme
            or die "ERROR: cannot copy $readmefn to $readme: $!\n";

        return 1;
    }

    #
    # Produce a README text
    #

    open README, '>', $readme
        or die "ERROR: cannot write to $readme: $!\n";

    my $date = localtime;

    print README <<__README;
=== README for $project version $version
=   Generated on $date by OODoc $ooversion

(1) if you have a command-line, you can do:
      perl -MCPAN -e 'install <any package from this distribution>'

(2) if you use Windows, have a look at http://ppm.activestate.com/

(3) if you have downloaded this module manually (as root/administrator)
      gzip -d $project-$version.tar.gz
      tar -xf $project-$version.tar
      cd $project-$version
      perl Makefile.PL
      make          # optional
      make test     # optional
      make install

Please report problems to http://rt.cpan.org/Dist/Display.html?Queue=$project

__README

    close README;
    1;
}

sub create_dist($$) { my ($dest, $makefile) = @_;

    print "* Preparing test\n" if $verbose;
    system "perl Makefile.PL"
       and die "ERROR: perl Makefile.PL in $workdir failed: $!\n";

    system "make clean >/dev/null"
       and die "ERROR: make clean in $workdir failed: $!\n";

    move 'Makefile.old', 'Makefile'
       or die "ERROR: cannot reinstate Makefile: $!\n";

    print "* Running make\n" if $verbose;
    system "make distdir >/dev/null"
       and die "ERROR: make in $workdir failed: $!\n";

    if(-d 't' || -d 'tests')
    {   print "* Running tests\n" if $verbose;
        system "make disttest"
            and die "ERROR: make test in $workdir failed: $!\n";
    }
    else
    {   print "* No tests to run\n" if $verbose;
    }

    my $distfile = $makefile->{DISTVNAME}. '.tar.gz';
    print "* Building distribution in $distfile\n" if $verbose;
    unlink $distfile;

    system "make dist >/dev/null"
       and die "ERROR: make dist in $workdir failed: $!\n";

    $distfile;
}

    print "* Distributed package in $dest/$distfile\n"
       if $verbose;

    -f $distfile
       or die "ERROR: cannot find produced $distfile";

       -d $dest
    or mkdir $dest
    or die "ERROR: cannot create $dest: $!\n";

    move $distfile, $dest
       or die "ERROR: cannot move $distfile to $dest: $!\n";
}

sub create_raw_dist($$) { my ($dest, $makefile) = @_;

    my $rawname = $makefile->{DISTVNAME}.'-raw';
    my $rawfile = $rawname. '.tar.gz';
    print "* Building raw package $rawfile\n" if $verbose;

    unlink $rawfile;

    my %manifests;
    foreach my $man (glob "MANIFEST*")
    {   foreach (read_file $man)
        {  s/\s{3,}.*$//;
           next if m/^#/;
           next unless length;
           chomp;
           $manifests{$_}++;
        }
    }

    my @manifests = map { "$rawname/$_" } sort keys %manifests;
    symlink('.', $rawname) || readlink $rawname eq '.'
        or die "ERROR: cannot create temp symlink $rawname: $!\n";

    local $" = ' ';
    system "tar czf $rawfile @manifests"
        and die "ERROR: cannot produce $rawfile with tar\n";

    unlink $rawname;
    $rawfile;
}

       -d $dest
    or mkdir $dest
    or die "ERROR: cannot create $dest: $!\n";
    print "* Raw package to $dest/$rawfile\n" if $verbose;

    move $rawfile, $dest
        or die "ERROR: cannot move $rawfile to $dest: $!\n";
}

sub create_html_dist($$) { my ($dest, $makefile) = @_;

    my $htmlfile = $makefile->{DISTVNAME}.'-html.tar.gz';
    print "* Building html package $htmlfile\n" if $verbose;

    unlink $htmlfile;

    local $" = ' ';
    system "tar czf $htmlfile *"
        and die "ERROR: cannot produce $htmlfile with tar\n";

    $htmlfile;
}

    return if $dest eq $html_output;

       -d $dest
    or mkdir($dest)
    or die "ERROR: cannot create $dest: $!\n";

    print "* HTML package to $dest/$htmlfile\n"
        if $verbose;

    move $htmlfile, $dest
        or die "ERROR: cannot move $htmlfile to $dest: $!\n";
}

sub read_makefile($) { my $makefile = shift;

    open MAKEFILE, '<', $makefile
       or die "ERROR: cannot open produced Makefile: $makefile";

    my %makefile;
    while( <MAKEFILE> )
    {   $_ .= <MAKEFILE> while !eof MAKEFILE && s/\\$//; # continuations
        s/\n\t*/ /g;

        $makefile{$1} = $2 if m/^([A-Z_][A-Z\d_]+)\s*\=\s*(.*?)\s*$/;

        if(m/^#\s+([A-Z_][A-Z\d_]+)\s*\=>\s*(.*?)\s*$/)
        {   # important information which ended-up in comments ;(
            my ($key, $v) = ($1, $2);
            $v =~ s/q\[([^\]]*)\]/$1/g;  # remove q[]
            $makefile{$key} = $v;
        }
    }

    close MAKEFILE;
    \%makefile;
}

sub skip_links(@) { my @links = map { defined $_ ? split(/[\, ]/, $_) : () } @_; \@links; }

__END__

Name

oodist - create perl distributions with OODoc

Synopsis

cd <src>
oodist [OPTIONS]
  OPTION:                 DEFAULT:
  --pod  or --nopod         produce pod: yes
  --dist or --nodist        produce distribution: yes
  --html or --nohtml        produce html: yes if templates
  --raw  or --noraw         produce package with raw files: yes

 OPTIONS general:
  --distdir  | -d <dir>     makefile:DISTDIR || $ENV{OODOC_DISTDIR} || <src>
  --extends  | -x <path>    empty
  --project  | -p <string>  makefile:DISTNAME
  --rawdir   | -r <dir>     makefile:RAWDIR  || $ENV{OODOC_RAWDIR} || <src>
  --readme        <file>    constructured
  --workdir  | -w <dir>     /tmp/<DISTVNAME>
  --verbose  | -v           true when specified

 OPTIONS for parsers:
  --skip_links <string>     makefile:SKIP_LINKS

 OPTIONS for POD:
  --email    | -e <email>   makefile:EMAIL
  --firstyear| -y <year>    makefile:FIRST_YEAR
  --license  | -l <string>  makefile:LICENSE || $ENV{OODOC_LICENSE} || 'artistic'
  --pmhead   | -h <file>    makefile:PMHEAD  || 'PMHEAD.txt'  || constructed
  --podtail  | -t <file>    makefile:PODTAIL || 'PODTAIL.txt' || constructed
  --website  | -u <url>     makefile:WEBSITE

 OPTIONS for HTML:
  --html-templates <dir>    makefile:HTML_TEMPLATES || 'html'
  --html-output <dir>       makefile:HTML_OUTPUT    || 'public_html'
  --html-docroot <url>      makefile:HTML_DOCROOT   || '/'
  --html-package <dir>      makefile:HTML_PACKAGE

Description

The "oodist" script is currently only usable on UNIX in combination with Makefile.PL. It is a smart wrapper around the OODoc module, to avoid start work to produce real POD for modules which use OODoc's POD extensions. HTML is not (yet) supported.

Configuring

All OPTIONS can be specified on the command-line, but you do not want to specify them explicitly each time you produce a new distribution for your product. The options come in two kinds: those which are environment independent and those which are. The first group can be set via the Makefile.PL, the second can be set using environment variables as well.

Example: add to the end of your "Makefile.PL"

sub MY::postamble { <<'__POSTAMBLE' }
FIRST_YEAR   = 2001
WEBSITE      = http://perl.overmeer.net/oodoc
EMAIL        = oodoc@overmeer.net
__POSTAMBLE

Main options

The process is controlled by four main options. All options are by default "on".

. --pod or --nopod

Produce pod files in the working directory and in the distribution.

. --dist or --nodist

Create a distribution, containing all files from the MANIFEST plus produced files.

. --html or --nohtml

Create html manual pages. The "--html-templates" options must point to an existing directory (defaults to the "html/" sub-directory).

. --raw or --noraw

Create a package which contains the files which are needed to produce the distribution: the pm files still including the oodoc markup.

General options

The other OPTIONS in detail

. --readme <filename>

Copy the specified README file into the distribution, if there is no README yet. The name will be added to the MANIFEST . If the option is not specified, a simple file will be created. If this option is specified, but the filename is empty, then the README will not be produced.

. --distdir | -d <dir>

The location where the final file to be distributed is placed, by default in the source directory. Ignored when "--test" is used.

. --extends | -x <path>

A colon seperated list of directories which contains "raw oodoc" pm and pod files which are (in some cases) used to provide data for base-classes of this module.

. --rawdir | --r <dir>

The location where a raw version of the distribution is made. The normal distribution contains expanded POD and stripped PM files. For that reason, you can not use it a backup for your files. If you have co-workers on the module, you may wish to give them the originals. gnored when "--test" is used.

. --test | -t

Run in test mode: the raw and real distributions are produced, but not moved to their final location. You will end-up with these archives in the work-directory (see "--workdir").

. --verbose | --v

Shows what happens during the process.

. --workdir | -w <dir>

The processing will take place in a seperate directory: the stripped pm's and produced pod files will end-up there.

If not provided, that directory will be named after the project, and located in $ENV{TMPDIR}, which defaults to "/tmp". For instance "/tmp/OODoc/"

Options for parsers

. --skip_links <strings>

A blank or comma separated list of packages which will have a manual page, but cannot be loaded under their name. Sub-packages are excluded as well. For instance, XML::LibXML has many manual-pages without a package with the same name.

Options to produce POD

. --email | -e <email>

The email address which can be used to contact the authors. Used in the automatic podtail.

. --firstyear| -y <string>

The first year that a release for this software was made. Used in the automatic podtail. The specified string can be more complex than a simple year, for instance "1998-2000,2003". The last year will be automatically added like "-2006", which results in "1998-2000,2003-2006". When the current year is detected at the end of the string, the year will not be added again.

. --license | -l ['gpl'|'artistic'|filename]

The lisense option is a special case: it can contain either the strings "gpl" or "artistic", or a filename which is used to read the actual license text from. The default is "artistic"

. --pmhead

Each of the stripped "pm" files will have content of the file added at the top. Each line will get a comment '# ' marker before it. If not specified, a short notice will be produced automatically.

Implicitly, if a file "PMHEAD.txt" exists, that will be used. variables found in the text will be filled-in.

. --podtail

Normally, a trailing text is automatically produced, based on all kinds of facts. However, you can specify your own file. If exists, the content is read from a file named "PODTAIL.txt".

After reading the file, variables will be filled in: scalars like $version, $project, $website etc are to your disposal.

. --website | -u <url>

Where the HTML documentation related to this module is publicly visible.

Options to produce HTML

. --html-docroot <url>

This (usually relative) URL is prepended to all absolute links in the HTML output.

. --html-output <dir>

The directory where the produced HTML pages are written to.

. --html-templates <dir>

The directory which contains the templates for HTML pages which are used to construct the html version of the manual-pages.

. --html-package <dir>

When specified, the html-output directory will get packaged into a a tar achive in this specified directory.