[opensuse-packaging] How to create a man page in your spec file.
I thought I should share this with the list. Factory rpmlint check now wants to see a man page for everything under /usr/bin, I don't know if anybody else has tried this, I used this method to create a man page for blenderplayer in the blender package :- # Generate man page with help2man help2man --version-string="%{version}" --help-option="-h" -n "a utility for previewing .blend files" -s 1 -m "User Commands" -S "Stichting Blender Foundation" -o blenderplayer.1 %{buildroot}%{_bindir}/'blenderplayer -h ""' Take especial note of the single quotes around the 'blenderplayer -h ""' expression, if they aren't there help2man can't get any output because rpmbuild directs blenderplayer to /dev/null. You don't necessarily have to put in the -h in "'blenderplayer -h ""'" it was the only thing that stopped it from looking for something to play first. Which wiki should I put this in? Regards Dave P -- To unsubscribe, e-mail: opensuse-packaging+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-packaging+help@opensuse.org
El 08/11/10 09:29, Dave Plater escribió:
I thought I should share this with the list. Factory rpmlint check now wants to see a man page for everything under /usr/bin,
That check is crazy ;) it even wants man pages for rc$yourservice symlinks, I would just ignore it. -- To unsubscribe, e-mail: opensuse-packaging+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-packaging+help@opensuse.org
On 11/08/2010 03:02 PM, Cristian Rodríguez wrote:
El 08/11/10 09:29, Dave Plater escribió:
I thought I should share this with the list. Factory rpmlint check now wants to see a man page for everything under /usr/bin,
That check is crazy ;) it even wants man pages for rc$yourservice symlinks, I would just ignore it.
It is crazy, I just thought I'd share the idea. Blender also has two scripts in /usr/bin, I just linked them to blender.1 to stop it from making too much noise at the end of the build log. I'm about to work on bacula which has multiple rc$yourservice's one for each of the three sqls but at least it's well man ed. Besides if the rc script has a help output a man page wouldn't hurt, openSUSE's the only distro with rc in front of the service scripts isn't it? Dave P -- To unsubscribe, e-mail: opensuse-packaging+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-packaging+help@opensuse.org
On 2010-11-08 15:52:12 +0200, Dave Plater wrote:
It is crazy, I just thought I'd share the idea. Blender also has two scripts in /usr/bin, I just linked them to blender.1 to stop it from
that is wrong. if the scripts are not explained in blender.1 then you shouldnt link the manpage to the scriptname.1 darix -- openSUSE - SUSE Linux is my linux openSUSE is good for you www.opensuse.org -- To unsubscribe, e-mail: opensuse-packaging+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-packaging+help@opensuse.org
On 11/08/2010 03:58 PM, Marcus Rueckert wrote:
On 2010-11-08 15:52:12 +0200, Dave Plater wrote:
It is crazy, I just thought I'd share the idea. Blender also has two scripts in /usr/bin, I just linked them to blender.1 to stop it from
that is wrong. if the scripts are not explained in blender.1 then you shouldnt link the manpage to the scriptname.1
darix
Unlinking, I'll use rpmlint instead. Regards Dave P -- To unsubscribe, e-mail: opensuse-packaging+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-packaging+help@opensuse.org
On Mon, 8 Nov 2010, Dave Plater wrote:
On 11/08/2010 03:58 PM, Marcus Rueckert wrote:
On 2010-11-08 15:52:12 +0200, Dave Plater wrote:
It is crazy, I just thought I'd share the idea. Blender also has two scripts in /usr/bin, I just linked them to blender.1 to stop it from
that is wrong. if the scripts are not explained in blender.1 then you shouldnt link the manpage to the scriptname.1
darix
Unlinking, I'll use rpmlint instead. Regards Dave P
We should have undocumented.[1-9] to link to (at %post time).
Richard.
--
Richard Guenther
On 11/8/10 2:02 PM, Cristian Rodríguez wrote:
El 08/11/10 09:29, Dave Plater escribió:
I thought I should share this with the list. Factory rpmlint check now wants to see a man page for everything under /usr/bin,
That check is crazy ;) it even wants man pages for rc$yourservice symlinks, I would just ignore it.
Well, if I recall correctly, Debian requires a man page for all executables. /etc/init.d scripts might be different... I think the warning for non-symlinked exectuables is very sensible. The issue here is how can packagers add missing man pages without lots of extra work and are there simple tools to create them with correct syntax. The only gui tool I know of is Manedit, but its GTK1 and not maintained. Peter -- To unsubscribe, e-mail: opensuse-packaging+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-packaging+help@opensuse.org
On 11/09/2010 09:43 AM, Peter Linnell wrote:
On 11/8/10 2:02 PM, Cristian Rodríguez wrote:
El 08/11/10 09:29, Dave Plater escribió:
I thought I should share this with the list. Factory rpmlint check now wants to see a man page for everything under /usr/bin,
That check is crazy ;) it even wants man pages for rc$yourservice symlinks, I would just ignore it.
Well, if I recall correctly, Debian requires a man page for all executables.
/etc/init.d scripts might be different...
I think the warning for non-symlinked exectuables is very sensible.
The issue here is how can packagers add missing man pages without lots of extra work and are there simple tools to create them with correct syntax. The only gui tool I know of is Manedit, but its GTK1 and not maintained.
Peter It was the debian blender maintainer that created blender.1 man page. Help2man creates a reasonable man page from the help output of an executable or it's info page if present and it has options for merging text from files. The example I gave for creating a man page for blenderplayer in the spec file needs a bit of sed ing to remove the unwanted -h "" because the executable refused to give a help output without looking for a .blend file first but if help2man is used with a normal --help output the man page is fine. I've sr 52400 to update help2man to version 1.38.2 which has a couple of new features and works even better than the existing version. Regards Dave P -- To unsubscribe, e-mail: opensuse-packaging+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-packaging+help@opensuse.org
participants (5)
-
Cristian Rodríguez -
Dave Plater -
Marcus Rueckert -
Peter Linnell -
Richard Guenther