Skip to content

man page garbled (Bugzilla #19207) #553

Closed
@vladak

Description

@vladak

status NEW severity enhancement in component doc for ---
Reported in version unspecified on platform ANY/Generic
Assigned to: Trond Norbye

On 2012-04-25 13:09:35 +0000, Vladimir Kotal wrote:

I just downloaded 0.11.1 binary archive and the man page supplied in man/man1/opengrok.1 is just unreadable, it seems to contain garbage XML tags:

$ nroff -man man/man1/opengrok.1 | head

"-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset
V2.0//EN"> <?Pub Inc>
opengrok 1
Mar 30, 2012
opengrok a wicked
fast source browser
opengrok
? A
ext:analyzer

On 2012-04-25 13:15:41 +0000, Lubos Kosco wrote:

I don't think this is a bug
the opengrok man page is in xml and Solaris man subsystem knows how to handle it
(docbook is used afaik)

I don't think nroff can read this man page ...

so I'd close this as not a bug , or document that this man page is docbook in readmes ... hmm ?

On 2012-04-25 13:50:05 +0000, Vladimir Kotal wrote:

(In reply to comment # 1)

I don't think this is a bug
the opengrok man page is in xml and Solaris man subsystem knows how to handle
it
(docbook is used afaik)

Not sure about that capability of man(1).

I don't think nroff can read this man page ...

so I'd close this as not a bug , or document that this man page is docbook in
readmes ... hmm ?

I just tried this on Solaris 11 box with OSLLopengrok 0.11.1 package installed:

MANPATH=$MANPATH:/usr/opengrok/man
man opengrok

and the man command displayed empty output. So, something is definitely broken.

On 2012-04-25 14:19:40 +0000, Lubos Kosco wrote:

hmm, used to work on S11 and S10 (maybe 2 years ago when I last time checked :( )

[lkosco@helius]:pts/1:2371 Jobs:0 Today: Wed Apr 25, 16:18
~/Projects/opengrok/dist>% man -M /home/lkosco/Projects/opengrok/dist -f ./opengrok.1 ; echo $?
0

so it's broken now ...

anyone a docbook expert ? :)

On 2012-04-25 15:49:21 +0000, Trond Norbye wrote:

Just to verify here.. you are using the correct man binary and not some gnu-ified thing?

On 2012-04-25 16:01:44 +0000, Lubos Kosco wrote:

I think so

the binary has the /usr/lib/sgml/sgml2roff string in it, when I did
/usr/lib/sgml/sgml2roff opengrok.1
I got proper output

and

/usr/lib/sgml/sgml2roff opengrok.1 | nroff -man

works as designed

could be a man bug ... I build the package on S11u1 internal build
and I am also using S11u1 internal ... Vlada, can you ask someone on man and any bugs on it?

On 2012-04-25 16:36:33 +0000, Jens Elkner wrote:

(In reply to comment # 5)

/usr/lib/sgml/sgml2roff opengrok.1 | nroff -man

works as designed

I'm not really convinced. Just add a '|less' optional with an -R ...
Still looks odd.

IMHO it should be adjusted to use properly the common docbook XML format instead of the proprietary outdated SolBook one. Than everybody can x-form it to man, html or whatever using docbook xslt on all platforms with an xslt processor, don't need the solaris internal sgml tool chain ...

On 2012-04-26 06:39:29 +0000, Lubos Kosco wrote:

(In reply to comment # 6)

(In reply to comment # 5)

/usr/lib/sgml/sgml2roff opengrok.1 | nroff -man

works as designed

I'm not really convinced. Just add a '|less' optional with an -R ...
Still looks odd.

IMHO it should be adjusted to use properly the common docbook XML format
instead of the proprietary outdated SolBook one. Than everybody can x-form it
to man, html or whatever using docbook xslt on all platforms with an xslt
processor, don't need the solaris internal sgml tool chain ...

So
since I have no clue how to do it, nor time to figure it out atm
I'd rather leave this to someone who has the knowledge- e.g. Trond, or you if you dare

I would gladly accept a patch (just for this issue ;) )
since we'd like to use this man page on other systems (and e.g. I am aware on debian the man page didn't work), too
(and this is a prerequisite to create debian/ubuntu packages so it would be really nice to have)

I also have no clue how to use man with docbook on a linux system, but basic man -M showed garbled xml stuff so it's definitely not converting by default like solaris
( cd dist && mkdir man1 && cp opengrok.1 man1/ && man -M pwd/ opengrok just works on Solaris, but not on linux)

hmm?
L

On 2012-04-26 07:21:55 +0000, Jens Elkner wrote:

Maybe I get some time in the next semester break.

However, it shouldn't be that hard, since both formats are pretty close and most distros have a docbook xml,xslt package. An example, how to process it is here:
http://iws.cs.uni-magdeburg.de/~elkner/pkg/saslauthd.dbk
Since there isn't really OS dep stuff, one can even skip the profile stuff/step ...

On 2012-04-26 11:37:14 +0000, Trond Norbye wrote:

I just looked at the man page on the following systems and it looks as expected:
SunOS v210 5.10 Generic_142909-17 sun4u sparc SUNW,Sun-Fire-V210
SunOS storm 5.11 oi_151a2 i86pc i386 i86pc
SunOS s10u9 5.10 Generic_Virtual i86pc i386 i86pc

THis makes me think that there is something "wrong" with the man binary in Solaris11... I don't have a solaris 11 box to verify with..

(this also means that this is no longer an opengrok bug, but a man bug. We can always rewrite this to nroff if anyone feels the call to do so and then support more limited man systems ;)

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions