From: P. J. McDermott Date: Tue, 24 Sep 2013 13:59:53 +0000 (-0400) Subject: README: Wrap at 72 columns. X-Git-Tag: ssic/1.0.0~8 X-Git-Url: https://jxself.org/git/?a=commitdiff_plain;h=f9ebc012e5ba9fe05cc17804346da7920d786f61;p=ssic.git README: Wrap at 72 columns. --- diff --git a/README b/README index 0bc7d2a..c7a3955 100644 --- a/README +++ b/README @@ -3,15 +3,16 @@ Server Side Includes Compiler This is ssic, a Server Side Includes Compiler. -ssic 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. +ssic 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. -The set of commands, tags, and variables supported by ssic is mostly a superset -of those supported by the old NCSA HTTPd and a subset of those supported by -Apache HTTPd's `mod_include`: +The set of commands, tags, and variables supported by ssic is mostly a +superset of those supported by the old NCSA HTTPd and a subset of those +supported by Apache HTTPd's `mod_include`: http://web.archive.org/web/19971210170837/http://hoohoo.ncsa.uiuc.edu/docs/tutorials/includes.html http://httpd.apache.org/docs/current/mod/mod_include.html @@ -29,29 +30,31 @@ Most commands take only one tag. The following commands are supported: - * `config` controls various aspects of processing. There are three valid - tags: - - `errmsg` controls the message that is substituted into the document when - an error occurs. - - `timefmt` is a format string used by `strftime` that controls the format - of dates. - - `sizefmt` controls the units of file sizes. Valid values are `bytes` for - sizes in bytes and `abbrev` for sizes in kibibytes or mebibytes. - * `set` sets the value of a variable. Two tags are accepted: `var` and - `value`. - * `echo` prints the value of an include variable (see below) or environment - variable. The only valid tag is `var`. - * `printenv` prints a list of all environment variables and their values. - * `include` processes and inserts the text of a document into the current - document. There are two valid tags: + * `config` controls various aspects of processing. There are three + valid tags: + - `errmsg` controls the message that is substituted into the + document when an error occurs. + - `timefmt` is a format string used by `strftime` that controls the + format of dates. + - `sizefmt` controls the units of file sizes. Valid values are + `bytes` for sizes in bytes and `abbrev` for sizes in kibibytes or + mebibytes. + * `set` sets the value of a variable. Two tags are accepted: `var` + and `value`. + * `echo` prints the value of an include variable (see below) or + environment variable. The only valid tag is `var`. + * `printenv` prints a list of all environment variables and their + values. + * `include` processes and inserts the text of a document into the + current document. There are two valid tags: - `file` gives a pathname relative to the current directory. - - `virtual` gives a pathname, beginning with `/`, relative to the document - root. + - `virtual` gives a pathname, beginning with `/`, relative to the + document root. * `exec` executes a shell command. The only valid tag is `cmd`. - * `flastmod` prints the modification date of a specified file. Valid tags are - the same as for the `include` command. - * `fsize` prints the size of a specified file. Valid tags are the same as for - the `include` command. + * `flastmod` prints the modification date of a specified file. Valid + tags are the same as for the `include` command. + * `fsize` prints the size of a specified file. Valid tags are the + same as for the `include` command. Include Variables ----------------- @@ -61,8 +64,8 @@ The following variables are set: * `DATE_GMT` is the current date in UTC. * `DATE_LOCAL` is the current date in the local timezone. * `DOCUMENT_NAME` is the current filename. - * `DOCUMENT_ROOT` is the document root, in which files specified with the - `virtual` tag are found. + * `DOCUMENT_ROOT` is the document root, in which files specified with + the `virtual` tag are found. * `DOCUMENT_URI` is the current filename. * `LAST_MODIFIED` is the modification date of the current document.