{
    "mode": "man",
    "parameter": "x86_64-linux-gnu-gp-display-text",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/x86_64-linux-gnu-gp-display-text/1/json",
    "generated": "2026-10-22T06:31:49Z",
    "synopsis": "gprofng display text [option(s)] [commands] [-script script-file] experiment(s)",
    "sections": {
        "NAME": {
            "content": "gp-display-text - Display the performance data in plain text format\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "gprofng display text [option(s)] [commands] [-script script-file] experiment(s)\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Print a plain text version of the various displays supported by gprofng.\n\nThe input consists of one or more experiment directories.  Through commands, the user\ncontrols the output.\n\nThere is a rich set of commands to control the display of the data.  The NOTES section lists\nthe most common ones.  The gprofng user guide lists all the commands supported.\n\nCommands specified on the command line need to be prepended with the dash ('-') symbol.\n\nIn this example, a function overview will be shown, followed by the source code listing of\nfunction my-func, annotated with the performance metrics that have been recorded during the\ndata collection and stored in experiment directory my-exp.er:\n\n$ gprofng display text -functions -source my-func my-exp.er\n\nInstead of, or in addition to, specifying these commands on the command line, commands may\nalso be included in a file called the script-file.\n\nNote that the commands are processed and interpreted from left to right, so the order\nmatters.\n\nIf this tool is invoked without options, commands, or a script file, it starts in interpreter\nmode.  The user can then issue the commands interactively.  The session is terminated with\nthe exit command in the interpreter.\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "",
            "subsections": [
                {
                    "name": "--version",
                    "content": "Print the version number and exit.\n",
                    "long": "--version"
                },
                {
                    "name": "--help",
                    "content": "Print usage information and exit.\n",
                    "long": "--help"
                },
                {
                    "name": "-script _",
                    "content": "Execute  the  commands  stored  in  the  script  file.  This feature may be combined with\ncommands specified at the command line.\n"
                }
            ]
        },
        "NOTES": {
            "content": "Many commands are supported.  Below, the more common ones are listed in  mostly  alphabetical\norder, because sometimes it is more logical to swap the order of two entries.\n\nThere are many more commands.  These are documented in the user guide.\n\n\"callers-callees\"\nIn  a  callers-callees panel, it is shown which function(s) call the target function (the\ncallers) and what functions it  is  calling  (the  callees).   This  command  prints  the\ncallers-callees  panel  for each of the functions, in the order specified by the function\nsort metric.\n\n\"calltree\"\nDisplay the dynamic call graph from the experiment, showing the hierarchical  metrics  at\neach level.\n\n\"compare {on | off | delta | ratio}\"\nBy  default,  the  results for multiple experiments are aggregated.  This command changes\nthis to enable the comparison of experiments for certain views (e.g. the function  view).\nThe first experiment specified is defined to be the reference.  The following options are\nsupported:\n\n\"on\"\nFor  each  experiment specified on the command line, print the values for the metrics\nthat have been activated for the experiment.\n\n\"off\"\nDisable the comparison of experiments.  This is the default.\n\n\"delta\"\nPrint the values for the reference experiment.  The results for the other experiments\nare shown as a delta relative to the reference (current-reference).\n\n\"ratio\"\nPrint the values for the reference experiment.  The results for the other experiments\nare shown as a ratio relative to the reference (current/reference).\n\n\"disasm function-name\"\nList the source code and instructions for the function specified.  The  instructions  are\nannotated with the metrics used.\n\n\"fsingle function-name [n]\"\nWrite a summary panel for the specified function.  The optional parameter n is needed for\nthose cases where several functions have the same name.\n\n\"fsummary\"\nWrite a summary panel for each function in the function list.\n\n\"functions\"\nDisplay  a  list of all functions executed.  For each function the used metrics (e.g. the\nCPU time) are shown.\n\n\"header\"\nShows several operational characteristics of the experiment(s) specified on  the  command\nline.\n\n\"limit n\"\nLimit the output to n lines.\n\n\"lines\"\nWrite a list of source lines and their metrics, ordered by the current sort metric.\n\n\"metriclist\"\nDisplay the currently selected metrics in the function view and a list of all the metrics\navailable for the target experiment(s).\n\n\"metrics metric-spec\"\nDefine the metrics to be displayed in the function and callers-callees overviews.\n\nThe  metric-spec  can  either  be  the  keyword  default  to  restore the default metrics\nselection, or a colon separated list with metrics.\n\nA special metric is \"hwc\".  It automatically expands to the active set of hardware  event\ncounters used in the experiment(s).\n\nIf both instructions and clock cycles have been measured, the \"CPI\" and \"IPC\" metrics can\nbe  used  to  see  the Clockcycles Per Instruction and Instructions Per Clockcyle values,\nrespectively.\n\nThe gprofng user guide has more details how to define metrics.\n\n\"name {short | long | mangled}[:{soname | nosoname}]\"\nSpecify whether to use the short, long, or mangled form of function  names.   Optionally,\nthe  load object that the function is part of can be included in the output by adding the\nsoname keyword.  It can also be ommitted (nosoname), which is the default.\n\nWhether there is an actual difference  between  these  types  of  names  depends  on  the\nlanguage.\n\nNote that there should be no (white)space to the left and right of the colon (:).\n\nThis option should not be confused with the keyword name in a metric definition, which is\nused to specify that the names of functions should be shown in the function overview.\n\n\"overview\"\nShows  a  summary of the recorded performance data for the experiment(s) specified on the\ncommand line.\n\n\"pcs\"\nWrite a list of program counters (PCs) and their metrics, ordered  by  the  current  sort\nmetric.\n\n\"sort metric-spec\"\nSort the function list on the metric-spec given.\n\n@IndexSubentry{Sort, Reverse order} The data can be sorted in reverse order by prepending\nthe metric definition with a minus (-) sign.\n\nFor example sort -e.totalcpu.\n\n@IndexSubentry{Sort,  Reset  to default} A default metric for the sort operation has been\ndefined and since this is a  persistent  command,  this  default  can  be  restored  with\n\"default\" as the key (sort default).\n\n\"source function-name\"\nList the source code for the function specified, annotated with the metrics used.\n\n\"viewmode {user | expert | machine}\"\nThis  command is only relevant for Java programs.  For all other languages supported, the\nviewmode setting has no effect.\n\nThe following options are supported:\n\n\"user\"\nShow the Java call stacks for Java threads, but do  not  show  housekeeping  threads.\nThe  function  view  includes  a  function  called <JVM-System>.  This represents the\naggregated time from non-Java threads.  In case the JVM software does  not  report  a\nJava call stack, time is reported against the function <no Java callstack recorded>.\n\n\"expert\"\nShow  the  Java call stacks for Java threads when the user Java code is executed, and\nmachine call stacks when JVM code is executed, or when  the  JVM  software  does  not\nreport a Java call stack.  Show the machine call stacks for housekeeping threads.\n\n\"machine\"\nShow  the  actual  native  call stacks for all threads.  This is the view mode for C,\nC++, and Fortran.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "gprofng(1),   gp-archive(1),   gp-collect-app(1),   gp-display-gui(1),    gp-display-html(1),\ngp-display-src(1)\n\nThe  user  guide  for  gprofng  is  maintained  as a Texinfo manual.  If the info and gprofng\nprograms are correctly installed, the  command  info  gprofng  should  give  access  to  this\ndocument.\n",
            "subsections": []
        },
        "COPYRIGHT": {
            "content": "Copyright (c) 2022-2024 Free Software Foundation, Inc.\n\nPermission  is granted to copy, distribute and/or modify this document under the terms of the\nGNU Free Documentation License, Version 1.3 or  any  later  version  published  by  the  Free\nSoftware Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-\nCover  Texts.   A  copy  of  the  license  is  included  in  the  section  entitled \"GNU Free\nDocumentation License\".\n\nbinutils-2.42                                2026-02-09                         GP-DISPLAY-TEXT.1(1)",
            "subsections": []
        }
    },
    "summary": "gp-display-text - Display the performance data in plain text format",
    "flags": [
        {
            "flag": "",
            "long": "--version",
            "arg": null,
            "description": "Print the version number and exit."
        },
        {
            "flag": "",
            "long": "--help",
            "arg": null,
            "description": "Print usage information and exit."
        },
        {
            "flag": "",
            "long": null,
            "arg": null,
            "description": "Execute the commands stored in the script file. This feature may be combined with commands specified at the command line."
        }
    ],
    "examples": [],
    "see_also": [
        {
            "name": "gprofng",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/gprofng/1/json"
        },
        {
            "name": "gp-archive",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/gp-archive/1/json"
        },
        {
            "name": "gp-collect-app",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/gp-collect-app/1/json"
        },
        {
            "name": "gp-display-gui",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/gp-display-gui/1/json"
        },
        {
            "name": "gp-display-html",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/gp-display-html/1/json"
        },
        {
            "name": "gp-display-src",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/gp-display-src/1/json"
        }
    ]
}