Zandronum Chat @ irc.zandronum.com
#zandronum
Get the latest version: 3.0
Source Code

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0003248Doomseeker[All Projects] Suggestionpublic2017-09-01 17:442017-09-09 19:01
ReporterWubTheCaptain 
Assigned To 
PrioritylowSeveritytextReproducibilityN/A
StatusnewResolutionopen 
PlatformOSOS Version
Product Version1.1 
Target VersionFixed in Version 
Summary0003248: Create or convert libwadseeker API documentation to mdoc/groff manual page format
DescriptionThe libwadseeker library would be nice to come with at least an English manual page, either in mdoc format (*BSD) or groff (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 athttp://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/

Attached Files

- Relationships
child of 0003246new Debian packaging. 

-  Notes
User avatar (0018252)
Zalewa (developer)
2017-09-09 19:01

I think doxygen has built-in support for manpages generation.

Issue Community Support
Only registered users can voice their support. Click here to register, or here to log in.
Supporters: No one explicitly supports this issue yet.
Opponents: No one explicitly opposes this issue yet.

- Issue History
Date Modified Username Field Change
2017-09-01 17:44 WubTheCaptain New Issue
2017-09-01 19:12 Zalewa Relationship added child of 0003246
2017-09-09 19:01 Zalewa Note Added: 0018252






Questions or other issues? Contact Us.

Links


Copyright © 2000 - 2017 MantisBT Team
Powered by Mantis Bugtracker