MantisBT - Doomseeker
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0003248Doomseeker[All Projects] Suggestionpublic2017-09-01 17:442022-08-25 10:22
ReporterWubTheCaptain 
Assigned To 
PrioritynoneSeverityfeatureReproducibilityN/A
StatusacknowledgedResolutionopen 
PlatformOSOS Version
Product Version1.1 
Target VersionFixed in Version 
Summary0003248: Create or convert libwadseeker API documentation to mdoc/nroff manual page format
DescriptionThe libwadseeker library would be nice to come with at least an English manual page, either in mdoc format (*BSD) or nroff (GNU/Linux) which can be read offline with man(1) utility. It should have as much information as possible about programming with the shared library as feasible and found useful. Here's some recommendations for sections to include:


  • NAME

  • SYNOPSIS

  • DESCRIPTION

  • BUGS

  • SEE ALSO

  • HISTORY

  • AUTHORS



Sections may be omitted as needed. Even a very minimal man page may be helpful and may be expanded in the future.

The build system should also install it to the appropriate directory (somewhere under /usr/share/man/man3 or similar).
Steps To Reproduce
$ man libwadseeker                                                          
No manual entry for libwadseeker


Assuming libwadseeker is installed as a package (in Debian GNU/Linux, in example).
Additional InformationLibwadseeker 1.1 API is defined online at'http://doomseeker.drdteam.org/docs/wadseeker_1.1/ [^]' and can be used as a base or converted to mdoc fairly straightforward, maybe.

Including a manual page for the library in Debian GNU/Linux would be preferred, but not seemingly required for packaging.


  • http://mdocml.bsd.lv/

  • http://mdocml.bsd.lv/man/mdoc.7.html

  • http://mdocml.bsd.lv/mdoc/

  • https://www.gnu.org/software/groff/

  • https://liw.fi/manpages/

TagsNo tags attached.
Relationships
related to 0003247confirmed  Doomseeker's manual page (mdoc/nroff) is missing or incomplete 
child of 0003279acknowledged  List of Debian issues (misc/non-policy) 
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2017-09-01 17:44WubTheCaptainNew Issue
2017-09-01 19:12ZalewaRelationship addedchild of 0003246
2017-09-09 19:01ZalewaNote Added: 0018252
2017-10-05 01:46WubTheCaptainStatusnew => acknowledged
2017-10-05 01:46WubTheCaptainSummaryCreate or convert libwadseeker API documentation to mdoc/groff manual page format => Create or convert libwadseeker API documentation to mdoc/nroff manual page format
2017-10-05 01:46WubTheCaptainDescription Updatedbug_revision_view_page.php?rev_id=11059#r11059
2017-10-07 05:33WubTheCaptainRelationship addedrelated to 0003247
2017-10-07 09:58WubTheCaptainNote Added: 0018458
2018-10-13 18:57WubTheCaptainSeveritytext => feature
2018-10-13 18:57WubTheCaptainPrioritylow => none
2018-10-14 13:14WubTheCaptainRelationship addedchild of 0003279
2018-10-14 13:14WubTheCaptainRelationship deletedchild of 0003246
2018-12-17 05:02WubTheCaptainAssigned To => WubTheCaptain
2018-12-17 05:02WubTheCaptainStatusacknowledged => assigned
2018-12-17 05:02WubTheCaptainStatusassigned => acknowledged
2022-08-25 10:22WubTheCaptainAssigned ToWubTheCaptain =>

Notes
(0018252)
Zalewa   
2017-09-09 19:01   
I think doxygen has built-in support for manpages generation.
(0018458)
WubTheCaptain   
2017-10-07 09:58   
Yes, Doxygen has manpage output.

I think the correct approach here is to create at least a minimal man page for the Wadseeker API by hand, and/or package the Doxygen documentation HTML or manpage output to a libwadseeker-doc package (in Debian).

I'll certainly look into this later, but until then: If anyone has free time, feel free to assign to yourself and start working on this earlier.