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

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

Serving Software Downloads in 976 Categories, Downloaded 29.546.607 Times

pod2man 5.6.2

  Date Added: November 04, 2010  |  Visits: 1.065


Report Broken Link
Printer Friendly Version

Product Homepage
Download (118 downloads)

pod2man is a Perl module that can convert POD data to formatted *roff input. SYNOPSIS pod2man [--section=manext] [--release=version] [--center=string] [--date=string] [--fixed=font] [--fixedbold=font] [--fixeditalic=font] [--fixedbolditalic=font] [--official] [--lax] [--quotes=quotes] [input [output] ...] pod2man --help pod2man is a front-end for Pod::Man, using it to generate *roff input from POD source. The resulting *roff code is suitable for display on a terminal using nroff(1), normally via man(1), or printing using troff(1). input is the file to read for POD source (the POD can be embedded in code). If input isnt given, it defaults to STDIN. output, if given, is the file to which to write the formatted output. If output isnt given, the formatted output is written to STDOUT. Several POD files can be processed in the same pod2man invocation (saving module load and compile times) by providing multiple pairs of input and output files on the command line. --section, --release, --center, --date, and --official can be used to set the headers and footers to use; if not given, Pod::Man will assume various defaults. pod2man assumes that your *roff formatters have a fixed-width font named CW. If yours is called something else (like CR), use --fixed to specify it. This generally only matters for troff output for printing. Similarly, you can set the fonts used for bold, italic, and bold italic fixed-width output. Besides the obvious pod conversions, Pod::Man, and therefore pod2man also takes care of formatting func(), func(n), and simple variable references like $foo or @bar so you dont have to use code escapes for them; complex expressions like $fred{stuff} will still need to be escaped, though. It also translates dashes that arent used as hyphens into en dashes, makes long dashes--like this--into proper em dashes, fixes "paired quotes," and takes care of several other troff-specific tweaks. See Pod::Man for complete information. OPTION -c string, --center=string Sets the centered page header to string. The default is "User Contributed Perl Documentation", but also see --official below. -d string, --date=string Set the left-hand footer string to this value. By default, the modification date of the input file will be used, or the current date if input comes from STDIN. --fixed=font The fixed-width font to use for vertabim text and code. Defaults to CW. Some systems may want CR instead. Only matters for troff(1) output. --fixedbold=font Bold version of the fixed-width font. Defaults to CB. Only matters for troff(1) output. --fixeditalic=font Italic version of the fixed-width font (actually, something of a misnomer, since most fixed-width fonts only have an oblique version, not an italic version). Defaults to CI. Only matters for troff(1) output. --fixedbolditalic=font Bold italic (probably actually oblique) version of the fixed-width font. Pod::Man doesnt assume you have this, and defaults to CB. Some systems (such as Solaris) have this font available as CX. Only matters for troff(1) output. -h, --help Print out usage information. -l, --lax Dont complain when required sections are missing. Not currently used, as POD checking functionality is not yet implemented in Pod::Man. -o, --official Set the default header to indicate that this page is part of the standard Perl release, if --center is not also given. -q quotes, --quotes=quotes Sets the quote marks used to surround C<> text to quotes. If quotes is a single character, it is used as both the left and right quote; if quotes is two characters, the first character is used as the left quote and the second as the right quoted; and if quotes is four characters, the first two are used as the left quote and the second two as the right quote. quotes may also be set to the special value none, in which case no quote marks are added around C<> text (but the font is still changed for troff output). -r, --release Set the centered footer. By default, this is the version of Perl you run pod2man under. Note that some system an macro sets assume that the centered footer will be a modification date and will prepend something like "Last modified: "; if this is the case, you may want to set --release to the last modified date and --date to the version number. -s, --section Set the section for the .TH macro. The standard section numbering convention is to use 1 for user commands, 2 for system calls, 3 for functions, 4 for devices, 5 for file formats, 6 for games, 7 for miscellaneous information, and 8 for administrator commands. There is a lot of variation here, however; some systems (like Solaris) use 4 for file formats, 5 for miscellaneous information, and 7 for devices. Still others use 1m instead of 8, or some mix of both. About the only section numbers that are reliably consistent are 1, 2, and 3. By default, section 1 will be used unless the file ends in .pm in which case section 3 will be selected. EXAMPLES pod2man program > program.1 pod2man /usr/perl/man/man3/SomeModule.3 pod2man --section=7 note.pod > note.7 If you would like to print out a lot of man page continuously, you probably want to set the C and D registers to set contiguous page numbering and even/odd paging, at least on some versions of man(7). troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ... To get index entries on stderr, turn on the F register, as in: troff -man -rF1 perl.1 The indexing merely outputs messages via .tm for each major page, section, subsection, item, and any X<> directives..

Requirements: No special requirements
Platforms: Linux
Keyword: Fixed-width Font Font Libraries Output Perl Module Programming To Set Troff Used Will Be
Users rating: 0/10

License: Freeware Size: 6 MB
More Reviews or Write Review

Libraries  -  GPS::Lowrance 0.31
GPS::Lowrance is a Perl module connect to Lowrance and Eagle GPS devices. REQUIREMENTS The following modules are required to use this module: Carp::Assert GPS::Lowrance::LSI 0.23 Parse::Binary::FixedFormat Win32::SerialPort or...
22.53 KB  
Libraries  -  Mobile::Wurfl 1.06
Mobile::Wurfl is a Perl module interface to WURFL (the Wireless Universal Resource File. SYNOPSIS my $wurfl = Mobile::Wurfl->new( wurfl_home => "/path/to/wurfl/home", db_descriptor => "DBI:mysql:database=wurfl:host=localhost", db_username...
102.4 KB  
Libraries  -  Web 1.35
Web Perl module contains a set of useful routines for many webworking purposes. This module was primarily made for UNIX/Linux-Systems. Parts of it cannot be used on other systems. E.g. the procedures for file locking demand systems that can use...
17.41 KB  
Libraries  -  dump_kstat 0.05a
dump_kstat is a Perl module created to dump the kstat structure. This simple script dumps the entire kstat structure to stdout - useful for figuring out what statistics are available. EXAMPLES $ dump_kstat audio.0.audioc0 class = controller...
24.58 KB  
Libraries  -  ASNMTAP::Asnmtap::Plugins::Mail 3.000.010
ASNMTAP::Asnmtap::Plugins::Mail is a Perl module that provides Mail functions used by ASNMTAP-based plugins. SYNOPSIS use ASNMTAP::Asnmtap::Plugins::Mail; my $objectNagios = ASNMTAP::Asnmtap::Plugins::Mail->new (); Sending and receiving...
1.6 MB  
Libraries  -  ASNMTAP::Asnmtap::Plugins::SOAP 3.000.010
ASNMTAP::Asnmtap::Plugins::SOAP is a Perl module that provides SOAP functions used by ASNMTAP-based plugins. SYNOPSIS use ASNMTAP::Asnmtap::Plugins v3.000.010; use ASNMTAP::Asnmtap::Plugins qw(:PLUGINS); my $objectPlugins =...
1.6 MB  
Libraries  -  Devel::Hints 0.11
Devel::Hints is a Perl module created to access compile-time hints at runtime. SYNOPSIS use Devel::Hints :all; LABEL: print cop_label(); # LABEL cop_label(0 => FOO); # "goto FOO;" is valid after this point! print cop_file(); # same as...
44.03 KB  
Libraries  -  Locale::Maketext::Extract::Run 0.62
Locale::Maketext::Extract::Run is a Perl module interface to SYNOPSIS use Locale::Maketext::Extract::Run xgettext; xgettext(@ARGV);.
83.97 KB  
Libraries  -  Variable::Alias 0.01
Variable::Alias is a Perl module created to alias any variable to any other variable. SYNOPSIS use Variable::Alias alias; my $src; my $a; our $b; my @c; our @d; alias $src => $a; alias $a => $b; alias $b => $c[0]; alias @c => @d;...
3.07 KB  
Libraries  -  Test::Manifest 1.17
Test::Manifest is a Perl module created to interact with a t/test_manifest file. SYNOPSIS # in Makefile.PL eval "use Test::Manifest"; # in the file t/test_manifest, list the tests you want # to run Test::Harness assumes that you want to...
7.17 KB  
Programming  -  FLEX-db Digital Asset Manager 3.0.9
FLEX-db - an enterprise Digital Asset Manager (DAM). It ingests and links metadata with files, creates thumbnails, and processes files using business rules. FLEX-db has a JSP client, Java app server for file input and output and an EJB metadata...
21.57 MB  
Programming  -  Libicom 0.9.0
The libicom library is a character based dynamicly linked library for Linux. It is used to remotely control the Icom IC-R8500 wide band receiver via an RS232 link. All call and return parameters to the control functions are character string based....
20.48 KB  
Programming  -  dotdesktop 0.3
Dotdesktop library provides ability to parse desktop entry file and access the information in a convenient way. Desktop entry file format is defined by, it is used to describe information about an application such as the name and...
327.68 KB  
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  -  libyasl 0.2
Libyasl is a C++ class library to easily realize TCP/UDP/Multicast clientsand servers in IPv4 and IPv6 environments under GNU/Linux systems.
143.36 KB  
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  
Libraries  -  App::SimpleScan::Substitution::Line 2.02
App::SimpleScan::Substitution::Line is a line with optional fixed variable values. SYNOPSIS my $line = App::SimpleScan::Substitution::Line->new(" this "); # Use only this value when substituting " ". $line->fix(substituite =>...
54.27 KB