[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Groff] Re: Gaius docs.

From: Werner LEMBERG
Subject: Re: [Groff] Re: Gaius docs.
Date: Fri, 31 Dec 1999 17:46:05 GMT

> I do feel some urgency in getting myself up to speed on Groff HTML,
> and having gone a month, now, without having been able to read one
> speck of the relevant docs that are already written on the subject
> so I can get started, when it should have been so simple to have had
> them available in the releases in the first place, and easy to find,
> and easy to read.

OK, I try to give a short intro into grohtml.  My sources of
information are

 .) `' in the grohtml subdir.  This file can be viewed on a
    terminal like this:

      groff -ms -Tascii | less

    (you will get warnings about some fonts unavailable which you can
    ignore).  Or, if you prefer:

      groff -ms -mhtml -Thtml > design.html

    [It is a bit embarassing that even this document can't be
    formatted correctly as a whole by grohtml :-)]

 .) tmac.arkup -- since it is a macro input file for groff, you must
    view it with a plain text editor, reading the comments in it.

First, you must decide which document macro package you want to use.
The file, for example, uses the `ms' macro package.
Unfortunately (as so many things within groff), only
documents the differences between the original UNIX troff ms
implementation and groff's one.

On the other hand, complete documentation within groff is available
for the mdoc macros:

  groff -mdoc -Tps groff
  groff -mdoc -Tps >

(interestingly, it doesn't work OK with -Tdvi... Here some
investigation is necessary).  Alternatively, you can try

  groff -mdoc -TX100 -X

to use xditview for displaying (this needs X Windows) -- note that
xditview isn't installed by default!  You must explicitly change to
the `xditview' subdir and follow the instructions given in the INSTALL
file.  Since it uses `imake' and not `configure', you can't install it
in your private bin directory if you do simply `make install'...

Other well documented macro packages in groff are `mm' -- just a
sample file is missing (I've just written to the author, asking
whether he can provide one) -- and `me'.

Finally, descriptions of the `man' macros are available in

Here a very short example using `man' macros.  The HTML output can be
produced with

  groff -man -mhtml -markup -Thtml > test.html

(`-markup' defines the various HTML-specific commands); other devices
should omit `-mhtml'.


I've just committed fixes to tmac.arkup so that the .FTP and .MAILTO
macros work with non-HTML devices also.

==== ====
.\" man page for thaiconv
.TH THAICONV 1 20-Jun-1999 "CJK Version 4.3.0"
thaiconv \- convert text strings in TIS 620 format into a special format
to be used with
.B emacs 20
in cooperation with
.BR cjk-enc.el .
It is not intended for stand-alone use.
This filter is part of the
.FTP "CJK" "";
macro package for LaTeX2e.
The CJK package has been written by
.MAILTO "address@hidden" "Werner Lemberg"
==== end of ====

Please check for the various used commands in the

Empty lines should be not used in a groff file (since they cause the
insertion of empty lines into the output), thus lines just consisting
of a dot are used instead which do nothing.

If you run this with the command given above to create an HTML page,
you can see that `.SH' (and other header requests) automatically
create tags (Gaius, is it possible to suppress this?)

`.FTP' and `.MAILTO' are used as documented in tmac.arkup.

Hope this helps.

Anybody volunteering in writing a file?


reply via email to

[Prev in Thread] Current Thread [Next in Thread]