Chisel > Zucchini-0.0.17 > Zucchini::Config::Create

Download:
Zucchini-0.0.17.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Source   Latest Release: Zucchini-0.0.21

NAME ^

Zucchini::Config::Create - write a sample configuration file

SYNOPSIS ^

  # create a new object
  $zucchini_cfg_create = Zucchini::Config::Create->new();

  # write out a default config file
  $zucchini_cfg_create->write_default_config(
    file($ENV{HOME}, q{.zucchini})
  );

DESCRIPTION ^

It's mean to expect people to pluck a configuration file out if thin air.

This module's sole purpose is to write out a default .zucchini file to give users a fighting chance.

METHODS ^

new

Creates a new instance of the top-level Zucchini object:

  # create a new object
  $zucchini_cfg_create = Zucchini::Config::Create->new();

write_default_config

Given a filename, write out the default/sample configuration file. If the file already exists it will not be overwritten.

  # write out a default config file
  $zucchini_cfg_create->write_default_config(
    file($ENV{HOME}, q{.zucchini})
  );

SAMPLE CONFIGURATION FILE ^

The sample configuration file is supposed to be a reasonable example of how a functioning configuration file should look.

You should be able to get up and running with Zucchini by creating the default file, and modifying the following variables: source_dir, includes_dir, output_dir.

You might also like to edit some of the values in the <tags> section.

SEE ALSO ^

Zucchini, Zucchini::Config

AUTHOR ^

Chisel Wright <chiselwright@users.berlios.de>

LICENSE ^

Copyright 2008-2009 by Chisel Wright

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

See <http://www.perl.com/perl/misc/Artistic.html>

syntax highlighting: