Updated first part of command documentation.

This commit is contained in:
Florian Pose 2008-07-22 15:24:46 +00:00
parent c4d1795f87
commit 0ba45ed215
14 changed files with 69 additions and 6 deletions

View File

@ -17,8 +17,25 @@ using namespace std;
const char *help_config =
"[OPTIONS]\n"
"\n"
"Output information about the slave configurations supplied by the\n"
"application.\n"
"\n"
"Command-specific options:\n";
"Without the --verbose option, each line of output shows one slave\n"
"configuration. Example:\n"
"\n"
"1001:0 0x0000003b/0x02010000 - -\n"
"| | | |\n"
"| | | \\- Slave is operational.\n"
"| | \\- Slave has been found.\n"
"| \\- Hexadecimal vendor ID and product code, separated by a\n"
"| slash.\n"
"\\- Decimal alias and position, separated by a colon.\n"
"\n"
"With the --verbose option given, the configured Pdos and Sdos are\n"
"additionally printed.\n"
"\n"
"Command-specific options:\n"
" --verbose -v Show detailed configurations.\n";
/*****************************************************************************/

View File

@ -19,7 +19,7 @@ const char *help_data =
"Command-specific options:\n"
" --domain -d <index> Positive numerical domain index. If this option\n"
" is not specified, data of all domains are\n"
" output.\n";
" concatenated.\n";
/****************************************************************************/

View File

@ -13,10 +13,19 @@ using namespace std;
/*****************************************************************************/
const char *help_debug =
"[OPTIONS]\n"
"<LEVEL>\n"
"\n"
"Set the master debug level.\n"
"\n"
"Command-specific options:\n";
"Debug messages are printed to syslog.\n"
"\n"
"Arguments:\n"
" LEVEL must be an unsigned integer, specified\n"
" either in decimal (no prefix), octal (prefix '0')\n"
" or hexadecimal (prefix '0x').\n"
" 0 stands for no debugging output,\n"
" 1 means some debug messages, and\n"
" 2 outputs all frame data (use with caution!).\n";
/****************************************************************************/

View File

@ -15,8 +15,34 @@ using namespace std;
const char *help_domains =
"[OPTIONS]\n"
"\n"
"Show information about the application's configured domains.\n"
"\n"
"Command-specific options:\n";
"Without the --verbose option, one domain is displayed per line.\n"
"Example:\n"
"\n"
"Domain0: LogBaseAddr 0x00000000, Size 6, WorkingCounter 0/1\n"
"\n"
"The domain's base address for the logical datagram (LRD/LWR/LRW)\n"
"is displayed followed by the domain's process data size in byte.\n"
"The last values are the current datagram working counter sum and\n"
"the expected working counter sum. If the values are equal, all\n"
"Pdos are exchanged.\n"
"\n"
"If the --verbose option is given, the participating slave\n"
"configurations/FMMUs and the current process data are additionally\n"
"displayed:\n"
"\n"
"Domain1: LogBaseAddr 0x00000006, Size 6, WorkingCounter 0/1\n"
" SlaveConfig 1001:0, SM3 ( Input), LogAddr 0x00000006, Size 6\n"
" 00 00 00 00 00 00\n"
"\n"
"The process data are displayed as raw hexadecimal bytes.\n"
"\n"
"Command-specific options:\n"
" --domain -d <index> Positive numerical domain index. If this\n"
" option is not specified, all domains are\n"
" displayed.\n"
" --verbose -v Show FMMUs and process data.\n";
/****************************************************************************/

View File

@ -15,8 +15,10 @@ using namespace std;
const char *help_master =
"[OPTIONS]\n"
"\n"
"Show master and Ethernet device information.\n"
"\n"
"Command-specific options:\n";
"Command-specific options:\n"
" --master -m <master> Index of the master to use. Default: 0\n";
/****************************************************************************/

View File

@ -12,6 +12,7 @@ using namespace std;
/****************************************************************************/
// FIXME
const char *help_pdos =
"[OPTIONS]\n"
"\n"

View File

@ -13,6 +13,7 @@ using namespace std;
/****************************************************************************/
// FIXME
const char *help_sdo_download =
"[OPTIONS]\n"
"\n"

View File

@ -13,6 +13,7 @@ using namespace std;
/****************************************************************************/
// FIXME
const char *help_sdo_upload =
"[OPTIONS]\n"
"\n"

View File

@ -13,6 +13,7 @@ using namespace std;
/****************************************************************************/
// FIXME
const char *help_sdos =
"[OPTIONS]\n"
"\n"

View File

@ -12,6 +12,7 @@ using namespace std;
/****************************************************************************/
// FIXME
const char *help_sii_read =
"[OPTIONS]\n"
"\n"

View File

@ -14,6 +14,7 @@ using namespace std;
/****************************************************************************/
// FIXME
const char *help_sii_write =
"[OPTIONS]\n"
"\n"

View File

@ -13,6 +13,7 @@ using namespace std;
/****************************************************************************/
// FIXME
const char *help_slaves =
"[OPTIONS]\n"
"\n"

View File

@ -11,6 +11,7 @@ using namespace std;
/****************************************************************************/
// FIXME
const char *help_states =
"[OPTIONS]\n"
"\n"

View File

@ -12,6 +12,7 @@ using namespace std;
/****************************************************************************/
// FIXME
const char *help_xml =
"[OPTIONS]\n"
"\n"