AIPS NRAO AIPS HELP file for XHELP in 31DEC18



As of Wed Jan 17 16:52:50 2018


XHELP: Verb-like to list information about any AIPS symbol

INPUTS


                                   This verb has no input
                                   adverbs.

HELP SECTION

XHELP
Type: Pseudoverb
Use:  Displays hypertext help on a given subject in a suitable
      World-Wide Web browser (normally Netscape).  This intended
      for more extensive documentation than that normally
      available in AIPS help files.

      The general form of the command is

            XHELP subject

      where subject is a string that gives the subject for which
      documentation is required.  If there is no hypertext help
      for the given tag but a corresponding help file exists
      then the help file will be loaded into the browser as a
      plain text file.  If neither hypertext help nor
      traditional AIPS help can be found for the subject or if
      no subject is given then an index page will be loaded
      that lists the help subjects available.

      This command may not function on all host systems.

      This command will use the environment variable $AIPS_BROWSER if
      it is set.  If not it will set AIPS_BROWSER=firefox.
Adverbs:
      None.
Examples

      1) To display the index page type

             XHELP

         or

             XHELP INDEX

      2) To display a document about mapping (should there be one)
         type

             XHELP MAPPING

      3) To display the help file for IMAGR (including the explain
         text) type

             XHELP IMAGR

         This assumes that there is no specific hypertext help for
         IMAGR.


AIPS