[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Groff] differnces between man and implementation www.tmac
From: |
Heinz-Jürgen Oertel |
Subject: |
[Groff] differnces between man and implementation www.tmac |
Date: |
Thu, 16 Sep 2004 23:55:13 +0200 |
User-agent: |
KMail/1.7 |
Hello,
I'm on the way improving groff_www.man.
There seems to be a difference between the comments describing the syntax and
the current implementation of the .IMG and .PIMG macros.
IMG [-R|-L|-C] filename [width] [height]
but the first code lines:
.de IMG
. ie \\n[www-html] \{\
. ie '\\$2'-R' \
. HTML-TAG ".right-image"
assuming the $2 is the alignment parameter, and later $1 is the filename.
Documentation should be:
IMG filename [-R|-L|-C] [width] [height]
and even worse, $2 isn't optional.
so the doc should state:
IMG filename -R|-L|-C [width] [height]
With PIMG the order is correct, but the first argument is always
mandatory. Instead
PIMG [-R|-L|-C] filename [width] [height]
it must be written in the man page
PIMG -R|-L|-C filename [width] [height]
The best would be to adapt the macros to the documentation.
But how many text is written already?
Changing the behavior of IMG would break existing code, changing PIMG not.
Regards
Heinz
--
with best regards / mit freundlichen Grüßen
Heinz-Jürgen Oertel
+===================================================================
| Heinz-Jürgen Oertel port GmbH http://www.port.de
| mailto:address@hidden
| phone +49 345 77755-0 fax +49 345 77755-20
| Regensburger Str. 7b, D-06132 Halle/Saale, Germany
| CAN Wiki http://www.CAN-Wiki.info
| Newsletter: http://www.port.de/engl/company/content/abo_form.html
+===================================================================
- [Groff] differnces between man and implementation www.tmac,
Heinz-Jürgen Oertel <=