0003250: Doomseeker's --help option is undocumented

MantisBT - Doomseeker

View Issue Details

Project

Category

View Status

Date Submitted

Last Update

0003250

Doomseeker

[All Projects] Bug

public

2017-09-01 18:14

2018-10-27 22:55

Reporter

WubTheCaptain

Assigned To

Blzut3

Priority

normal

Severity

text

Reproducibility

have not tried

Status

closed

Resolution

fixed

Platform

x86_64 (really cross-platform)

Debian GNU/Linux

OS Version

buster/sid

Product Version

1.1

Target Version

1.2

Fixed in Version

1.2

Summary

0003250: Doomseeker's --help option is undocumented

Description

The --help command line option of Doomseeker is not documented anywhere, as far as I'm aware.

Steps To Reproduce

The first method is from the command line (terminal).

$ doomseeker --help
Available command line parameters:

--connect'protocol://ip[:port] [^]'
    Attempts to connect to the specified server.
--datadir [directory]
    Sets an explicit search location for
    IP2C data along with plugins.
    Can be specified multiple times.
--rcon [plugin] [ip]
    Launch the rcon client for the specified ip.
--portable
    Starts application in portable mode.
    In portable mode Doomseeker saves all configuration files
    to the directory where its executable resides.
    Normally, configuration is saved to user's home directory.
--version-json [file]
    Prints version info on Doomseeker and all
    plugins in JSON format to specified file,
    then closes the program.

The second method is opening navigation menu Help → Program Args in the graphical user interface.

Additional Information

I found the option with guesswork, without reading the source code.

I propose this option to be documented in some way with the command line usage (0003249) and/or man pages (0003247).