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
0003247Doomseeker[All Projects] Bugpublic2017-09-01 17:302017-09-07 19:36
ReporterWubTheCaptain 
Assigned To 
PrioritynormalSeverityminorReproducibilityN/A
StatusnewResolutionopen 
Platformx86_64 (really cross-platform)OSDebian GNU/LinuxOS Versionbuster/sid
Product Version1.1 
Target VersionFixed in Version 
Summary0003247: Doomseeker's manual page (mdoc/groff) is missing or incomplete
DescriptionDoomseeker'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)
Steps To Reproduce
$ man doomseeker
No manual entry for doomseeker
See 'man 7 undocumented' for help when manual pages are not available.
Additional InformationNote: Unix man pages only support text and simple formatting. No images, no video (unless you instruct to view or play something already existing on the filesystem).

The program arguments window in graphical interface navigation Help → Program Args may be an useful resource to start from. The online help pages (https://wiki.zandronum.com/Doomseeker) may also be useful.


  • 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 (0018226)
Filystea (reporter)
2017-09-03 07:39

It's gui so I would expect it to have help in the window mod.
But there could be a pointer from man I guess.
User avatar (0018235)
WubTheCaptain (reporter)
2017-09-07 19:36

I just read from Debian Policy Manual v4.1.0.0 section 12.1: The man pages should be installed in nroff source form.

I personally very much prefer mdoc format over others, but I don't mind doing the conversion by hand if needed.

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:30 WubTheCaptain New Issue
2017-09-01 19:12 Zalewa Relationship added child of 0003246
2017-09-03 07:39 Filystea Note Added: 0018226
2017-09-07 19:36 WubTheCaptain Note Added: 0018235






Questions or other issues? Contact Us.

Links


Copyright © 2000 - 2017 MantisBT Team
Powered by Mantis Bugtracker