Net::RFC::Search - search for RFC's and dump RFC's content either to a variable or to a file.
Net::RFC::Search provides 2 methods:
search_by_header('keyword') is for searching for a RFC index number by given 'keyword' (through RFC index text file).
get_by_index($index_number) is for dumping RFC's content either to a variable or to a file.
my $rfc = Net::RFC::Search->new;
# This will return array of RFC indices with "websocket" keyword in their headers.
my @found = $rfc->search_by_header('WebSocket');
# This will dump content of RFC 6455 into $rfc_text variable.
my $rfc_text = $rfc->get_by_index(6455);
# Dumps RFC 6455 into /tmp/6455.txt file
Net::RFC::Search is a module aimed to be a simple tool to search and dump RFC's.
Create instance of Net::RFC::Search.
%options are optional parameters:
indexpath - a file name to store RFC index file into. Defaults to ~/.rfcindex
rfcbaseurl - URL of the RFC site/mirror where index file and RFC's are going to be downloaded from.
Returns array of RFC index numbers "keyword" has been found in.
Search occurs in RFC header names (i.e. through RFC index file).
Downloads RFC of index number $index and returns downloaded content.
By providing optional $filename content will be dumped into $filename.
This module is heavily based on rfc.pl script written by **Derrick Daugherty** (http://www.dewn.com/rfc/)
Nikolay Aviltsev, firstname.lastname@example.org
Copyright 2013 Nikolay Aviltsev.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
To install Net::RFC::Search, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.