From: P. J. McDermott Date: Tue, 24 Sep 2013 02:34:47 +0000 (-0400) Subject: ssic: Add POD paragraphs. X-Git-Tag: ssic/1.0.0~14 X-Git-Url: https://jxself.org/git/?a=commitdiff_plain;h=fe1558c06fc2f0e6646e9f7d9b1eac45ab3d6b19;p=ssic.git ssic: Add POD paragraphs. --- diff --git a/bin/ssic b/bin/ssic index a88e565..ea0a838 100755 --- a/bin/ssic +++ b/bin/ssic @@ -1,21 +1,10 @@ #!/usr/bin/perl -# -# ssic - Server Side Includes Compiler -# -# Copyright (C) 2013 Patrick "P. J." McDermott -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . + +=head1 NAME + +ssic - Server Side Includes Compiler + +=cut use strict; use warnings; @@ -203,3 +192,76 @@ sub compile } main(); + +__END__ + +=head1 SYNOPSIS + +B +[B<-o> I] +[B<-I> I] +[B<-D> I=I ...] +I ... + +=head1 DESCRIPTION + +B processes HTML documents with SSI directives formatted as SGML comments. +It can be used to process documents without an HTTP server for local browsing or +to generate static HTML documents to be efficiently served by an HTTP server. +Documents could even be preprocessed, e.g. by a Markdown processor, before being +parsed with ssic. + +=head1 OPTIONS + +=over 4 + +=item B<-o> I + +Place the output into I. + +=item B<-I> I + +Set the document root to I. + +=item B<-D> I=I + +Set the variable I to I. + +=item B<-h>, B<--help> + +Display help information. + +=item B<-V>, B<--version> + +Display compiler version information. + +=back + +=head1 COPYRIGHT + +Copyright (C) 2013 Patrick "P. J." McDermott + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +=head1 SEE ALSO + +L + +NCSA HTTPd SSI documentation: +L + +Apache HTTPd mod_include documentation: +L + +=cut