From 577ddad0bd9e98a14a0bdbdb835f1ef03dc5a4f0 Mon Sep 17 00:00:00 2001
From: Jan Travnicek <Jan.Travnicek@fit.cvut.cz>
Date: Mon, 21 Aug 2017 16:31:50 +0200
Subject: [PATCH] update help for cli
---
alib2cli/src/command/HelpCommand.h | 19 +++++++++++--------
1 file changed, 11 insertions(+), 8 deletions(-)
diff --git a/alib2cli/src/command/HelpCommand.h b/alib2cli/src/command/HelpCommand.h
index 564f7a7279..aa0a39a746 100644
--- a/alib2cli/src/command/HelpCommand.h
+++ b/alib2cli/src/command/HelpCommand.h
@@ -20,28 +20,31 @@ public:
if ( command == "execute" ) {
std::cout << "Execute command executes statements and either prints the result or writes the result to a file" << std::endl;
+ std::cout << "The qualification of the type of the result is remembered and when connecting statements together the compatibility with respective param is checked." << std::endl;
+ std::cout << "It is possible to use ^ symbol to move the result value of a statement to a parameter of another statement." << std::endl;
+ std::cout << "" << std::endl;
std::cout << "statement_list:" << std::endl;
std::cout << "statement ( | statement )* - at least one statement followed by a pipe separated sequence of other statements" << std::endl;
std::cout << "" << std::endl;
std::cout << "param:" << std::endl;
- std::cout << "- - a value from the previous result (PreviousResultParam)" << std::endl;
- std::cout << "<( statement_list ) - a statement list serving as a param (StatementParam)" << std::endl;
- std::cout << "( type ) param - a casted parameter, type is an immediate value (CastParam)" << std::endl;
- std::cout << "( #type ) param - a casted parameter, type identified by an environment variable (CastParam)" << std::endl;
+ std::cout << "[^] - - a value from the previous result (PreviousResultParam)" << std::endl;
+ std::cout << "[^] <( statement_list ) - a statement list serving as a param (StatementParam)" << std::endl;
+ std::cout << "[^] ( type ) param - a casted parameter, type is an immediate value (CastParam)" << std::endl;
+ std::cout << "[^] ( #type ) param - a casted parameter, type identified by an environment variable (CastParam)" << std::endl;
std::cout << "" << std::endl;
std::cout << "identifier - a string param - the value is a immediate string (ImmediateParam)" << std::endl;
std::cout << "number - a number param - the value is a immediate integer (ImmediateParam)" << std::endl;
std::cout << "#identifier - a string param - identified by an environment variable (ValueParam)" << std::endl;
- std::cout << "$identifier - a value from a variable, identifier is an immediate value (VariableParam)" << std::endl;
- std::cout << "$#identifier - a value from a variable, identified by an environment variable (VariableParam)" << std::endl;
+ std::cout << "[^] $identifier - a value from a variable, identifier is an immediate value (VariableParam)" << std::endl;
+ std::cout << "[^] $#identifier - a value from a variable, identified by an environment variable (VariableParam)" << std::endl;
std::cout << "" << std::endl;
std::cout << "<identifier - a value from a xml file, identifier is an immediate value (FileParam)" << std::endl;
std::cout << "<#identifier - a value from a xml file, identified by an environment variable (FileParam)" << std::endl;
std::cout << "" << std::endl;
std::cout << "statement:" << std::endl;
std::cout << "name ( param )* output_spec - a statement with params, name is an immediate value (SingleStatement)" << std::endl;
- std::cout << "( type ) statement - the result of a statement is casted, type is an immediate value (CastedStatement)" << std::endl;
- std::cout << "( #type ) statement - the result of a statement is casted, type indentified by an environment variable (CastedStatement)" << std::endl;
+ std::cout << "( type ) [^] statement - the result of a statement is casted, type is an immediate value (CastedStatement)" << std::endl;
+ std::cout << "( #type ) [^] statement - the result of a statement is casted, type indentified by an environment variable (CastedStatement)" << std::endl;
std::cout << "" << std::endl;
std::cout << "#identifier - an immediate value from an environment (ValueStatement)" << std::endl;
std::cout << "$identifier - a value from a variable, identifier is an immediate value (VariableStatement)" << std::endl;
--
GitLab