Add ‘npdstracker’ and Remote Admin Usage to Documentation

[morgant]

The npdstracker class does actually accept some command line options and are documented in npdstracker.java, but should also be documented in readme.txt.

Likewise, the previously undocumented remote admin options should be added to the read me as well.

[splorp]

There’s also some undocumented remote admin functions that Victor and Paul shared with me. I have them copied, edited, and sitting in a Writeboard, but we might want to discuss them in email before adding them to the public documentation.

[morgant]

Oh, cool. Yeah, definitely best to discuss.

[splorp]

Actually, it’s probably safe to integrate this information into the read me.

You need to change adminpasswd (required for remote access) in npdstracker.ini anyway.

[morgant]

Nice.

[morgant]

Crap, I somehow branched that from my StylesheetInsertion branch, so I'll submit a pull request for this once we've resolved Issue #2 & merged it.

You can obviously document the admin functions whenever you like.

[splorp]

Sounds good.

Sorry about the kooky closed issue/reopened issue dance above … I was playing with the GitHub Issues app on my iPhone, and the UI is a little tweaky.

[splorp]

Are these the CLI usage instructions you were mentioning? If so, these are the same as the remote admin functions.

if (commandline.equals("HELP"))
{
    out.print("Valid commands are:\r\n");
    out.print("ABOUT     show the server's current settings.\r\n");
    out.print("HALT      stop the server (asks for confirmation)\r\n");
    out.print("LOGS      dump the server's logs\r\n");
    out.print("SHARE     change the server's share settings\r\n");
    out.print("SLIST     view/modify the list of servers to get SHARE records from\r\n");
    out.print("VTEST     trigger a server validation now\r\n");
    out.print("STATS     show the server's statistics\r\n");
    out.print("VERIFY    change the server's NPDS verification settings\r\n");
    out.print("QUIT      quit the admin console and close the connection\r\n");
    out.flush();
}

[morgant]

Nope, it's actually the ones in the printUsage() method:

Usage: java npdstracker [-h] [-c cmdfile] [-o optionsfile]
   -h : print this help
   -c cmdfile : specify commands to run at start (defaults to none)
   -o optionsfile : specify options file (defaults from compile time)

So those admin ones still need to be documented.

[splorp]

Gotcha.

if you want to submit a pull request for the stylesheet update, go ahead. I think I’ll add both of these usage updates while I’m doing the conversion to Markdown. No sense formatting stuff twice … I’m just not sure when I’ll finish it up.

[morgant]

Yeah, keep the reformatting as painless as possible.