podToHtml.pl

# NAME

podToHtml.pl - Convert EPICS .pod files to .html

# SYNOPSIS

podToHtml.pl [-h] [-s] [-o file.html] file.pod

# DESCRIPTION

Converts files from Perl's POD format into HTML format.

The generated HTML output file refers to a CSS style sheet style.css which can be located in a parent directory of the final installation directory. The relative path to that file (i.e. the number of parent directories to traverse) is calculated based on the number of components in the path to the input file.

# OPTIONS

podToHtml.pl understands the following options:

-h

  Help, display this document as text.

-s

  Indicates that one leading component of the input file path is not part of the final installation path, thus should be removed before calculating the relative path to the style-sheet file. This flag may be repeated as many times as needed to remove multiple leading components from the path to the style sheet.

-o file.html

  Name of the HTML output file to be created.

If no output filename is set, the file created will be named after the input file, removing any directory components in the path and replacing any file extension with .html.

# COPYRIGHT AND LICENSE

Copyright (C) 2013 UChicago Argonne LLC, as Operator of Argonne National Laboratory.

This software is distributed under the terms of the EPICS Open License.