binutils-gdb/gprofng/doc/gp-macros.texi
Vladimir Mezentsev 46c5675798 gprofng: updated man pages and user guide
This is a major update of all the man pages.  Bugs 30679 and 30895 are
addressed.  In addition to fixes for typos, the texts have been expanded
and clarified, and line lengths no longer extend beyond column 79.  In
case of gp-display-html, the new option syntax is documented. The user
guide has a new section on the gprofng GUI.

gprofng/ChangeLog
2023-11-28  Ruud van der Pas  <ruud.vanderpas@oracle.com>

	PR 30679
	PR 30895
	* doc/gp-archive.texi: Expand the description of the options.
	* doc/gp-collect-app.texi: Fix various typos and textual improvements.
	* doc/gp-display-html.texi: Cover the new GNU long option syntax.
	* doc/gp-display-src.texi: Fix various typos and textual improvements.
	* doc/gp-display-text.texi: Fix typos fixed and textual improvements.
	* doc/gp-macros.texi: Fix a bug in the vspace macro and add new macro.
	* doc/gprofng.texi: Cover the GPROFNG_SYSCONFDIR environment variable.
	* doc/gprofng_ug.texi: Fix various typos and textual improvements.
	* doc/version.texi: Adapt the date and version number.
2023-11-29 10:18:34 -08:00

79 lines
1.4 KiB
Plaintext

@c -- Macro definitions -------------------------------------------------------
@c
@c Since only letters can be used, we use capitalization to distinguish
@c different words.
@c ----------------------------------------------------------------------------
@macro CollectApp{}
@command{gprofng collect app}
@end macro
@macro DisplayHTML{}
@command{gprofng display html}
@end macro
@macro DisplayText{}
@command{gprofng display text}
@end macro
@macro DisplaySRC{}
@command{gprofng display src}
@end macro
@macro Archive{}
@command{gprofng archive}
@end macro
@macro GUI{}
@command{gprofng display gui}
@end macro
@macro Driver{}
@command{gprofng}
@end macro
@macro ProductName{}
gprofng
@end macro
@macro ToolName{}
@command{gprofng}
@end macro
@macro IndexSubentry{label, string}
@c -- @cindex \label\ @subentry \string\
@cindex \label\, \string\
@end macro
@macro vspace {lines}
@iftex
@sp \lines\
@end iftex
@end macro
@c -- For some reason ending this macro with @noindent does not work out well.
@macro OptionHeader {lines, option, description}
@sp \lines\
@noindent
@code{\option\} @ @emph{\description\}
@c -- @sp 1
@end macro
@macro gcctabopt{body}
@code{\body\}
@end macro
@macro ManPageStart{headername}
@ifclear man
@sp 1
@noindent @b{\headername\}
@indentedblock
@end ifclear
@end macro
@macro ManPageEnd{}
@ifclear man
@end indentedblock
@end ifclear
@end macro