pat_help

interactive help for the CrayPat performance analysis tool

Author:: Hewlett Packard Enterprise Development LP.
Copyright:: Copyright 2019,2021-2024 Hewlett Packard Enterprise Development LP.
Manual section:: 1

SYNOPSIS

pat_help [-help] [-version] [topic [subtopic…]] [.]

DESCRIPTION

The pat_help utility is an interactive viewer used to access information about, and examples of, using the CrayPat performance analysis tool.

When invoked with no arguments, pat_help displays an introductory screen followed by an interactive prompt:

    After reading this page, a new user should start with the topic:

        Overview

    If a topic has subtopics, they are displayed under the heading
    "Additional topics", as below.  To view a subtopic, enter as
    many initial letters as required to distinguish it from other
    items in the list.  To see a table of contents, etc., enter:

        toc

    To produce the full text corresponding to the table of contents,
    specify "all", but preferably in a non-interactive invocation:

        pat_help all . > all_pat_help
        pat_help report all . > all_report_help

  Additional topics:

    APA               build             exporting         perftools-base
    API               counters          loop_stats        plots
    FAQ               demos             memory            preload
    MPMD              environment       modules           regions
    OpenMP            example           mpi_rank_order    report
    Overview          execute           mpi_sync          run
    balance           experiment        pat_view          spreadsheets

pat_help (.=quit ,=back ^=up /=top ~=search)
=>

Use the following commands to navigate the help system:

,

return to the previously viewed topic

^

view the parent topic

/

return to the introductory screen

~

search for instances of text

.

exit

To bypass the introductory screen and go directly to the text for a topic, enter the topic name on the command line.

To search for all instances of specified key letters or text, enter ~ followed by the expression for which you wish to search. The search text is interpreted as a regular expression and is not case-sensitive. For example, a search for the words load balance

⇒ ~ load balance

returns the following topics:

balance

balance lb

balance lb1

balance lb2

report options 0

OPTIONS

pat_help supports the following arguments:

-help

Display pat_help utility usage information.

-version

Display the help system version number.

topic [subtopic]

Go directly to the text for a topic or subtopic.

.

Exit after showing topic or subtopic specified on the command line.

NOTES

Loading the perftools-base module will put this and other components of CrayPat in your path.

EXAMPLES

To begin an interactive session with the list of environment variables, enter the following command:

$ pat_help env

To print all possible values for the pat_report -b option and then exit, enter the following command:

$ pat_help report options b .

To print all available help text to an ASCII file, enter the following command:

$ pat_help all . > tmp

To view a list of predefined performance counter groups for a specific processor:

$ pat_help counters processor groups