|View Issue Details [ Jump to Notes ] ||[ Issue History ] [ Print ] |
|ID||Project||Category||View Status||Date Submitted||Last Update|
|0003248||Doomseeker||[All Projects] Suggestion||public||2017-09-01 17:44||2017-09-09 19:01|
|Assigned To|| |
|Product Version||1.1|| |
|Target Version||Fixed in Version|| |
|Summary||0003248: Create or convert libwadseeker API documentation to mdoc/groff manual page format|
|Description||The 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:|
- SEE ALSO
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 Information||Libwadseeker 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.