/ 
FTN-SRIF-0.05
River stage zero No dependents
/ ftn-srif

NAME

ftn-srif - A Perl script to process file requests via an incoming SRIF file

VERSION

Version 0.05

SYNOPSIS

ftn-srif srif_path_and_file

DESCRIPTION

ftn-srif is a an external request processor that is passed the name and path of an SRIF (Standard Request Information File) on its command line. It expects to find a configuration file named ftn-srif.cfg one directory up from the directory that the SRIF is located in, and from that determines the location of its Log file and the 'Magic' file it will will be using during processing.

It then uses the parse_srif function from the FTN::SRIF module to get the contents of the SRIF, especially the following:

RequestList

This is the path and filename of the list containing the requested files.

ResponseList

This is the path and filename of the response list. It must not be equal to RequestList. One file per line, including the full path to the file. The first character defines the way the mailer should act after sending that file:

=   erase file if sent successfully
+   do not erase the file after sent
-   erase the file in any case after session

It then processes the filenames list in the RequestList file. If the system has the file being requested, the name and path for it is added to the ResponseList file for the mailer to send back to the requesting system and a note regarding that is added to a response message that will also be sent to the requesting system. If it does not, a note about not having that file is added to the result summary message.

EXAMPLES

This is the contents of an example ftn-srif.cfg file:

[SRIF]
LogFile=/opt/ftn/log/srif.log
MagicFile=/opt/ftn/magic.txt
DefaultFile=/opt/ftn/freqerr.txt

This is an example line in a BinkD configuration file to make use of ftn-srif:

# Run an external program. 
# The "*S" macro in command line substed with S.R.I.F., see !SRIF.TXT
#
exec "/opt/ftn/bin/ftn-srif *S" *.req

An example of a command line that ftn-srif might see:

C<ftn-srif /opt/ftn/pin/07800220.srf>

AUTHOR

Robert James Clay, <jame at rocasa.us>

BUGS

Please report any bugs or feature requests to bug-ftn-srif at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FTN-SRIF. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this with the perldoc command.

perldoc ftn-srif

You can also look for information at:

SEE ALSO

L<FTN::SRIF>

COPYRIGHT & LICENSE

Copyright 2001-2003,2010 Robert James Clay, all rights reserved.

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