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

View Revisions: Issue #3247 All Revisions ] Back to Issue ]
Summary 0003247: Doomseeker's manual page (mdoc/nroff) is missing or incomplete
Revision 2017-10-03 05:14 by WubTheCaptain
Description Doomseeker's binary executable should 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 using and configuring the program as feasible and found useful. Here's some recommendations for sections to include:


  • NAME

  • SYNOPSIS

  • DESCRIPTION

  • OPTIONS

  • FILES

  • EXIT STATUS

  • ENVIRONMENT

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

Lintian tag (warning): binary-without-manpage (severity normal, certainty possible)
Revision 2017-09-01 17:30 by WubTheCaptain
Description Doomseeker's binary executable should 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 using and configuring the program as feasible and found useful. Here's some recommendations for sections to include:


  • NAME

  • SYNOPSIS

  • DESCRIPTION

  • OPTIONS

  • FILES

  • EXIT STATUS

  • ENVIRONMENT

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

Lintian tag (warning): binary-without-manpage (severity normal, certainty possible)






Questions or other issues? Contact Us.

Links


Copyright © 2000 - 2024 MantisBT Team
Powered by Mantis Bugtracker