Bigtop::Backend::HttpdConf - defines the legal keywords for httpd conf backends


Bigtop documentation Contained in the Bigtop distribution.

Index


Code Index:

NAME

Top

Bigtop::Backend::HttpdConf - defines the legal keywords for httpd conf backends

SYNOPYSIS

Top

If you are making an httpd conf generating backend:

    use Bigtop::Backend::HttpdConf

This specifies the keywords for conf generating backends.

If you need to add a generally useful keyword, add it here (and send in a patch). If you need a backend specific keyword, register it within your backend module.

DESCRIPTION

Top

If you are using a Bigtop backend in the HttpdConf family, you should read this document to find out what the valid keywords are and what effect they have.

If you are writing a Bigtop::HttpdConf:: module, you should use this module. That will register the keywords your module will need.

BASIC STRUCTURE

Top

A bigtop file looks like this:

    config {
    }
    app name {
        controller name {
        }
    }

KEYWORDS

Top

Inside the app braces, you can include the location keyword. Its value will be the base Apache Location for the application. The default is '/'.

Inside the controller braces, you may include a location or a rel_location keyword. Use location to specify the absolute Apache Location or rel_location to specify the path relative to the app level location.

AUTHOR

Top

Phil Crow <crow.phil@gmail.com>

COPYRIGHT and LICENSE

Top


Bigtop documentation Contained in the Bigtop distribution.

package Bigtop::Backend::HttpdConf;

use Bigtop::Keywords;

BEGIN {
    Bigtop::Parser->add_valid_keywords(
        Bigtop::Keywords->get_docs_for( 'app', 'location' )
    );

    Bigtop::Parser->add_valid_keywords(
        Bigtop::Keywords->get_docs_for(
            'controller', 'location', 'rel_location'
        )
    );

    Bigtop::Parser->add_valid_keywords(
        Bigtop::Keywords->get_docs_for(
            'app_literal', 'HttpdConf', 'Location', 'PerlTop', 'PerlBlock',
        )
    );
    Bigtop::Parser->add_valid_keywords(
        Bigtop::Keywords->get_docs_for(
            'controller_literal', 'Location'
        )
    );
}

1;