Anonymous | Login | Signup for a new account | 2024-03-19 13:27 UTC |
My View | View Issues | Change Log | Roadmap | Doomseeker Issue Support Ranking | Rules | My Account |
View Issue Details [ Jump to Notes ] | [ Issue History ] [ Print ] | ||||||||||||
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:
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.
| ||||||||||||
Attached Files | doomseeker-doc-draft1.tar.gz [^] (11,086 bytes) 2017-10-04 06:47 | ||||||||||||
Relationships | |||||||||||||||||||||||||||||||||||||||||
|
Notes | |
(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. |
(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. |
(0018418) WubTheCaptain (reporter) 2017-10-03 05:13 edited on: 2017-10-03 05:16 |
I'm working on this today, not finished yet. I have to say, finding documentation for the nroff format is concerningly more difficult to find than mdoc. Oh well, at least I have a lot of examples. (I also discovered a bug or two in Doomseeker while writing the man page.) Zalewa, Blzut3: Do you have any preference for man page copyright license? LGPLv2.1+, GPLv2+, FDL, something else? |
(0018425) WubTheCaptain (reporter) 2017-10-04 00:17 |
I'm wondering what to do about the undocumented --update-failed command line option. |
(0018428) Blzut3 (administrator) 2017-10-04 03:28 |
I don't have enough knowledge on documentation licensing to have an opinion. If LGPL is an option for documentation then that's probably what I'd go with for uniformity. As for --update-failed. That would be for internal use only with the auto updater. The most I would document is that it takes one argument. I don't think we have any plans to ensure that the behavior remains consistent between versions. |
(0018429) WubTheCaptain (reporter) 2017-10-04 06:26 edited on: 2017-10-04 06:27 |
I'm currently siding on a free documentation license: GFDL 1.3+. This is negotiable, not set in the stone yet. The nroff man page source for doomseeker(1) is currently ~ 6.26 KB uncompressed, 245 lines (and 8 pages for a 80x24 terminal when viewed in man). Some questions to make sure I got things right:
|
(0018444) Blzut3 (administrator) 2017-10-05 01:19 |
Quote from WubTheCaptain The port number is defined by the plugin, but yes it will be localhost. Quote from WubTheCaptain Seems out of scope to me. Besides Turok that's all of them. Quote from WubTheCaptain 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 Besides anything that Qt might be affected by and standard stuff (HOME, etc) no. Quote from WubTheCaptain Doomseeker is currently written in C++03. Quote from WubTheCaptain 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 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. |
(0018453) WubTheCaptain (reporter) 2017-10-07 05:16 |
There is no cached master server response file for SRB2 that I can find. Is this a bug, or should I omit the FILES section from doomseeker-srb2(7) man page? |
(0018455) WubTheCaptain (reporter) 2017-10-07 08:59 |
Progress report: doomseeker(1), doomseeker-chocolate(7), doomseeker-odamex(7), doomseeker-srb2(7), doomseeker-turok2ex(7) and doomseeker-zandronum(7) pages are mostly complete and release ready. Related issues may require changes to the documentation, so I'm keeping an eye on them. The SRB2 question is still valid. I'll attempt post a patch/diff once that's out of the way. The only missing page now is wadseeker(3), which issue 0003248 is for. |
(0018538) Blzut3 (administrator) 2017-10-12 00:39 |
The lack of a cache would be a bug. SRB2 uses TCP for its master server so it's not able to take advantage of Doomseeker's transparent caching. |
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 | |
2017-10-03 05:13 | WubTheCaptain | Note Added: 0018418 | |
2017-10-03 05:14 | WubTheCaptain | 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 | WubTheCaptain | Description Updated | View Revisions |
2017-10-03 05:15 | WubTheCaptain | Status | new => feedback |
2017-10-03 05:16 | WubTheCaptain | Note Edited: 0018418 | View Revisions |
2017-10-04 00:17 | WubTheCaptain | Note Added: 0018425 | |
2017-10-04 00:17 | WubTheCaptain | Status | feedback => new |
2017-10-04 00:18 | WubTheCaptain | Status | new => feedback |
2017-10-04 03:28 | Blzut3 | Note Added: 0018428 | |
2017-10-04 06:26 | WubTheCaptain | Note Added: 0018429 | |
2017-10-04 06:26 | WubTheCaptain | Status | feedback => new |
2017-10-04 06:26 | WubTheCaptain | Status | new => feedback |
2017-10-04 06:26 | WubTheCaptain | Note Edited: 0018429 | View Revisions |
2017-10-04 06:27 | WubTheCaptain | Note Edited: 0018429 | View Revisions |
2017-10-04 06:47 | WubTheCaptain | File Added: doomseeker-doc-draft1.tar.gz | |
2017-10-04 06:48 | WubTheCaptain | Status | feedback => needs review |
2017-10-05 01:19 | Blzut3 | Note Added: 0018444 | |
2017-10-05 01:22 | WubTheCaptain | Status | needs review => acknowledged |
2017-10-05 01:55 | WubTheCaptain | Status | acknowledged => confirmed |
2017-10-05 02:00 | WubTheCaptain | Assigned To | => WubTheCaptain |
2017-10-05 02:00 | WubTheCaptain | Status | confirmed => assigned |
2017-10-05 02:56 | WubTheCaptain | Target Version | => 1.2 |
2017-10-07 05:16 | WubTheCaptain | Note Added: 0018453 | |
2017-10-07 05:16 | WubTheCaptain | Status | assigned => feedback |
2017-10-07 05:31 | WubTheCaptain | Relationship added | related to 0003290 |
2017-10-07 05:32 | WubTheCaptain | Relationship added | related to 0003250 |
2017-10-07 05:33 | WubTheCaptain | Relationship added | related to 0003248 |
2017-10-07 08:55 | WubTheCaptain | Relationship added | related to 0003233 |
2017-10-07 08:56 | WubTheCaptain | Relationship added | related to 0003282 |
2017-10-07 08:59 | WubTheCaptain | Note Added: 0018455 | |
2017-10-07 08:59 | WubTheCaptain | Status | feedback => assigned |
2017-10-07 09:07 | WubTheCaptain | Status | assigned => feedback |
2017-10-07 09:41 | WubTheCaptain | Relationship added | related to 0003295 |
2017-10-12 00:39 | Blzut3 | Note Added: 0018538 | |
2017-10-12 05:11 | WubTheCaptain | Status | feedback => assigned |
2018-02-19 22:07 | WubTheCaptain | Status | assigned => confirmed |
2018-02-19 22:07 | WubTheCaptain | Relationship replaced | child of 0003290 |
2018-02-19 22:08 | WubTheCaptain | Relationship replaced | parent of 0003290 |
2018-02-19 22:08 | WubTheCaptain | Relationship replaced | parent of 0003250 |
2018-02-19 22:50 | WubTheCaptain | Additional Information Updated | View Revisions |
2018-09-19 17:34 | WubTheCaptain | Relationship added | child of 0003499 |
2018-09-22 15:55 | WubTheCaptain | Target Version | 1.2 => |
2018-10-13 16:50 | WubTheCaptain | Severity | minor => feature |
2022-08-25 10:22 | WubTheCaptain | Assigned To | WubTheCaptain => |
Copyright © 2000 - 2024 MantisBT Team |