NAME

PkgForge::App - Package Forge application base class.

VERSION

This documentation refers to PkgForge::App version 1.4.8

SYNOPSIS

package PkgForge::App::Foo;

use Moose;

extends 'PkgForge::App';

DESCRIPTION

This is a base class for user-side Package Forge command-line applications. It adds standardised configuration file handling and holds some common attributes.

ATTRIBUTES

This class implements the PkgForge::ConfigFile role, see the documentation for that module for all the inherited attributes. The following additional attributes are available:

configfile

The default value for the configuration files list is overridden. The standard /etc/pkgforge/pkgforge.yml file will always be consulted, if it exists. The application-specific files in /etc/pkgforge and $HOME/.pkgforge are also examined, if they exist. For example, the submit command will examine the following configuration files, if the exist (in this order)

/etc/pkgforge/pkgforge.yml =item /etc/pkgforge/submit.yml =item $HOME/.pkgforge/pkgforge.yml =item $HOME/.pkgforge/submit.yml

Settings in files later in the sequence override those earlier in the list. So settings in a user's home directory override the common application settings which override the system-wide settings.

website

The location of the local installation of the Package Forge website. This is mainly used for printing out helpful links to the user. If not set the links are not printed.

incoming

The location of the incoming jobs directory.

accepted

The location of the accepted jobs directory.

results

The location of the results directory for the finished build jobs.

SUBROUTINES/METHODS

This class implements the PkgForge::ConfigFile role, see the documentation for that module for all the inherited methods. This class does not add any methods.

DEPENDENCIES

This module is powered by Moose, MooseX::Types and uses MooseX::App::Cmd. It also requires the File::HomeDir and Readonly modules.

PLATFORMS

This is the list of platforms on which we have tested this software. We expect this software to work on any Unix-like platform which is supported by Perl.

ScientificLinux5, Fedora13

BUGS AND LIMITATIONS

Please report any bugs or problems (or praise!) to bugs@lcfg.org, feedback and patches are also always very welcome.

AUTHOR

Stephen Quinney <squinney@inf.ed.ac.uk>

LICENSE AND COPYRIGHT

Copyright (C) 2010-2011 University of Edinburgh. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the terms of the GPL, version 2 or later.