0003247: Doomseeker's manual page (mdoc/nroff) is missing or incomplete - MantisBT

MantisBT - Doomseeker

View Issue Details

ID

Project

Category

View Status

Date Submitted

Last Update

0003247

Doomseeker

[All Projects] Bug

public

2017-09-01 17:30

2022-08-25 10:22

Reporter

WubTheCaptain

Assigned To

Priority

normal

Severity

feature

Reproducibility

N/A

Status

confirmed

Resolution

open

Platform

x86_64 (really cross-platform)

OS

Debian GNU/Linux

OS Version

buster/sid

Product Version

1.1

Target Version

Fixed in Version

Summary

0003247: Doomseeker's manual page (mdoc/nroff) is missing or incomplete

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)

Steps To Reproduce

$ man doomseeker
No manual entry for doomseeker
See 'man 7 undocumented' for help when manual pages are not available.

Additional Information

Note: 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/

Tags

No tags attached.

Relationships

related to	0003248	acknowledged		Create or convert libwadseeker API documentation to mdoc/nroff manual page format
related to	0003233	closed	Zalewa	Add support for the XDG Base Directory Specification and default to it
related to	0003282	closed	Zalewa	Omitting file from --version-json command line parameter doesn't print to standard output
parent of	0003290	closed	WubTheCaptain	Doomseeker's --tests option is undocumented
parent of	0003250	closed	Blzut3	Doomseeker's --help option is undocumented
related to	0003295	closed	Zalewa	Rename LICENSE files to COPYING
child of	0003246	acknowledged		Debian packaging
child of	0003499	assigned	Pol M	Port Doomseeker to OpenBSD

Attached Files

doomseeker-doc-draft1.tar.gz (11,086) 2017-10-04 06:47
https://zandronum.com/tracker/file_download.php?file_id=2215&type=bug

Issue History

Date Modified

Username

Field

Change

2017-09-01 17:30

New Issue

2017-09-01 19:12

Relationship added

child of 0003246

2017-09-03 07:39

Note Added: 0018226

2017-09-07 19:36

Note Added: 0018235

2017-10-03 05:13

Note Added: 0018418

2017-10-03 05:14

Summary

Doomseeker's manual page (mdoc/groff) is missing or incomplete => Doomseeker's manual page (mdoc/nroff) is missing or incomplete

2017-10-03 05:14

Description Updated

bug_revision_view_page.php?rev_id=11025#r11025

2017-10-03 05:15

Status

new => feedback

2017-10-03 05:16

Note Edited: 0018418

bug_revision_view_page.php?bugnote_id=18418#r11027

2017-10-04 00:17

Note Added: 0018425

2017-10-04 00:17

Status

feedback => new

2017-10-04 00:18

Status

new => feedback

2017-10-04 03:28

Note Added: 0018428

2017-10-04 06:26

Note Added: 0018429

2017-10-04 06:26

Status

feedback => new

2017-10-04 06:26

Status

new => feedback

2017-10-04 06:26

Note Edited: 0018429

bug_revision_view_page.php?bugnote_id=18429#r11042

2017-10-04 06:27

Note Edited: 0018429

bug_revision_view_page.php?bugnote_id=18429#r11043

2017-10-04 06:47

File Added: doomseeker-doc-draft1.tar.gz

2017-10-04 06:48

Status

feedback => needs review

2017-10-05 01:19

Note Added: 0018444

2017-10-05 01:22

Status

needs review => acknowledged

2017-10-05 01:55

Status

acknowledged => confirmed

2017-10-05 02:00

Assigned To

=> WubTheCaptain

2017-10-05 02:00

Status

confirmed => assigned

2017-10-05 02:56

Target Version

=> 1.2

2017-10-07 05:16

Note Added: 0018453

2017-10-07 05:16

Status

assigned => feedback

2017-10-07 05:31

Relationship added

related to 0003290

2017-10-07 05:32

Relationship added

related to 0003250

2017-10-07 05:33

Relationship added

related to 0003248

2017-10-07 08:55

Relationship added

related to 0003233

2017-10-07 08:56

Relationship added

related to 0003282

2017-10-07 08:59

Note Added: 0018455

2017-10-07 08:59

Status

feedback => assigned

2017-10-07 09:07

Status

assigned => feedback

2017-10-07 09:41

Relationship added

related to 0003295

2017-10-12 00:39

Note Added: 0018538

2017-10-12 05:11

Status

feedback => assigned

2018-02-19 22:07

Status

assigned => confirmed

2018-02-19 22:07

Relationship replaced

child of 0003290

2018-02-19 22:08

Relationship replaced

parent of 0003290

2018-02-19 22:08

Relationship replaced

parent of 0003250

2018-02-19 22:50

Additional Information Updated

bug_revision_view_page.php?rev_id=11419#r11419

2018-09-19 17:34

Relationship added

child of 0003499

2018-09-22 15:55

Target Version

1.2 =>

2018-10-13 16:50

Severity

minor => feature

2022-08-25 10:22

Assigned To

WubTheCaptain =>

Notes

Quote from WubTheCaptain
If omitted, is the default host:port for --connect and --rcon options always localhost:10666?

The port number is defined by the plugin, but yes it will be localhost.

Quote from WubTheCaptain
Should it be mentioned in NOTES section which game engines/plugins have free game data available (e.g. Freedoom)?

Seems out of scope to me. Besides Turok that's all of them.

Quote from WubTheCaptain
What exactly is a binary file located at "$HOME/.doomseeker/Zandronum"? It was created on first start-up. Is it relevant to mention in the FILES section? Currently the FILES section lists the IP2C database and three configuration files for Doomseeker.

This is a dump of the master server response so in the case that it is temporarily offline it can use the last list it got. Although I don't know why I didn't make them standard pcap files.

Quote from WubTheCaptain
Does Doomseeker 1.1 or 1.2-beta use any environment valuables which should be noted in the ENVIRONMENT section? I'm not aware of any.

Besides anything that Qt might be affected by and standard stuff (HOME, etc) no.

Quote from WubTheCaptain
Is there conformance (CONFORMING TO or STANDARDS section) to any of the various standards listed in standards(7) (or standards listed in mdoc(7) in OpenBSD)? Is there a guideline which C++ standard version Doomseeker source code aims to use (e.g. C++03, C++11, C++14)? I'm thinking of maybe listing FHS and XDG base directory specification here soon.

Doomseeker is currently written in C++03.

Quote from WubTheCaptain
For submitting patches/diffs, where would you prefer manual pages to be located in the project file structure in revision control? I can post the man page and let you decide.

The docs directory would be the place to put them, although the files currently in there should probably be reorganized a little.

Quote from WubTheCaptain
Would you be opposed to including an AUTHORS or THANKS file in the project root? My idea is to install this to /usr/share/doc/doomseeker/AUTHORS and reference it from the AUTHORS section in the man page. It would also include my email address, which is not currently included in the copyright notice.

An AUTHORS file is fine. Was thinking that might be useful while I was going commit by commit to find any relevant contributions for the LGPL relicense.