tmac/groff_trace.man

   1 .ig
   2 groff_trace.7
   3
   4 File position: <groff-source>/tmac/groff_trace.man
   5
   6 Last update: 01 Oct 2008
   7
   8 This file is part of groff, the GNU roff type-setting system.
   9
  10 Copyright (C) 2002, 2006, 2007, 2008 Free Software Foundation, Inc.
  11 written by Bernd Warken.
  12
  13 Permission is granted to copy, distribute and/or modify this document
  14 under the terms of the GNU Free Documentation License, Version 1.1 or
  15 any later version published by the Free Software Foundation; with the
  16 Invariant Sections being this .ig-section and AUTHOR, with no
  17 Front-Cover Texts, and with no Back-Cover Texts.
  18
  19 A copy of the Free Documentation License is included as a file called
  20 FDL in the main directory of the groff source package.
  21 ..
  22 .
  23 .ds Ellipsis .\|.\|.\&\"
  24 .
  25 .TH GROFF_TRACE @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
  26 .
  27 .SH NAME
  28 groff_trace \- groff macro package trace.tmac
  29 .
  30 .\" --------------------------------------------------------------------
  31 .SH SYNOPSIS
  32 .\" --------------------------------------------------------------------
  33 .
  34 .SY "groff \-m trace"
  35 .RI [ options
  36 .IR \*[Ellipsis] ]
  37 .RI [ files
  38 .IR \*[Ellipsis] ]
  39 .YS
  40 .
  41 .\" --------------------------------------------------------------------
  42 .SH DESCRIPTION
  43 .\" --------------------------------------------------------------------
  44 .
  45 The
  46 .I trace
  47 macro package of
  48 .BR groff (@MAN1EXT@)
  49 can be a valuable tool for debugging documents written in the roff
  50 formatting language.
  51 .
  52 A call stack trace is protocolled on standard error, this is, a
  53 diagnostic message is emitted on entering and exiting of a macro call.
  54 .
  55 This greatly eases to track down an error in some macro.
  56 .
  57 .
  58 .P
  59 This tracing process is activated by specifying the groff or troff
  60 command line option
  61 .BR \-m\ trace .
  62 This works also with the
  63 .BR groffer (@MAN1EXT@)
  64 viewer program.
  65 .
  66 A finer control can be obtained by including the macro file within the
  67 document by the groff macro call
  68 .BR .mso\ trace.tmac .
  69 Only macros that are defined after this line are traced.
  70 .
  71 .
  72 .P
  73 If command line option
  74 .B \-r\ trace-full=1
  75 is given (or if this register is set in the document), number and string
  76 register assignments together with some other requests are traced also.
  77 .
  78 .
  79 .P
  80 If some other macro package should be traced as well it must be specified
  81 after
  82 .B \-m\ trace
  83 on the command line.
  84 .
  85 .
  86 .P
  87 The macro file
  88 .B trace.tmac
  89 is unusual because it does not contain any macros to be called by a
  90 user.
  91 .
  92 Instead, the existing macro definition and appending facilities are
  93 modified such that they display diagnostic messages.
  94 .
  95 .
  96 .\" --------------------------------------------------------------------
  97 .SH EXAMPLES
  98 .\" --------------------------------------------------------------------
  99 .
 100 In the following examples, a roff fragment is fed into groff via
 101 standard input.
 102 .
 103 As we are only interested in the diagnostic messages (standard error)
 104 on the terminal, the normal formatted output (standard output) is
 105 redirected to the nirvana device
 106 .IR /dev/null .
 107 The resulting diagnostic messages are displayed directly below the
 108 corresponding example.
 109 .
 110 .
 111 .\" --------------------------------------------------------------------
 112 .SS "Command line option"
 113 Example:
 114 .
 115 .RS
 116 .P
 117 .EX
 118 \fIsh#\fP echo '.
 119 > .de test_macro
 120 > ..
 121 > .test_macro
 122 > .test_macro some dummy arguments
 123 > ' | groff -m trace >/dev/null
 124
 125 *** .de test_macro
 126 *** de trace enter: .test_macro
 127 *** trace exit: .test_macro
 128 *** de trace enter: .test_macro "some" "dummy" "arguments"
 129 *** trace exit: .test_macro "some" "dummy" "arguments"
 130 .EE
 131 .RE
 132 .
 133 .P
 134 The entry and the exit of each macro call is displayed on the terminal
 135 (standard output) \[em] together with the arguments (if any).
 136 .
 137 .
 138 .\" --------------------------------------------------------------------
 139 .SS "Nested macro calls"
 140 Example:
 141 .
 142 .RS
 143 .P
 144 .EX
 145 \fIsh#\fP echo '.
 146 > .de child
 147 > ..
 148 > .de parent
 149 > .child
 150 > ..
 151 > .parent
 152 > ' | groff -m trace >/dev/null
 153
 154 *** .de child
 155 *** .de parent
 156 *** de trace enter: .parent
 157  *** de trace enter: .child
 158  *** trace exit: .child
 159 *** trace exit: .parent
 160 .EE
 161 .RE
 162 .
 163 .P
 164 This shows that macro calls can be nested.
 165 .
 166 This powerful feature can help to tack down quite complex call stacks.
 167 .
 168 .
 169 .\" --------------------------------------------------------------------
 170 .SS "Activating with .mso"
 171 Example:
 172 .
 173 .RS
 174 .P
 175 .EX
 176 \fIsh#\fP echo '.
 177 > .de before
 178 > ..
 179 > .mso trace.tmac
 180 > .de after
 181 > ..
 182 > .before
 183 > .after
 184 > .before
 185 >  ' | groff >/dev/null
 186
 187 *** de trace enter: .after
 188 *** trace exit: .after
 189 .EE
 190 .RE
 191 .
 192 .P
 193 Here, the tracing is activated within the document, not by a command
 194 line option.
 195 .
 196 As tracing was not active when macro
 197 .I before
 198 was defined, no call of this macro is protocolled; on the other hand,
 199 the macro
 200 .I after
 201 is fully protocolled.
 202 .
 203 .
 204 .\" --------------------------------------------------------------------
 205 .SH PROBLEMS
 206 .\" --------------------------------------------------------------------
 207 .
 208 Because
 209 .B trace.tmac
 210 wraps the
 211 .B .de
 212 request (and its cousins), macro arguments are expanded one level more.
 213 .
 214 This causes problems if an argument contains four backslashes or more
 215 to prevent too early expansion of the backslash.  For example, this
 216 macro call
 217 .
 218 .IP
 219 .EX
 220 \&.foo \e\e\e\en[bar]
 221 .EE
 222 .
 223 .P
 224 normally passes `\e\en[bar]' to macro `.foo', but with the redefined
 225 .B .de
 226 request it passes `\en[bar]' instead.
 227 .
 228 .P
 229 The solution to this problem is to use groff's
 230 .B \eE
 231 escape which is an escape character not interpreted in copy mode, for
 232 example
 233 .
 234 .IP
 235 .EX
 236 \&.foo \eEn[bar]
 237 .EE
 238 .
 239 .
 240 .\" --------------------------------------------------------------------
 241 .SH FILES
 242 .\" --------------------------------------------------------------------
 243 .
 244 The
 245 .I trace
 246 macros are kept in the file
 247 .B trace.tmac
 248 located in the
 249 .IR "tmac directory" ;
 250 see
 251 .BR groff_tmac (@MAN5EXT@)
 252 for details.
 253 .
 254 .
 255 .\" --------------------------------------------------------------------
 256 .SH ENVIRONMENT
 257 .\" --------------------------------------------------------------------
 258 .
 259 .TP
 260 .B $GROFF_TMAC_PATH
 261 A colon-separated list of additional tmac directories in which to
 262 search for macro files; see
 263 .BR groff_tmac (@MAN5EXT@)
 264 for details.
 265 .
 266 .
 267 .\" --------------------------------------------------------------------
 268 .SH AUTHOR
 269 .\" --------------------------------------------------------------------
 270 .
 271 Copyright (C) 2002, 2006, 2007, 2008 Free Software Foundation, Inc.
 272 .
 273 .P
 274 This document is distributed under the terms of the FDL (GNU Free
 275 Documentation License) version 1.1 or later.
 276 .
 277 You should have received a copy of the FDL on your system, it is also
 278 available on-line at the
 279 .UR http://\:www.gnu.org/\:copyleft/\:fdl.html
 280 GNU copyleft site
 281 .UE .
 282 .
 283 .P
 284 This document is part of
 285 .IR groff ,
 286 the GNU roff distribution.
 287 .
 288 It was written by Bernd Warken.
 289 .
 290 .
 291 .\" --------------------------------------------------------------------
 292 .SH "SEE ALSO"
 293 .\" --------------------------------------------------------------------
 294 .
 295 .TP
 296 .BR groff (@MAN1EXT@)
 297 An overview of the groff system.
 298 .
 299 .TP
 300 .BR troff (@MAN1EXT@)
 301 For details on option
 302 .BR \-m .
 303 .
 304 .TP
 305 .BR groffer (@MAN1EXT@)
 306 A viewer program for all kinds of roff documents.
 307 .
 308 .TP
 309 .BR groff_tmac (@MAN5EXT@)
 310 A general description of groff macro packages.
 311 .
 312 .TP
 313 .BR groff (@MAN7EXT@)
 314 A short reference for the groff formatting language.
 315 .
 316 .P
 317 A complete reference for all parts of the groff system is found in the
 318 groff
 319 .BR info (1)
 320 file.
 321 .
 322 .\" Local Variables:
 323 .\" mode: nroff
 324 .\" End: