DragonFly On-Line Manual Pages

Search: Section:  

unroff-html-me(1)      DragonFly General Commands Manual     unroff-html-me(1)


NAME

       unroff-html-me - back-end to translate `me' documents to HTML 2.0


SYNOPSIS

       unroff [ -fhtml ] [ -me ] [ file | option... ]


OVERVIEW

       When called with the -fhtml and -me options, the troff translator
       unroff loads the back-end for converting "me" documents to the
       Hypertext Markup Language (HTML) version 2.0.

       Please read unroff(1) first for an overview of the Scheme-based,
       programmable troff translator and for a description of the generic
       options that exist in addition to -f and -m.  The translation of basic
       troff requests, special characters, escape sequences, etc. as well as
       the HTML-specific options are described in unroff-html(1).  For
       information about extending and programming unroff also refer to the
       Unroff Programmer's Manual.


OPTIONS

       The -me extension provides a number of keyword/value options in
       addition to those listed in unroff(1) and unroff-html(1):

       signature (string)
              If non-empty, the value of this option together with a <hr> tag
              is appended to each HTML output file created.  The substitute
              Scheme primitive (as described in the Programmer's Manual) is
              applied to the value of the option, so that date, time,
              environment variables, etc. can be interpolated.

       pp-indent (integer)
              The number of non-breakable spaces (as specified by the
              predefined Scheme variable nbsp) to generate for a paragraph
              created by the .pp macro.  The default is 3.  This option, as
              well as signature, is typically set in the user-preferences file
              ~/.unroff, or in a document-specific Scheme file or at the
              beginning of the document proper.


FILES

       unroff reads and parses an "me" document composed of one or more input
       files.  As usual, the special file name `-' can be used to interpolate
       standard input.  If no file name is given in the command line, unroff
       reads from standard input.

       The resulting HTML document is sent to standard output, unless a file
       name prefix is assigned to the document option.


EXAMPLE

       To translate an "me" document composed of several input files, unroff
       could be invoked like this:

              unroff -fhtml -me document=thesis\
                     intro.me 1.me 2.me 3.me app.me

       The output file will have the name "thesis.html".


DESCRIPTION

       The following -me macros are translated (in addition to any user-
       defined macros):

               .(b     .)b     .(c     .)c     .(d     .)d     .(f
               .)f     .(l     .)l     .(q     .)q     .(x     .)x
               .(z     .)z     .b      .bi     .bx     .hl     .i
               .ip     .np     .pd     .q      .r      .rb     .sz
               .sh     .u      .uh     .xp     .++     .+c

       These predefined strings and number registers are recognized:

               \*(lq   \*(rq   \*-     \*(mo   \*(dw   \*(dy   \*(td
               \n($c   \n($d   \n($f   \n($m   \n($n   \**     \*#

       In addition, a number of macros are either silently ignored or cause a
       warning to be printed, because their function either cannot be mapped
       to HTML 2.0 elements or assumes a page structure:

               .$H     .$f     .$h     .1c     .2c     .ac     .ar
               .bc     .ef     .eh     .fo     .he     .hx     .lh
               .ll     .m1     .m2     .m3     .m4     .of     .oh
               .pa     .ro     .sk     .th     .xl

       Finally, these macros are not implemented, but could be in a future
       version:

               .sx

       The font switching macros are based on changes to the fonts `R', `I',
       and `B', as explained under FONTS in unroff-html(1).  Of course, this
       fails if the fonts (which are mounted on startup) are unmounted by
       explicit .fp requests.

       The special characters

               \(!<  and  \(!>

       respectively generate < and > in the resulting html.  These permit html
       elements to be put directly into the document text, as in e.g.

          .Hr -symbolic next "\(!<img src=""next.gif"" alt=""next""\(!>"

       to generate a reference to some other part of the document via a
       selectable image.


SEE ALSO

       unroff(1), unroff-html(1), troff(1), me(5 or 7).

       Unroff Programmer's Manual.

       http://www.informatik.uni-bremen.de/~net/unroff

       Berners-Lee, Connolly, et al., HyperText Markup Language
       Specification--2.0, Internet Draft, Internet Engineering Task Force.


BUGS

       The macro .ul is currently mapped to a call to .i, as underlining is
       not supported by the HTML back-end of unroff 1.0.

       The section setting options of the .sh macro are not implemented.

                                  1996/02/02                 unroff-html-me(1)

Search: Section: