Outdated man pages #893

This report audits the English man-page sources (the .in files with no language suffix) of the
aMule project. Each page was checked against the actual command-line parsing in the source code:
every documented option must match the real flag, long name, argument type and behaviour, and the
descriptive prose must be factually accurate.

There is one section per man page. Only problems are listed (correct entries are omitted, except
for short "verified correct" notes where useful). Severity is marked inline as WRONG, Missing
or Minor.

docs/man/amule.1.in

• Missing — --configure-autostart <on|off> is defined as a common (non-daemon-only) option at
  src/amuleAppCommon.cpp:281-282, so it applies to the amule binary, but it is not documented
  anywhere on the page.
• Minor (capitalization) — the -t/--category description says "eD2k links" (line 50) while the
  source help text uses "ED2K links" (src/amuleAppCommon.cpp:320). Cosmetic / project-style.

docs/man/amuled.1.in

• Missing — --configure-autostart <on|off> (common option at src/amuleAppCommon.cpp:281-282,
  available to amuled) is not documented.
• WRONG (wording) — the -h/--help description says "Prints a short usage description." while
  the source text is "Displays this information." (src/amuleAppCommon.cpp:275).
• Minor (formatting) — in the DESCRIPTION block, the -t entry does not show its <num>
  argument the way the other value-taking options do (-c <path>, -p <path>, -w <path>).
• Minor (capitalization) — "eD2k links" vs source "ED2K links" (src/amuleAppCommon.cpp:320).

docs/man/amulegui.1.in

• Missing — -d/--disable-fatal and -i/--enable-stdin, defined for non-Windows builds at
  src/amuleAppCommon.cpp:312-314 and :316, apply to amulegui but are absent from this page
  (they are documented in amule.1.in / amuled.1.in).
• Missing — --configure-autostart (common option, src/amuleAppCommon.cpp:281-282) is not
  documented.
• Minor (capitalization) — "eD2k links" vs source "ED2K links" (src/amuleAppCommon.cpp:320).

docs/man/amulecmd.1.in

• WRONG — in the DESCRIPTION (lines 63-65), -v is attached to --version, but -v is actually
  --verbose (src/ExternalConnector.cpp:503) and --version has no short form
  (src/ExternalConnector.cpp:515). The SYNOPSIS correctly shows --version alone, so the page
  contradicts itself.
• WRONG — in the DESCRIPTION (lines 67-68), -h is attached to --help, but -h is actually
  --host (src/ExternalConnector.cpp:488) and --help has no short form
  (src/ExternalConnector.cpp:485). Same SYNOPSIS-vs-DESCRIPTION contradiction.
• Missing — --force-zlib switch (src/ExternalConnector.cpp:518-520), shared by amulecmd, is
  not documented.
• Minor (optional) — the interactive COMMANDS section is correct against the dispatch in
  src/TextClient.cpp, but Get/Set sub-commands (e.g. IPFilter State/Level, BwLimits) are
  only partially enumerated. This is incompleteness rather than an error.

docs/man/amuleweb.1.in

• Missing — --force-zlib switch (src/ExternalConnector.cpp:518-520), inherited by amuleweb
  via CaMuleExternalConnector::OnInitCmdLine(), is not documented.
• Minor (formatting) — -U/--upnp-port (line 85) uses a space before <port>
  (\-\-upnp\-port\fR \fI<port>\fR) instead of = (\-\-upnp\-port\fR=\fI<port>\fR), inconsistent
  with every other value-taking option on the page (lines 47, 51, 54, 57, 68, 75, 78, 94, 97).

docs/man/ed2k.1.in

• Minor — the = syntax for --category=<num> (line 25) is not supported: the parser reads the
  value as the next argv token (src/ED2KLinkParser.cpp:482-486), i.e. -t <num> /
  --category <num>. It does not parse --category=value (unlike --config-dir=, which it does
  handle at :461).
• Minor (grammar) — "Loads all link found…" / "Lists all link found…" (lines 29, 32) should read
  "all links found".

src/utils/aLinkCreator/docs/alc.1.in

• Minor — "This app doesn't take any arguments." (line 10) is slightly overstated. alc is a
  wxApp that does not override OnInitCmdLine (src/utils/aLinkCreator/src/alc.cpp), so it still
  inherits wxWidgets' standard options. The claim is true for application-specific arguments and
  could be qualified. Low priority.

src/utils/aLinkCreator/docs/alcc.1.in

• Minor (wording) — the -h/--help description says "Prints a short usage description." while
  the source declares it with wxCMD_LINE_OPTION_HELP and text "show this help message"
  (src/utils/aLinkCreator/src/alcc.cpp:99). Functionally a help flag; wording mismatch only.

src/utils/cas/docs/cas.1.in

• WRONG — the FILES section (lines 36-41) lists stat.png and tmp.html, but cas actually
  writes aMule-online-sign.png / aMule-online-sign.jpg (src/utils/cas/graphics.c:79-81) and
  aMule-online-sign.html (src/utils/cas/html.c:113). stat.png / tmp.html are repo template
  files, not the runtime outputs.
• WRONG (incomplete) — -o/--picture is documented unconditionally, but the picture output is
  compiled only under #ifdef __GD__ (src/utils/cas/cas.c:95-96, 167-201). The page should note
  it requires GD support.
• Minor — the man page says you can "optionally append =<PATH>" to -o/-p. The long forms
  are optional_argument (src/utils/cas/cas.c:79-80), but the short forms in the optstring
  "c:P:H:hpo" (src/utils/cas/cas.c:177) make -P/-H require an argument. The "optional" claim
  only holds for the long --picture= / --html= forms.

src/utils/wxCas/docs/wxcas.1.in

• Missing — there is no FILES section, but wxcas reads amulesig.dat
  (src/utils/wxCas/src/wxcasframe.cpp:73-76, wxcascte.cpp:44) and persists its own configuration
  via wxConfig. Adding a FILES section (as other pages have) would be an improvement. Low priority.

Cross-cutting observations

• --configure-autostart and --force-zlib are real options missing from every page that
  inherits them (amule/amuled/amulegui for the former; amulecmd/amuleweb for the latter). Worth a
  single coordinated fix.
• The "eD2k" (man pages) vs "ED2K" (source help text) capitalization difference is consistent across
  amule/amuled/amulegui. Decide once whether to normalize, rather than per-page.