Zane C. Bowers-Hadley > FreeBSD-Src-2.0.0 > FreeBSD::Src

Download:
FreeBSD-Src-2.0.0.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 2.0.0   Source  

NAME ^

FreeBSD::Src - A object oriented interface to building FreeBSD from source.

VERSION ^

Version 2.0.0

SYNOPSIS ^

    use FreeBSD::Src;

        #creates a new FreeBSD::Src object and build stuff in /tm[/obj and a kernel config
        #named whatever.
    my $src=FreeBSD::Src->new({obj=>"/tmp/obj", kernel=>"whatever"});
    if($src->error){
        warn('Error: '.$src->error);
    }

    #builds and installs the kernel and world
    $src->makeBuildKernel;
    if($src->error){
        warn('Error: '.$src->error);
    }
    $src->makeInstallKernel;
    if($src->error){
        warn('Error: '.$src->error);
    }
    $src->makeBuildWorld;
    if($src->error){
        warn('Error: '.$src->error);
    }
    $src->makeInstallWorld;
    if($src->error){
        warn('Error: '.$src->error);
    }

METHODS ^

new

This creates the object that will be used. It takes arguement, which is a hash that contains various options that will be used.

src

This key contains the path to which contains the FreeBSD source. This this does not exist, it results in a permanent error.

The default is '/usr/src' if it is not defined.

obj

This contains the path to the directory that will contain objects created by the compilation.

If not defined, the enviromental variable "MAKEOBJDIR" will be left as it is.

kernel

This is the kernel config that will be build.

If this is defined, it is left up to make to figure out which should be used. For more information, please see the man page make.conf(5).

makeconf

This is the make.conf file to use for the build.

    my $src=FreeBSD::Src->new({obj=>"/tmp/obj", kernel=>"whatever"});
    if($src->error){
        warn('Error: '.$src->error);
    }

makeBuildWorld

Builds the world.

The return is a perl boolean value.

The returned integer from make can be found using the exitint method.

    $src->makeBuildWorld;
    if($src->error){
        warn('Error: '.$src->error);
    }

makeInstallWorld

Installs the world.

The return is a perl boolean value.

The returned integer from make can be found using the exitint method.

    $src->makeInstallWorld;
    if($src->error){
        warn('Error: '.$src->error);
    }

makeBuildKernel

Builds the kernel

The return is a perl boolean value.

The returned integer from make can be found using the exitinit method.

    $src->makeBuildKernel;
    if($src->error){
        warn('Error: '.$src->error);
    }

makeInstallKernel

Install the kernel.

The return is a perl boolean value.

The returned integer from make can be reached in exitint method.

    $src->makeInstallKernel;
    if($src->error){
        warn('Error: '.$src->error);
    }

makeClean

This cleans the build enviroment.

The return is a perl boolean value.

The returned integer from make can be found using the exitinit method.

    $src->makeClean;
    if($src->error){
        warn('Error: '.$src->error);
    }

output

This gets the stdout from make from the previously called method.

    my $output=$src->output;

ERROR RELATED METHODS ^

error

This returns the current error code, if any.

    my $error=$src->error;
    if($error){
        warn('Error Code: '.$error);
    }

exitint

This is exit int from the make of the last called method.

errorBlank

This is a internal function and should not be called.

ERROR CODES ^

0

The source directory does not exist.

1

'make buildworld' failed.

2

'make installdworld' failed.

3

'make buildkernel KERNCONF=<kernel>' failed.

4

'make installkernel KERNCONF=<kernel>' failed.

5

The source directory does not exist.

AUTHOR ^

Zane C. Bowers-Hadley, <vvelox at vvelox.net>

BUGS ^

Please report any bugs or feature requests to bug-freebsd-src at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FreeBSD-Src. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc FreeBSD::Src

You can also look for information at:

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2011 Zane C. Bowers, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: