Improved help.

This commit is contained in:
Florian Pose 2008-07-28 14:43:00 +00:00
parent 72ab96c4fb
commit 5615210aa9
4 changed files with 14 additions and 11 deletions

View File

@ -55,14 +55,15 @@ string CommandConfig::helpString() const
<< " the --alias and --position parameters as follows:" << endl
<< endl
<< " 1) If neither the --alias nor the --position option" << endl
<< " is given, all slave configurations are selected." << endl
<< " is given, all slave configurations are displayed." << endl
<< " 2) If only the --position option is given, an alias" << endl
<< " of zero is assumed (see 4))." << endl
<< " 3) If only the --alias option is given, all slave" << endl
<< " configurations with the given alias address" << endl
<< " match." << endl
<< " are displayed." << endl
<< " 4) If both the --alias and the --position option are" << endl
<< " given, the specified configuration is matched." << endl
<< " given, the selection can match a single" << endl
<< " configuration, that is displayed, if it exists." << endl
<< endl
<< "Command-specific options:" << endl
<< " --alias -a <alias> Configuration alias (see above)." << endl

View File

@ -29,8 +29,9 @@ string CommandData::helpString() const
<< "Data of multiple domains are concatenated." << endl
<< endl
<< "Command-specific options:" << endl
<< " --domain -d <index> Positive numerical domain index, or" << endl
<< " 'all' for all domains (default)." << endl
<< " --domain -d <index> Positive numerical domain index." << endl
<< " If omitted, data of all domains" << endl
<< " are output." << endl
<< endl
<< numericInfo();

View File

@ -36,8 +36,9 @@ string CommandDomains::helpString() const
<< "(LRD/LWR/LRW) is displayed followed by the domain's" << endl
<< "process data size in byte. The last values are the current" << endl
<< "datagram working counter sum and the expected working" << endl
<< "counter sum. If the values are equal, all Pdos were exchanged."
<< endl << endl
<< "counter sum. If the values are equal, all Pdos were" << endl
<< "exchanged during the last cycle." << endl
<< endl
<< "If the --verbose option is given, the participating slave" << endl
<< "configurations/FMMUs and the current process data are" << endl
<< "additionally displayed:" << endl
@ -51,8 +52,9 @@ string CommandDomains::helpString() const
<< "The process data are displayed as hexadecimal bytes." << endl
<< endl
<< "Command-specific options:" << endl
<< " --domain -d <index> Positive numerical domain index," << endl
<< " or 'all' for all domains (default)."
<< " --domain -d <index> Positive numerical domain index." << endl
<< " If ommitted, all domains are" << endl
<< " displayed." << endl
<< endl
<< " --verbose -v Show FMMUs and process data" << endl
<< " in addition." << endl

View File

@ -32,8 +32,7 @@ string CommandPdos::helpString() const
<< endl
<< "1) Sync managers - Contains the sync manager information" << endl
<< " from the SII: Index, physical start address, default" << endl
<< " size (value from the SII), control register and enable" << endl
<< " word. Example:" << endl
<< " size, control register and enable word. Example:" << endl
<< endl
<< " SM3: PhysAddr 0x1100, DefaultSize 0, ControlRegister 0x20, "
<< "Enable 1" << endl