HELP
Keywords: sic

Next: IF Up: SIC Language Internal Help Previous: FOR /WHILE Contents Index

##
HELP

            [SIC\]HELP [FUNCTION|TASK|RUN|GO] [Topic [Subtopic|*]]

        Display  the  help  of  various Gildas tools. There may be two levels of
        help available. In this case, a wildcard will display all  the  subtopic
        helps at once. You can use the switch SIC HELP to customize the way long
        helps are displayed (see HELP SIC HELP).

        HELP
          Without an argument, HELP gives the list of  available  languages  and
          commands.

        HELP LangName\
          With  a  language  name followed by a backslash (e.g. HELP SIC\), HELP
          gives a one line description of all commands  specific  to  this  lan-
          guage.

        HELP Command [Subtopic]
          With  a command name, the help for this command is displayed. Ambigui-
          ties can be fixed by prefixing the  command  by  its  parent  language
          (e.g.  HELP SIC\DEFINE). A subtopic (e.g. an option name) can be given
          as second argument.

          Subtopics which appear in capital letters when listed by HELP  Command
          are  not  case-sensitive, while Subtopics appearing in mixed-cases are
          case-sensitive.

        HELP FUNCTION [Name]
          With the keyword FUNCTION alone, it gives  a  list  of  all  functions
          available.  With  a  function name added, it gives a detailed help for
          this function. There are 3 kind of functions: 1) functions with native
          support in the SIC interpreter, 2) program-defined functions (specific
          to each program), 3) user-defined functions (defined with DEFINE FUNC-
          TION).

        HELP TASK [Group|?]
          With  the  keyword TASK, it gives a one line description of all avail-
          able tasks. A task group name can be given as second to  restrict  the
          list to this group. Type HELP TASK ? for the list of available groups.

        HELP RUN TaskName [VarName]
          With  the  keyword RUN followed by a task name, the help for this task
          is displayed.

        HELP GO ProcName [Subtopic]
          With the keyword GO followed by a procedure name  (lower  case  sensi-
          tive), the help for this procedure is displayed.

        HELP SIC SYNTAX
          Get some basic help on the SIC interpreter syntax.