Download Shareware and Freeware Software for Windows, Linux, Macintosh, PDA

line Home  |  About Us  |  Link To Us  |  FAQ  |  Contact

Serving Software Downloads in 956 Categories, Downloaded 49.484.599 Times

Pod::InComments 0.9

  Date Added: February 19, 2010  |  Visits: 679

Pod::InComments

Report Broken Link
Printer Friendly Version


Product Homepage
Download (86 downloads)



Pod::InComments is a Perl extension for extracting POD documentation from comments in config file. SYNOPSIS use Pod::InComments; my $podparser = Pod::InComments->new( comment => ; ); $podparser->ParseFile( $my_config_file ); $podparser->Pod2Hash(); my $helptext = $podparser->Pod4Section( $section , $key ); This module was written to solve the problem of describing numerous parameters in a config file. When you add comments to the config file, it becomes a mess quickly. And no-one will take the time to properly read them. You can not add POD directly. So..... here is Pod::InComments. It was developed when using Config::IniFiles format, so lets take that as the basis. The Config::IniFiles module lets you use config files in the form of the popular windows ini file. That is, they look like [section] param1=some value param2 = another value param3=20.00 ; this is a comment [operating system] preferred=Linux using=Windows XP Pro METHODS new( comment => # ) Constructor of the class. Specify the comment character(s) used in the config file. Defaults to ;. You can use whatever you like here. So #### is valid as well, but requires more typing in the config. ParseFile( $config_file ) Parses the $config_file and extracts all the comment lines. The comment character(s) are stripped of each line. It returns a string with all the POD. Pod2Hash() After parsing a config file, you will need to call this function to convert the POD into a hash. The keys of the hash are the head1 titles. If head2 elements are present, they will be subkeys of the hash. Pod4Section( $section, $param ) Returns the POD belonging to the $section, or to $param of $section. E.g., when your config file looks like: ;=head1 cpu ; ;Specifies cpu settings for normal boxes ;note that these will override factory settings! ; ;=head2 maxload ; ;The maxload setting gives an upperbound on how hard ;the CPU can be pushed. [cpu] maxload=4.0 then doing: my $pod = $podparser->Pod4Section( cpu, maxload ); will give you: The maxload setting gives an upperbound on how hard the CPU can be pushed. SavePod( $file ) Saves the extracted pod to the $file. If you omit a file name, it will append .pod to the config file you parsed and saves to that file. GetPod() Returns the entire POD formatted in text. DisplayPod() Prints the entire extracted POD documentation to STDOUT..

Requirements: No special requirements
Platforms: Linux
Keyword: Comment Config Config File Cpu File Incomments Libraries Maxload Podincomments Programming Section
Users rating: 0/10

License: Freeware Size: 5.12 KB
USER REVIEWS
More Reviews or Write Review


POD::INCOMMENTS RELATED
Libraries  -  Config::File 1.4
Config::File is a Perl module to parse a simple configuration file. SYNOPSIS use Config::File; my $config_hash = Config::File::read_config_file($configuration_file); read_config_file parses a simple configuration file and stores its values...
4.1 KB  
Libraries  -  HH::Unispool::Config::File::Token::Unnumbered::Bcs 0.3
HH::Unispool::Config::File::Token::Unnumbered::Bcs is a Perl class for BCS B tokens. SYNOPSIS Application programmers dont need to use this class and API programmers read code. ABSTRACT class for BCS B tokens...
133.12 KB  
Libraries  -  Samba::LDAP::Config 0.03
Samba::LDAP::Config is a Perl module to config file related tasks for Samba::LDAP. SYNOPSIS use Samba::LDAP::Config; my $config = Samba::LDAP::Config->new() or die "Cant create objectn"; # Returns where smbldap.conf, smbldap_bind.conf and...
81.92 KB  
Libraries  -  Chroniton::Config 0.03
Chroniton::Config it manages config file for Chroniton. SYNOPSIS my $config = Chroniton::Config->new; METHODS new Creates an instance. Takes no arguments. destination Returns the directory where the backup should be placed....
55.3 KB  
Libraries  -  Config::JSON 1.0.3
Config::JSON is a JSON based config file system. SYNOPSIS use Config::JSON; my $config = Config::JSON->create($pathToFile); my $config = Config::JSON->new($pathToFile); my $element = $config->get($param); $config->set($param,$value);...
5.12 KB  
Wallpaper Tools  -  Domino Blue Milk
Domino Blue Milk is a Domino config file that looks like MacOS Xs Milk with a blue touch. Started from Polyester-Blue color profile, transformed it to a murrina-domino config and then customized to add brightness to buttons, scrollbars and...
 
Libraries  -  Config::Std 0.0.4
Config::Std is a Perl module load and save configuration files in a standard format. SYNOPSIS use Config::Std; # Load named config file into specified hash... read_config demo2.cfg => my %config; # Extract the value of a key/value pair...
12.29 KB  
Programming  -  CGI::Application::Plugin::Config::Perl 1.40
CGI::Application::Plugin::Config::Perl adds easy access to a pure Perl config file to your CGI::Application projects. Lazy loading is used to prevent the config file from being parsed if no configuration variables are accessed during the request,...
10.24 KB  
Libraries  -  Simple Config 1.1.1
Simple Config library supports configuration files consisting of simple name-value pairs, similar to the old Windows INI files. A config file can be loaded into memory, queried by item name, modified, and written back out to a file. Configuration...
23.55 KB  
Security Tools  -  pam_usbauth 0.3
pam_usbauth is a module for PAM allowing end-users to locally authenticate via USB storage devices. USBAuth currently supports user-dependent authentication via password-hashing as well as one-time-password mechanisms, which make the verification...
10.24 KB  
NEW DOWNLOADS IN PROGRAMMING, LIBRARIES
Programming  -  Cedalion for Linux 0.2.6
Cedalion is a programming language that allows its users to add new abstractions and define (and use) internal DSLs. Its innovation is in the fact that it uses projectional editing to allow the new abstractions to have no syntactic limitations.
471.04 KB  
Programming  -  Math::GMPf 0.29
Math::GMPf - perl interface to the GMP library's floating point (mpf) functions.
30.72 KB  
Programming  -  Net::Wire10 1.08
Net::Wire10 is a Pure Perl connector that talks to Sphinx, MySQL and Drizzle servers. Net::Wire10 implements the low-level network protocol, alias the MySQL wire protocol version 10, necessary for talking to one of the aforementioned...
30.72 KB  
Programming  -  logilab-common 0.56.2
a bunch of modules providing low level functionnalities shared among some python projects devel Please note that some of the modules have some extra dependencies. For instance, logilab.common.db will require a db-api 2.0 compliant...
174.08 KB  
Programming  -  OpenSSL for linux 1.0.0a
The OpenSSL Project is a collaborative effort to develop a robust, commercial-grade, full-featured, and Open Source toolkit implementing the Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS v1) protocols as well as a...
3.83 MB  
Libraries  -  wolfSSL 4.0.0
The wolfSSL embedded SSL/TLS library is a lightweight SSL library written in ANSI standard C and targeted for embedded and RTOS environments - primarily because of its small size, speed, and feature set. It is commonly used in standard operating...
3.88 MB  
Libraries  -  EuGTK 4.8.9
Makes it easy to develop good- looking, fast, cross-platform programs that run on Linux, OS X, and Windows. Euphoria is a very fast interpreted/compiled language with straight-forward syntax. EuGTK allows programming in a clean, object-oriented...
10.68 MB  
Libraries  -  Linux User Group Library Manager 1.0
The LUG Library Manager is a project to help Linux User Groups start their own library. A LUG library is helpful to the community at large because it increases access to information, and gives everyone the opportunity to become more knowledgeable.
5.35 KB  
Libraries  -  Module::MakefilePL::Parse 0.12
Module::MakefilePL::Parse is a Perl module to parse required modules from Makefile.PL. SYNOPSIS use Module::MakefilePL::Parse; open $fh, Makefile.PL; $parser = Module::MakefilePL::Parse->new( join("", ) ); $info = $parser->required;...
8.19 KB  
Libraries  -  sqlpp 0.06
sqlpp Perl package is a SQL preprocessor. sqlpp is a conventional cpp-alike preprocessor taught to understand SQL ( PgSQL, in particular) syntax specificities. In addition to the standard #define/#ifdef/#else/#endif cohort, provides also...
10.24 KB