view release on metacpan or  search on metacpan

CfgTie2.tex  view on Meta::CPAN

Additions that do not change any previously established values are reflected
immediately (and @file{newaliases} is run as appropriate).  Anything which changes
a previously established value, regardless of whether or not it has been
committed, are queue'd for later.  This queue is used to rewrite the file when
@code{END} is executed.

@flindex newaliases, newaliases

@flindex newaliase, newaliases

@subheading AUTHOR

Randall Maas (@email{randym@@acm.org}, @url{http://www.hamline.edu/~rcmaas/})

@c TeXInfo document produced by pod2texinfo version 1.1
@c from "TieGeneric.pod".


@c 319
@node CfgTie-filever, CfgTie-TieAliases, CfgTie-Cfgfile, CfgTie
@section CfgTie-filever


@c --- From file: - -------------------------

@subheading NAME


CfgTie::filever --- a simple module for substituting newer versions into a file system.

@subheading SYNOPSIS

This module allows a newer version of file to be safely placed into the file system.

@subheading DESCRIPTION

This is a set of utilities for manipulating files.

@subsubheading @code{File's_Rotate} (@emph{$Old, $New})

@cindex @code{File's_Rotate} (@emph{$Old, $New})

This is the file space equivalent to the variable exchange or swap.  The
@emph{old} file will be renamed (with a .old extension) and the @emph{new} file will
be renamed to @emph{old}.  This is extremely useful for many semi-critical
functions, where modifying the file directly will cause unpredictable results.
Instead, the preferred method is to modify @emph{old} sending the results to
@emph{new} in the background and then doing a @emph{very} quick switcheroo.

It preserves the permissions and ownership of the original file.

If this routine fails, it will make an attempt to restore things to their
original state and return.

@strong{Return Value}: 0 on success, -1 on error;

@subsubheading @code{Roll(}@emph{path},@emph{depth},@emph{sep}@code{)}

@cindex @code{Roll(}@emph{path},@emph{depth},@emph{sep}@code{)}

This convert the specified files into a backup file (the original file is
renamed, so you had better have something to put there).

@table @asis

@item @emph{Depth}
@cindex @emph{Depth}

(optional) Controlls the number of backup copies

@item @emph{Sep}
@cindex @emph{Sep}

(optional) Controlls the seperator between the main name and the backup
number

@end table

The defaults for @emph{depth} and @emph{sep} are controlled by following two variables
in the package:

@table @asis

@item @code{RollDepth}
@vindex @code{RollDepth}

Controlls the number of of older versions that are kept around as backup
copies.
@emph{@code{[}Default: 4@code{]}}

@item @code{RollSep}
@vindex @code{RollSep}

Controls the separator between the file name and the backup number.
@emph{@code{[}Default: }@code{~}@emph{@code{]}}

@end table

@subsubheading @code{RCS_path (}@emph{RCSObj},@emph{path}@code{)}

@cindex @code{RCS_path (}@emph{RCSObj},@emph{path}@code{)}

For the given RCS object, this sets the working directory and the file.

@subsubheading find_by_user

@cindex find_by_user

This function attempts to locate all of the files in the system that are owned
by the specified users.  It takes the following parameters:

@table @asis

@item @code{Base}
@vindex @code{Base}

@code{Base} can be a string to the base path or a reference to a list of base
paths to search.

@end table

Return Value:

@table @asis

@item @code{undef} if there was an error
@vindex @code{undef} if there was an error

@item otherwise the list of file that matched
@cindex otherwise the list of file that matched

@end table

@subheading AUTHOR

Randall Maas (@email{randym@@acm.org}, @url{http://www.hamline.edu/~rcmaas/})

@c TeXInfo document produced by pod2texinfo version 1.1
@c from "TieShadow.pod".


@c 319
@node CfgTie-TieAliases, CfgTie-TieGeneric, CfgTie-filever, CfgTie
@section CfgTie-TieAliases


@c --- From file: - -------------------------

@subheading NAME


CfgTie::TieAliases --- an associative array of mail aliases to targets

@subheading SYNOPSIS