bool ReadlineColor::PrintGeneralHelp	(	std::ostream &	out,
		const std::string &	name
	)

Print a general help text which also includes the commands pre-defined by the Shell class.

Returns

always true

Todo:

Get it up-to-date

Definition at line 146 of file ReadlineColor.cc.

References kBold, kReset, and kUnderline.

Referenced by LocalControl< ConsoleStream >::PrintGeneralHelp(), Shell::PrintGeneralHelp(), Console::PrintGeneralHelp(), and RemoteControl< Shell >::PrintGeneralHelp().

{
    out << endl;
    out << " " << kUnderline << "General help:" << endl << endl;
    out << "  The command history is automatically loaded and saves to" << endl;
    out << "  and from " << name << endl;
    out << endl;
    out << kBold << "   h,help       " << kReset << "Print this help message\n";
    out << kBold << "   clear        " << kReset << "Clear history buffer\n";
    out << kBold << "   lh,history   " << kReset << "Dump the history buffer to the screen\n";
    out << kBold << "   v,variable   " << kReset << "Dump readline variables\n";
    out << kBold << "   f,function   " << kReset << "Dump readline functions\n";
    out << kBold << "   m,funmap     " << kReset << "Dump readline funmap\n";
    out << kBold << "   c,command    " << kReset << "Dump available commands\n";
    out << kBold << "   k,keylist    " << kReset << "Dump key bindings\n";
    out << kBold << "   a,attrs      " << kReset << "Dump available stream attributes\n";
    out << kBold << "   .! command   " << kReset << "Execute a shell command\n";
    out << kBold << "   .w n         " << kReset << "Sleep n milliseconds\n";
    out << kBold << "   .x filename  " << kReset << "Execute a script of commands (+optional arguments)\n";
    out << kBold << "   .x file:N    " << kReset << "Execute a script of commands, start at label N\n";
    out << kBold << "   .j N         " << kReset << "Forward jump to label N\n";
    out << kBold << "   .lt f0 f1 N  " << kReset << "If float f0 lower than float f1, jump to label N\n";
    out << kBold << "   .gt f0 f1 N  " << kReset << "If float f0 greater than float f1, jump to label N\n";
    out << kBold << "   .eq i0 i1 N  " << kReset << "If int i0 equal int i1, jump to label N\n";
    out << kBold << "   : N          " << kReset << "Defines a label (N=number)\n";
    out << kBold << "   # comment    " << kReset << "Ignored\n";
    out << kBold << "   .q,quit      " << kReset << "Quit" << endl;
    out << endl;

    return true;
}

Here is the caller graph for this function: