<< Back to previous view

[PCC-120] man pages do not format correctly Created: 23/Feb/10  Updated: 27/Jun/10

Status: Closed
Project: pcc
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Major
Reporter: Jörg Schilling Assignee: Anders Magnusson
Resolution: Fixed Votes: 0
Environment: Solaris SXCE SNV_106


 Description   
The man pages unfortunately do not use the man macro set and for this
reason cannot be viewed with the UNIX nroff/troff.

Please convert the man pages to use the man macro set.

 Comments   
Comment by Anders Magnusson [ 25/Feb/10 06:57 PM ]
Hm, do you mind telling what directives are erroneously used?
I don't have any Solaris machines to test on :-)
Comment by Jörg Schilling [ 26/Feb/10 12:40 AM ]
Well, I believe that none of the macros used in the man pages
from the pcc project is a "man" macro. As a result, you need
GNU troff to view the manual pages. I believe it would be a nice
gesture for a project under BSD license to work completely
without the need tp use GPLd software.

man macros are all using uppercase letters only:

.SH
.PP
.LP
.B
.BI
.BR
.TH
.TP
and similar are part of the man macro set.


...autoconf is a different thing as it does not show up in the final
compilation results. The man pages however are installed.
Comment by Iain Hibbert [ 10/Mar/10 09:04 PM ]
for a BSD licenced -mdoc macro compiler, please see

      http://mdocml.bsd.lv/

it doesn't say that it will build on Solaris, but Kristaps is a helpful guy and I'm sure he would be interested to have it do so..

Then there is also a set of BSD licenced mdoc macros in OpenBSD that I found instructions for using on Solaris with pkgsrc at

     http://perso.telecom-paristech.fr/~dauphin/pkgsrcmywork/

perhaps it would be of use

(neither suggestions fix the issue, but perhaps it makes fixing it unnecessary)
Comment by Jörg Schilling [ 10/Mar/10 11:44 PM ]
Yesterday, I started with the mandoc macros from BSD-4.4 (1993) and
fixed the code for the AT&T ditroff that is used on Solaris. It works nicely
with e.g. "man -T -mandoc ..." but you need to be root in order to install
the mandoc package I created into /usr/share/lib/tmac/

Comment by Anders Magnusson [ 27/Jun/10 07:15 PM ]
Hm, I just checked and the historical man macros are a little too limited to make nice man pages.
Also, I think it's better to update Solaris to newer man macros. I assume that almost all programs
these days use mandoc macros.
Generated at Mon Dec 29 17:37:53 CET 2014 using JIRA Enterprise Edition, Version: 3.13.1-#333.