gcc/doc/gcov-dump.texi

   1 @c Copyright (C) 2017-2023 Free Software Foundation, Inc.
   2 @c This is part of the GCC manual.
   3 @c For copying conditions, see the file gcc.texi.
   4
   5 @ignore
   6 @c man begin COPYRIGHT
   7 Copyright @copyright{} 2017-2023 Free Software Foundation, Inc.
   8
   9 Permission is granted to copy, distribute and/or modify this document
  10 under the terms of the GNU Free Documentation License, Version 1.3 or
  11 any later version published by the Free Software Foundation; with the
  12 Invariant Sections being ``GNU General Public License'' and ``Funding
  13 Free Software'', the Front-Cover texts being (a) (see below), and with
  14 the Back-Cover Texts being (b) (see below).  A copy of the license is
  15 included in the gfdl(7) man page.
  16
  17 (a) The FSF's Front-Cover Text is:
  18
  19      A GNU Manual
  20
  21 (b) The FSF's Back-Cover Text is:
  22
  23      You have freedom to copy and modify this GNU Manual, like GNU
  24      software.  Copies published by the Free Software Foundation raise
  25      funds for GNU development.
  26 @c man end
  27 @c Set file name and title for the man page.
  28 @setfilename gcov-dump
  29 @settitle offline gcda and gcno profile dump tool
  30 @end ignore
  31
  32 @node Gcov-dump
  33 @chapter @command{gcov-dump}---an Offline Gcda and Gcno Profile Dump Tool
  34
  35 @menu
  36 * Gcov-dump Intro::             Introduction to gcov-dump.
  37 * Invoking Gcov-dump::          How to use gcov-dump.
  38 @end menu
  39
  40 @node Gcov-dump Intro
  41 @section Introduction to @command{gcov-dump}
  42 @c man begin DESCRIPTION
  43
  44 @command{gcov-dump} is a tool you can use in conjunction with GCC to
  45 dump content of gcda and gcno profile files offline.
  46
  47 @c man end
  48
  49 @node Invoking Gcov-dump
  50 @section Invoking @command{gcov-dump}
  51
  52 @smallexample
  53 Usage: gcov-dump @r{[}@var{OPTION}@r{]} ... @var{gcovfiles}
  54 @end smallexample
  55
  56 @command{gcov-dump} accepts the following options:
  57
  58 @ignore
  59 @c man begin SYNOPSIS
  60 gcov-dump [@option{-v}|@option{--version}]
  61      [@option{-h}|@option{--help}]
  62      [@option{-l}|@option{--long}]
  63      [@option{-p}|@option{--positions}]
  64      [@option{-r}|@option{--raw}]
  65      [@option{-s}|@option{--stable}]
  66      @var{gcovfiles}
  67 @c man end
  68 @end ignore
  69
  70 @c man begin OPTIONS
  71 @table @gcctabopt
  72 @item -h
  73 @itemx --help
  74 Display help about using @command{gcov-dump} (on the standard output), and
  75 exit without doing any further processing.
  76
  77 @item -l
  78 @itemx --long
  79 Dump content of records.
  80
  81 @item -p
  82 @itemx --positions
  83 Dump positions of records.
  84
  85 @item -r
  86 @itemx --raw
  87 Print content records in raw format.
  88
  89 @item -s
  90 @itemx --stable
  91 Print content in stable format usable for comparison.
  92
  93 @item -v
  94 @itemx --version
  95 Display the @command{gcov-dump} version number (on the standard output),
  96 and exit without doing any further processing.
  97 @end table
  98
  99 @c man end