#!/usr/bin/env perl
#=--#-============================= the SITE of PATHING
    #                             - this file best read whilst
#--=#-============================- =-----------------------------------------=
package CGI::Madarch;                                  use strict; use warnings;
                                                      use our_package_contents;

=head1 NAME

=cut

#                             ::
#\:::::::::::::::::::::::::::::: the FORGING ::::::::::::::::::::::::::::::::::
#                              :                                              :
=head1 MAKING MADARCH

We situate your files into their default path- and file-names, when you first
un-packaged our distribution.

We locate these files with their defaults; when you rename them, externally,
you must rename them, internally.

 Should you leave these names to their defaults,
we shouldn't need you specify their names.

We should, on the other hand, need you specify their names when you change them.

=head1 LOCATING TRANSIENTS

We write to and from some temporaries when writing YAML files in-place, when
writing back-up files, or when simply staying in a safe-house for the night.

We write, by default, to $temp_path, which is, by default, "$nave_path/temp".
If you have no such path, then we create it as we need it.

We recommend that you not relegate these temporaries to a traditional "/tmp".
We recommend that, instead, you relocate them to some user-specific path, so
that we may call the "rename" builtin on them.

Administrators often part their systems into various drives; shell accounts
with one, system accounts and the kernel with others. Thus, "/tmp" defaults
to one, and your home directory another. When temporaries reside with the
former, we cannot do "rename"-ing, since this builtin fails when moving files
across filesystem chasms. We leave the naming to you, though... 

=head2 forge_site_path_defaults

We apply our path-defaults to the absolute path-names built by our CGI script.

=cut
sub forge_path_settings() {
   # Retrieve the home-path of the user under which the script is run
   $home_path = { name => $nave_path };

   # Declare site-wide-applicable paths
   $temp_path = { name => $nave_path . '/temp' };

   # Declare site-wide-applicable files
   $newspaper = { name => $nave_path . '/.new.changes' };
   $necrology = { name => $nave_path . '/.new.murders' };

   $manifesto = {
      name => $temp_path->{name}
      . '/' . $seed_file->{name}
      . '|' . $seed_file->{make}
   }
   ;
}

#                             ::
#\:::::::::::::::::::::::::::::: the MAIN :::::::::::::::::::::::::::::::::::::
#                              :                                              :
forge_path_settings;

  1
__END__

=head1 COPYRIGHT AND LICENSE

 The information below applies to everything in this distribution,
 except where noted.
 
 Copyright 1980-2005 by B.W.Curry.
 
   http://bcurry.gomen.org
 
 This file is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.

 This file is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this file; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

=head1 SEE ALSO

 links -g bcurry.gomen.org &

=head1 AUTHOR

 bcurry at freeshell dot org

=cut