1. Introduction

troff2page is a Lua scrit that converts troff (man and ms) documents into HTML web pages.

To convert an input troff document named jobname.ms, use the script troff2page on the operating-system command line.

    troff2page jobname.ms

at your operating-system prompt. This creates an output HTML file jobname.html in the current directory. (This HTML file has the same basename as the input troff file (i.e., jobname), but its extension is .html.)

If the input troff uses the page-break request .bp, then the output HTML consists of a series of interlinked files: The first file is named jobname.html; the rest are jobname-Z-H-1.html, jobname-Z-H-2.html, etc.

The script troff2page runs on the Unix command-line on Cygwin, Linux, Mac OS X, and Solaris.

Copy the script troff2page to your PATH.

For more information, please see the file INSTALL.adoc in the distribution.

Calling troff2page from within Lua

It is not necessary to run the file troff2page as a Unix script. You can simply load troff2page.lua (troff2page is a soft link to the Lua file troff2page.lua) into Lua, and then call the Lua procedure troff2page on your source document. E.g.,


The procedure troff2page can be called several times, on the same or different documents, from within the same Lua session.