xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/doc/gdb-add-index.1 (revision e5014a45d857e6639905eec7f40943a207fed007)
Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "GDB-ADD-INDEX 1"
GDB-ADD-INDEX 1 "2020-09-17" "gdb-11.0.50.20200914-git" "GNU Development Tools"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
gdb-add-index - Add index files to speed up GDB
"SYNOPSIS"
Header "SYNOPSIS" gdb-add-index filename
"DESCRIPTION"
Header "DESCRIPTION" When \s-1GDB\s0 finds a symbol file, it scans the symbols in the file in order to construct an internal symbol table. This lets most \s-1GDB\s0 operations work quickly\*(--at the cost of a delay early on. For large programs, this delay can be quite lengthy, so \s-1GDB\s0 provides a way to build an index, which speeds up startup.

To determine whether a file contains such an index, use the command \f(CW\*(C`readelf -S filename\*(C': the index is stored in a section named \f(CW\*(C`.gdb_index\*(C'. The index file can only be produced on systems which use \s-1ELF\s0 binaries and \s-1DWARF\s0 debug information (i.e., sections named \*(C`.debug_*\*(C').

\fBgdb-add-index uses \s-1GDB\s0 and objdump found in the \s-1PATH\s0 environment variable. If you want to use different versions of these programs, you can specify them through the \fB\s-1GDB\s0 and \s-1OBJDUMP\s0 environment variables.

See more in the \s-1GDB\s0 manual in node \*(C`Index Files\*(C' \*(-- shell command \*(C`info -f gdb -n "Index Files"\*(C'.

"OPTIONS"
Header "OPTIONS"
"SEE ALSO"
Header "SEE ALSO" The full documentation for \s-1GDB\s0 is maintained as a Texinfo manual. If the \*(C`info\*(C' and \*(C`gdb\*(C' programs and \s-1GDB\s0's Texinfo documentation are properly installed at your site, the command

.Vb 1 info gdb .Ve

should give you access to the complete manual.

\fIUsing \s-1GDB: A\s0 Guide to the \s-1GNU\s0 Source-Level Debugger, Richard M. Stallman and Roland H. Pesch, July 1991.

"COPYRIGHT"
Header "COPYRIGHT" Copyright (c) 1988-2020 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with the Invariant Sections being \*(L"Free Software\*(R" and \*(L"Free Software Needs Free Documentation\*(R", with the Front-Cover Texts being \*(L"A \s-1GNU\s0 Manual,\*(R" and with the Back-Cover Texts as in (a) below.

(a) The \s-1FSF\s0's Back-Cover Text is: \*(L"You are free to copy and modify this \s-1GNU\s0 Manual. Buying copies from \s-1GNU\s0 Press supports the \s-1FSF\s0 in developing \s-1GNU\s0 and promoting software freedom.\*(R"