Jon Portnoy > Bot-Cobalt-0.016002 > Bot::Cobalt::Frontend::RC

Download:
Bot-Cobalt-0.016002.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.016002   Source  

NAME ^

Bot::Cobalt::Frontend::RC - Read and write instance RC files

SYNOPSIS ^

  use Bot::Cobalt::Frontend::RC qw/ rc_read rc_write /;
  
  my ($base, $etc, $var) = rc_read($rcfile_path);
  
  rc_write($rcfile_path, $base_path);

DESCRIPTION ^

Bot::Cobalt RC files are small per-instance YAML configuration files used by the default frontends to determine the location of configuration ('etc') and dynamic data ('var') directories.

An example RC file might look like:

  ---
  BASE: /home/cobalt/cobalt2
  ETC: /home/cobalt/cobalt2/etc
  VAR: /home/cobalt/cobalt2/var

rc_read

rc_read() takes the path to a preexisting RC file and returns a list of three elements; the base directory path, 'etc' path, and 'var' path, respectively.

rc_write

rc_write() takes the path to the destination RC file and a base directory path from which 'etc' and 'var' directories are constructed.

Returns the actual (parsed) base path on success, croaks on failure.

AUTHOR ^

Jon Portnoy <avenj@cobaltirc.org>

syntax highlighting: