User Commands - explain (1)

NAME

explain(1) - [HELP] reads and navigates a VMS-style help file. (LICENSE:GNU LGPL)

Synopsis
Description
Options
Licensing
Author

SYNOPSIS

explain [HELP_FILENAME]

DESCRIPTION

explain(1) reads and navigates a VMS-style help file. This shows a simple help file:

    >1 Help_File_Format
    >
    >This is a brief suggestion of how a help file is laid out. A line
    >that begins with a number marks the beginning of a topic. The text
    >on that line is the label for the topic.
    >
    >2 What_the_User_Sees
    >
    >On issuing the help command, the user sees the main topic printed out.
    >Following this, a list of the immediate subtopics is presented.
    >The user can proceed to a subtopic by typing its label.
    >
    >3 Sub_Sub_Topics
    >
    >The arrangement of topics is a little like the grouping of parentheses.
    >
    >2 Suggestions
    >
    >You might want to keep each subtopic short, certainly no more than
    >a page in length.

OPTIONS

HELP_FILENAME
Name of help file. That is, a text file marked up using the VMS help file format. In this format, a number in column 1 is a label, and indicates the beginning of a help topic. Label 1 is reserved for the main help topic; subtopics of the main topic have a label of 2, and so on.

LICENSING

This code is distributed under the GNU LGPL license.

AUTHOR

Lifecycle Information:

  Author:   John Burkardt, 2001-03-06, version 1.06
  Modified: John S. Urban, 2019-01-25, version 1.07
            Integrated into the GPF(General Purpose Fortran) format. The
            basic login remains the same, sans some utility routines
            that duplicated GPF routines; added the command --help
            and --version switches; allowed abbreviated case-insensitive
            topics.

Nemo Release 3.1

explain (1)

February 23, 2025

Generated by manServer 1.08 from 100dad47-8574-4081-9e7c-8fb64dab9c2b using man macros.

HELP_FILENAME
	Name of help file. That is, a text file marked up using the VMS help file format. In this format, a number in column 1 is a label, and indicates the beginning of a help topic. Label 1 is reserved for the main help topic; subtopics of the main topic have a label of 2, and so on.