Hi Vadim, Vadim Zhukov wrote on Sun, Oct 05, 2014 at 01:12:02PM +0400:
>> Qwt ships with two pseudo-man pages, namely qwtinstall.3 and >> qwtlicense.3. Those pages does have the only section, NAME. >> As a result, if you have Qwt installed and try to run apropos(1) >> for any word contained in those pages, your screen will be filled >> by whole page(-s). >> >> Also, some lines are interpreted as macros due to missing escaping. >> I've fixed those issues, too. >> >> Is this right way to go? Yes. If a manual is *that* badly broken, patching it is the way to go - just like for badly broken program code. Do not forget to send your two patches upstream, please. By the way, when giving talks in the future, i think i will add Doxygen to my list of tools *NOT* to use. The content of the generated documentation is best described as an insult to the reader, and the quality of the generated man(7) code is dreadful - not quite as bad as DocBook, but comparable. Bleah. > Better version after some input from jmc@, thanks! OK schwarze@, too. Oh, i see you just committed. All the better, so just ignore my OK. Yours, Ingo > Index: Makefile > =================================================================== > RCS file: /cvs/ports/x11/qwt/Makefile,v > retrieving revision 1.14 > diff -u -p -r1.14 Makefile > --- Makefile 10 Aug 2014 09:58:07 -0000 1.14 > +++ Makefile 5 Oct 2014 01:26:48 -0000 > @@ -7,7 +7,7 @@ DISTNAME = qwt-5.2.1 > SHARED_LIBS = qwt 6.0 > CATEGORIES = x11 > EXTRACT_SUFX = .tar.bz2 > -REVISION = 2 > +REVISION = 3 > > HOMEPAGE = http://qwt.sourceforge.net/ > MASTER_SITES = ${MASTER_SITE_SOURCEFORGE:=qwt/} > Index: patches/patch-doc_man_man3_qwtinstall_3 > =================================================================== > RCS file: patches/patch-doc_man_man3_qwtinstall_3 > diff -N patches/patch-doc_man_man3_qwtinstall_3 > --- /dev/null 1 Jan 1970 00:00:00 -0000 > +++ patches/patch-doc_man_man3_qwtinstall_3 5 Oct 2014 01:26:48 -0000 > @@ -0,0 +1,40 @@ > +$OpenBSD$ > +Fix the manual structure, unbreaking apropos output. > +--- doc/man/man3/qwtinstall.3.orig Sun Apr 11 13:55:11 2010 > ++++ doc/man/man3/qwtinstall.3 Sun Oct 5 05:24:45 2014 > +@@ -2,8 +2,8 @@ > + .ad l > + .nh > + .SH NAME > +-qwtinstall \- INSTALL > +-.PP > ++qwtinstall \- INSTALL > ++.SH DESCRIPTION > + .nf > + Introduction > + ============ > +@@ -49,7 +49,7 @@ make install > + > + If you have installed a shared library it's path has to be known to > + the run-time linker of your operating system. On Linux systems read > +-'man ldconfig' ( or google for it ). Another option is to use > ++\&'man ldconfig' ( or google for it ). Another option is to use > + the LD_LIBRARY_PATH (on some systems LIBPATH is used instead, on MacOSX > + it is called DYLD_LIBRARY_PATH) environment variable. > + > +@@ -104,7 +104,7 @@ C) Win32/MinGW Qt4 > + C1) Windows Shell > + > + Start a Windows Shell, where Qt4 is initialized. ( F.e. with > +-'Programs->Qt by Trolltech ...->Qt 4.x.x Command Prompt' ). > ++\&'Programs->Qt by Trolltech ...->Qt 4.x.x Command Prompt' ). > + > + qmake qwt.pro > + make > +@@ -164,7 +164,7 @@ XCode project files instead of makefiles. So you might > + following: > + > + qmake -spec macx-g++ > +-... > ++\&... > + > + D) Qtopia Core > + > Index: patches/patch-doc_man_man3_qwtlicense_3 > =================================================================== > RCS file: patches/patch-doc_man_man3_qwtlicense_3 > diff -N patches/patch-doc_man_man3_qwtlicense_3 > --- /dev/null 1 Jan 1970 00:00:00 -0000 > +++ patches/patch-doc_man_man3_qwtlicense_3 5 Oct 2014 01:26:48 -0000 > @@ -0,0 +1,42 @@ > +$OpenBSD$ > +Fix the manual structure, unbreaking apropos output. > +--- doc/man/man3/qwtlicense.3.orig Wed Aug 6 12:50:04 2014 > ++++ doc/man/man3/qwtlicense.3 Wed Aug 6 12:52:34 2014 > +@@ -2,8 +2,8 @@ > + .ad l > + .nh > + .SH NAME > +-qwtlicense \- Qwt License, Version 1.0 > +-.PP > ++qwtlicense \- Qwt License, Version 1.0 > ++.SH DESCRIPTION > + .nf > + Qwt License > + Version 1.0, January 1, 2003 > +@@ -154,7 +154,7 @@ that program using a modified version of the Library. > + > + The precise terms and conditions for copying, distribution and > + modification follow. Pay close attention to the difference between a > +-'work based on the library' and a 'work that uses the library'. The > ++\&'work based on the library' and a 'work that uses the library'. The > + former contains code derived from the library, whereas the latter must > + be combined with the library in order to run. > + > +@@ -463,7 +463,7 @@ but may differ in detail to address new problems or co > + > + Each version is given a distinguishing version number. If the Library > + specifies a version number of this License which applies to it and > +-'any later version', you have the option of following the terms and > ++\&'any later version', you have the option of following the terms and > + conditions either of that version or of any later version published by > + the Free Software Foundation. If the Library does not specify a > + license version number, you may choose any version ever published by > +@@ -514,7 +514,7 @@ ordinary General Public License). > + To apply these terms, attach the following notices to the library. It is > + safest to attach them to the start of each source file to most effectively > + convey the exclusion of warranty; and each file should have at least the > +-'copyright' line and a pointer to where the full notice is found. > ++\&'copyright' line and a pointer to where the full notice is found. > + > + <one line to give the library's name and a brief idea of what it does.> > + Copyright (C) <year> <name of author>
