This is the mail archive of the
binutils@sources.redhat.com
mailing list for the binutils project.
Re: Should we remove those man pages from CVS?
- To: obrien at FreeBSD dot org
- Subject: Re: Should we remove those man pages from CVS?
- From: Stephane Carrez <Stephane dot Carrez at worldnet dot fr>
- Date: Mon, 25 Jun 2001 22:23:03 +0200
- CC: "H . J . Lu" <hjl at lucon dot org>, Nick Clifton <nickc at cambridge dot redhat dot com>, binutils at sourceware dot cygnus dot com
- References: <20010616093504.B2742@lucon.org> <m3ae371mas.fsf@north-pole.nickc.cambridge.redhat.com> <20010617120315.A2587@lucon.org> <20010625111426.A99064@dragon.nuxi.com>
Hi David,
David O'Brien a écrit :
> The resulting manpages have a nit in them:
>
> OBJCOPY.1(1) GNU OBJCOPY.1(1)
>
> the ".1" should not be there. They also product a fully blank last page
> on BSD.
>
Too bad....
For ".1", it's my fault (:- The additional .1 comes from the Makefile rule:
$(srcdir)/objcopy.1: $(srcdir)/binutils.texi
touch $@
-$(TEXI2POD) $(MANCONF) -Dobjcopy < $< > $@.pod
-($(POD2MAN) $@.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \
mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1)
rm -f $@.pod
And the name given to pod2man is objcopy.1.pod; It uses it to generate the title.
It's easily fixed by replacing any $@.pod with the good NAME.pod.
> Also the SYNOPSIS is much, much uglier with the generated versions. This
> is because it is now:
>
> .SH "SYNOPSIS"
> objcopy [ \-F \fIbfdname\fR | --target=\fIbfdname\fR ]
> [ \-I \fIbfdname\fR | --input-target=\fIbfdname\fR ]
>
> vs 2.11.0's:
>
> .SH SYNOPSIS
> .hy 0
> .na
> .TP
> .B objcopy
> .RB "[\|" \-F\ \fIbfdname\fR\ |\ \fB\-\-target=\fIbfdname\fR "\|]"
> .RB "[\|" \-I\ \fIbfdname\fR\ |\ \fB\-\-input\-target=\fIbfdname\fR "\|]"
>
> The BSD man system displays this with lot of surrounding blanks around the
> ['s and ]'s.
>
> Is anyone working on making the manpage generating script better to get
> the same quality of manpage formatting as before?
>
The man pages are generated with pod2man. You might contact Russ who
maintains that tool: Russ Allbery <rra@stanford.edu>
The generated man pages are not perfect; but at least,
their content is up to date...
Stephane
-----------------------------------------------------------------------
Home Office
E-mail: stcarrez@worldnet.fr Stephane.Carrez@sun.com
WWW: http://home.worldnet.fr/stcarrez http://www.sun.com
Mail: 17, rue Foucher Lepelletier 6, avenue Gustave Eiffel
92130 Issy Les Moulineaux 78182 Saint Quentin en Yvelines
France