Zandronum Chat on our Discord Server Get the latest version: 3.1
Source Code

View Revisions: Issue #3248 All Revisions ] Back to Issue ]
Summary 0003248: Create or convert libwadseeker API documentation to mdoc/nroff manual page format
Revision 2017-10-05 01:46 by WubTheCaptain
Description The 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).
Revision 2017-09-01 17:44 by WubTheCaptain
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:


  • 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).






Questions or other issues? Contact Us.

Links


Copyright © 2000 - 2024 MantisBT Team
Powered by Mantis Bugtracker