Fixup doc

[sysless.git] / libs4c / cmdproc / cmd_proc.h

diff --git a/libs4c/cmdproc/cmd_proc.h b/libs4c/cmdproc/cmd_proc.h
index 18e2a21c55d1faade10578295deaa3fb38472bce..332cd835b9626929763f908ec347a28300645673 100644 (file)
--- a/libs4c/cmdproc/cmd_proc.h
+++ b/libs4c/cmdproc/cmd_proc.h
@@ -112,14 +112,15 @@ int cmd_io_read_bychar(cmd_io_t *cmd_io,void *buf,int count);
 #define CDESM_RD       0x01    /* Value read is possible */
 #define CDESM_WR       0x02    /* Value write is possible */
 #define CDESM_RW       (CDESM_RD|CDESM_WR) /* Both */
+#define CDESM_SPACE_SEP 0x20    /* Whitespace separated params - replaces space with '\0' */
 
 /**
  * Command descriptor.
  *
  * Command name may contain the following wildcards:
- * - '?' stands for one arbitrary character
+ * - '?' stands for one alphanumeric character
  * - '#' stands for one digit
- * - '*' stands for any number of arbitrary characters at the end of the command
+ * - '*' stands for any number of alphanumeric characters at the end of the command
  *
  * The fnc() function is passed the following information as the param array:
  *   - param[0] points to the command (the longest sequence of alphanumeric characters)
@@ -135,6 +136,11 @@ int cmd_io_read_bychar(cmd_io_t *cmd_io,void *buf,int count);
  *       points to the beginning of those parameters (after skipping
  *       whitespace)
  *
+ *   If CDESM_SPACE_SEP is specified in the command descriptor, then
+ *   the command arguments are split at whitespace by '\0'
+ *   characters and stored in the next unused param elements. Param
+ *   array can contain up to 9 elements.
+ *
  *   The param elements are always terminated by NULL element.
  */
 typedef struct cmd_des{