drawvalmap(1p) [debian man page]

DRAWVALMAP(1p)						User Contributed Perl Documentation					    DRAWVALMAP(1p)

NAME

       drawvalmap - Generate a graphical output of validation status values
		    encountered by the validator library.

SYNOPSIS

       drawvalmap <logfile>

       drawvalmap

DESCRIPTION

       drawvalmap is a simple utility that can be used to display the validator status values in a graphical format.  The input to this script is
       a set of log messages that can be read either from file or from a socket.  The output is an image file containing an image of the various
       validator authentication chain status values.

       drawvalmap reads data from STDIN if the logfile and the socket option are both unspecified.  If the -f option is given, the output image
       file is embedded in an HTML file with the given name.  The HTML file auto-refreshes according to the refresh time supplied by the -r
       option, allowing changes to the validator graph to be constantly tracked.

       The typical usage of this script is in the following way:

	   # drawvalmap <logfile>

       It would not be uncommon to use this script for troubleshooting purposes, in which case output generated by a driver program would be
       "piped" to this script in the manner shown below.

	   # dt-validate -o6:stdout secure.example.com. | drawvalmap -f val_log_map.html

       In each case the script generates the results in a val_log_map.png file.  In the second case, an HTML file with the name val_log_map.html
       is also generated.

OPTIONS

       -a IP-address
	   This changes the address to which drawvalmap binds itself to the specified value. This option takes effect only if the -s option is
	   also specified.

       -f file.ext
	   This creates an image of the type determined by the file extension

       -g xxxx (deprecated)
	   Use -f instead.

       -h file.html
	   This creates an HTML file with the given name, which contains the image of the validation map.

       -i ignore_pattern_string
	   This causes drawvalmap to ignore log records that match the given ignore pattern.

       -l log_event1,log_event2
	   This causes drawvalmap to enable display of events for the given list of log types. The following log event types are defined with
	   their default enabled status indicated in parenthesis: SUCCESS(1), BOGUS(1), DATA_MISSING(1), ERROR(1), and IGNORED(0).

       -m match_pattern_string
	   This causes drawvalmap to include only log records that match the given pattern.  If a given log record matches a pattern given by the
	   -m option and also matches the pattern given by the -i option the effective result is that of ignoring the record.

       -p port
	   This changes the port to which drawvalmap binds itself to the specified value. This option takes effect only if the -s option is also
	   specified.

       -r refresh-period
	   This changes the refresh period in the HTML file to the given value. The default is 5 seconds.

       -s  This changes the mode of operation to read input from a socket.  The default address and port to which drawvalmap binds are
	   127.0.0.1:1053.

PRE-REQUISITES
       GraphViz

COPYRIGHT

       Copyright 2005-2012 SPARTA, Inc.  All rights reserved.  See the COPYING file included with the DNSSEC-Tools package for details.

AUTHOR

       Suresh Krishnaswamy, hserus@users.sourceforge.net

SEE ALSO

       libval(3)

perl v5.14.2							    2012-06-21							    DRAWVALMAP(1p)

SDFAPI(1)						User Contributed Perl Documentation						 SDFAPI(1)

NAME

       sdfapi - API Extraction Utility

PURPOSE

       sdfapi extracts Application Programming Interface information from (Perl) source code.

USAGE

	usage  : sdfapi [-h[help]] [-o[out_ext]]
		[-l[log_ext]] [-O[out_dir]] [-f fmt_tag]
		[-p[pattern]] [-s sym_type,..] [-j]
		file ...
       purpose: extract the API from a (perl) library
       version: 2.000	 (SDF 2.001)

       The options are:

	Option	     Description
	-h	     display help on options
	-o	     output file extension
	-l	     log file extension
	-O	     output to input file's (or explicit) directory
	-f	     output format tag
	-p	     only symbols matching pattern
	-s	     only symbols of these types
	-j	     add SDF-style hypertext jumps from each symbol

DESCRIPTION

       The -h option provides help. If it is specified without a parameter, a brief description of each option is displayed. To display the
       attributes for an option, specify the option letter as a parameter.

       By default, generated output goes to standard output. To direct output to a file per input file, use the -o option to specify an extension
       for output files. If the -o option is specified without a parameter, an extension of out is assumed.

       Likewise, error messages go to standard error by default. Use the -l option to create a log file per input file. If the -l option is
       specified without a parameter, an extension of log is assumed.

       By default, generated output and log files are created in the current directory. Use the -O option to specify an explicit output directory.
       If the -O option is specified without a parameter, the input file's directory is used.

       The format of the output can be controlled using the -f option.	Supported formats are std and concise. The default is std.  std format is:

	require "abc.pl";

       $myvar = ...

       $result = &myfunc($myparams);

       concise format has fewer blank lines and uses 1 line per symbol.

       A comma-separated list of symbol types to output can be specified using the -s option. Supported symbol types are:

       o   sub - subroutines

       o   var - variables

       The default is to extract all symbols.

       The -p option is used to extract only a subset of the symbols. If not supplied, the pattern is symbols beginning with a letter. If supplied
       without an option, the pattern defaults to all symbols. If perl libraries use the coding convention that symbols beginning with underscore
       are private, then -p_ can be used to extract the private symbols.

       The -j option can be used to request SDF-style hypertext jumps be added for each symbol. The jump target is lib_sym where:

       o   lib is the library name

       o   sym is the symbol name.

LIMITATIONS AND FUTURE DIRECTIONS

       The only language currently supported is Perl.

       It would be useful to extract messages from the scripts too. This would require a new utility called sdfmsg say, which searched through the
       source (including libraries) for AppMsg and AppExit calls.

       Internally, it may be better to implement formats via routines. This would give better control over output. e.g. it would be up to the
       routine to decide if it wanted to output the 'require' header.

perl v5.12.4							    2011-11-09								 SDFAPI(1)