home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _a2224d63758969aa01dab57f0df31f1e < prev    next >
Text File  |  2000-03-23  |  47KB  |  918 lines

  1. <HTML>
  2. <HEAD>
  3. <TITLE>perldebug - Perl debugging</TITLE>
  4. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  5. <LINK REV="made" HREF="mailto:">
  6. </HEAD>
  7.  
  8. <BODY>
  9. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  10. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  11. <STRONG><P CLASS=block> perldebug - Perl debugging</P></STRONG>
  12. </TD></TR>
  13. </TABLE>
  14.  
  15. <A NAME="__index__"></A>
  16. <!-- INDEX BEGIN -->
  17.  
  18. <UL>
  19.  
  20.     <LI><A HREF="#name">NAME</A></LI>
  21.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  22.     <LI><A HREF="#the perl debugger">The Perl Debugger</A></LI>
  23.     <UL>
  24.  
  25.         <LI><A HREF="#debugger commands">Debugger Commands</A></LI>
  26.         <LI><A HREF="#configurable options">Configurable Options</A></LI>
  27.         <LI><A HREF="#debugger input/output">Debugger input/output</A></LI>
  28.         <LI><A HREF="#debugging compiletime statements">Debugging compile-time statements</A></LI>
  29.         <LI><A HREF="#debugger customization">Debugger Customization</A></LI>
  30.         <LI><A HREF="#readline support">Readline Support</A></LI>
  31.         <LI><A HREF="#editor support for debugging">Editor Support for Debugging</A></LI>
  32.         <LI><A HREF="#the perl profiler">The Perl Profiler</A></LI>
  33.     </UL>
  34.  
  35.     <LI><A HREF="#debugging regular expressions">Debugging regular expressions</A></LI>
  36.     <LI><A HREF="#debugging memory usage">Debugging memory usage</A></LI>
  37.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  38.     <LI><A HREF="#bugs">BUGS</A></LI>
  39. </UL>
  40. <!-- INDEX END -->
  41.  
  42. <HR>
  43. <P>
  44. <H1><A NAME="name">NAME</A></H1>
  45. <P>perldebug - Perl debugging</P>
  46. <P>
  47. <HR>
  48. <H1><A NAME="description">DESCRIPTION</A></H1>
  49. <P>First of all, have you tried using the <STRONG>-w</STRONG> switch?</P>
  50. <P>
  51. <HR>
  52. <H1><A NAME="the perl debugger">The Perl Debugger</A></H1>
  53. <P>If you invoke Perl with the <STRONG>-d</STRONG> switch, your script runs under the
  54. Perl source debugger.  This works like an interactive Perl
  55. environment, prompting for debugger commands that let you examine
  56. source code, set breakpoints, get stack backtraces, change the values of
  57. variables, etc.  This is so convenient that you often fire up
  58. the debugger all by itself just to test out Perl constructs
  59. interactively to see what they do.  For example:</P>
  60. <PRE>
  61.     $ perl -d -e 42</PRE>
  62. <P>In Perl, the debugger is not a separate program the way it usually is in the
  63. typical compiled environment.  Instead, the <STRONG>-d</STRONG> flag tells the compiler
  64. to insert source information into the parse trees it's about to hand off
  65. to the interpreter.  That means your code must first compile correctly
  66. for the debugger to work on it.  Then when the interpreter starts up, it
  67. preloads a special Perl library file containing the debugger.</P>
  68. <P>The program will halt <EM>right before</EM> the first run-time executable
  69. statement (but see below regarding compile-time statements) and ask you
  70. to enter a debugger command.  Contrary to popular expectations, whenever
  71. the debugger halts and shows you a line of code, it always displays the
  72. line it's <EM>about</EM> to execute, rather than the one it has just executed.</P>
  73. <P>Any command not recognized by the debugger is directly executed
  74. (<A HREF="../../lib/Pod/perlfunc.html#item_eval"><CODE>eval</CODE></A>'d) as Perl code in the current package.  (The debugger
  75. uses the DB package for keeping its own state information.)</P>
  76. <P>For any text entered at the debugger prompt, leading and trailing whitespace
  77. is first stripped before further processing.  If a debugger command
  78. coincides with some function in your own program, merely precede the
  79. function with something that doesn't look like a debugger command, such
  80. as a leading <CODE>;</CODE> or perhaps a <CODE>+</CODE>, or by wrapping it with parentheses
  81. or braces.</P>
  82. <P>
  83. <H2><A NAME="debugger commands">Debugger Commands</A></H2>
  84. <P>The debugger understands the following commands:</P>
  85. <DL>
  86. <DT><STRONG><A NAME="item_h_%5Bcommand%5D">h [command]</A></STRONG><BR>
  87. <DD>
  88. Prints out a help message.
  89. <P>If you supply another debugger command as an argument to the <CODE>h</CODE> command,
  90. it prints out the description for just that command.  The special
  91. argument of <CODE>h h</CODE> produces a more compact help listing, designed to fit
  92. together on one screen.</P>
  93. <P>If the output of the <CODE>h</CODE> command (or any command, for that matter) scrolls
  94. past your screen, precede the command with a leading pipe symbol so
  95. that it's run through your pager, as in</P>
  96. <PRE>
  97.     DB> |h</PRE>
  98. <P>You may change the pager which is used via <CODE>O pager=...</CODE> command.</P>
  99. <P></P>
  100. <DT><STRONG><A NAME="item_p_expr">p expr</A></STRONG><BR>
  101. <DD>
  102. Same as <CODE>print {$DB::OUT} expr</CODE> in the current package.  In particular,
  103. because this is just Perl's own <A HREF="../../lib/Pod/perlfunc.html#item_print"><CODE>print</CODE></A> function, this means that nested
  104. data structures and objects are not dumped, unlike with the <CODE>x</CODE> command.
  105. <P>The <CODE>DB::OUT</CODE> filehandle is opened to <EM>/dev/tty</EM>, regardless of
  106. where STDOUT may be redirected to.</P>
  107. <P></P>
  108. <DT><STRONG><A NAME="item_x_expr">x expr</A></STRONG><BR>
  109. <DD>
  110. Evaluates its expression in list context and dumps out the result
  111. in a pretty-printed fashion.  Nested data structures are printed out
  112. recursively, unlike the real <A HREF="../../lib/Pod/perlfunc.html#item_print"><CODE>print</CODE></A> function in Perl.
  113. See <A HREF="../../lib/Dumpvalue.html">the Dumpvalue manpage</A> if you'd like to do this yourself.
  114. <P>The output format is governed by multiple options described under
  115. <A HREF="#options">Options</A>.</P>
  116. <P></P>
  117. <DT><STRONG><A NAME="item_V_%5Bpkg_%5Bvars%5D%5D">V [pkg [vars]]</A></STRONG><BR>
  118. <DD>
  119. Display all (or some) variables in package (defaulting to <CODE>main</CODE>) 
  120. using a data pretty-printer (hashes show their keys and values so
  121. you see what's what, control characters are made printable, etc.).
  122. Make sure you don't put the type specifier (like <CODE>$</CODE>) there, just
  123. the symbol names, like this:
  124. <PRE>
  125.     V DB filename line</PRE>
  126. <P>Use <CODE>~pattern</CODE> and <CODE>!pattern</CODE> for positive and negative regexes.</P>
  127. <P>This is similar to calling the <CODE>x</CODE> command on each applicable var.</P>
  128. <P></P>
  129. <DT><STRONG><A NAME="item_X_%5Bvars%5D">X [vars]</A></STRONG><BR>
  130. <DD>
  131. Same as <CODE>V currentpackage [vars]</CODE>.
  132. <P></P>
  133. <DT><STRONG><A NAME="item_T">T</A></STRONG><BR>
  134. <DD>
  135. Produce a stack backtrace.  See below for details on its output.
  136. <P></P>
  137. <DT><STRONG><A NAME="item_s_%5Bexpr%5D">s [expr]</A></STRONG><BR>
  138. <DD>
  139. Single step.  Executes until the beginning of another
  140. statement, descending into subroutine calls.  If an expression is
  141. supplied that includes function calls, it too will be single-stepped.
  142. <P></P>
  143. <DT><STRONG><A NAME="item_n_%5Bexpr%5D">n [expr]</A></STRONG><BR>
  144. <DD>
  145. Next.  Executes over subroutine calls, until the beginning
  146. of the next statement.  If an expression is supplied that includes
  147. function calls, those functions will be executed with stops before
  148. each statement.
  149. <P></P>
  150. <DT><STRONG><A NAME="item_r">r</A></STRONG><BR>
  151. <DD>
  152. Continue until the return from the current subroutine.
  153. Dump the return value if the <A HREF="#item_PrintRet"><CODE>PrintRet</CODE></A> option is set (default).
  154. <P></P>
  155. <DT><STRONG><A NAME="item_%3CCR%3E"><CR></A></STRONG><BR>
  156. <DD>
  157. Repeat last <CODE>n</CODE> or <A HREF="../../lib/Pod/perlfunc.html#item_s"><CODE>s</CODE></A> command.
  158. <P></P>
  159. <DT><STRONG><A NAME="item_c_%5Bline%7Csub%5D">c [line|sub]</A></STRONG><BR>
  160. <DD>
  161. Continue, optionally inserting a one-time-only breakpoint
  162. at the specified line or subroutine.
  163. <P></P>
  164. <DT><STRONG><A NAME="item_l">l</A></STRONG><BR>
  165. <DD>
  166. List next window of lines.
  167. <P></P>
  168. <DT><STRONG><A NAME="item_l_min%2Bincr">l min+incr</A></STRONG><BR>
  169. <DD>
  170. List <CODE>incr+1</CODE> lines starting at <CODE>min</CODE>.
  171. <P></P>
  172. <DT><STRONG><A NAME="item_l_min%2Dmax">l min-max</A></STRONG><BR>
  173. <DD>
  174. List lines <CODE>min</CODE> through <CODE>max</CODE>.  <CODE>l -</CODE> is synonymous to <A HREF="#item_%2D"><CODE>-</CODE></A>.
  175. <P></P>
  176. <DT><STRONG><A NAME="item_l_line">l line</A></STRONG><BR>
  177. <DD>
  178. List a single line.
  179. <P></P>
  180. <DT><STRONG><A NAME="item_l_subname">l subname</A></STRONG><BR>
  181. <DD>
  182. List first window of lines from subroutine.  <EM>subname</EM> may
  183. be a variable that contains a code reference.
  184. <P></P>
  185. <DT><STRONG><A NAME="item_%2D">-</A></STRONG><BR>
  186. <DD>
  187. List previous window of lines.
  188. <P></P>
  189. <DT><STRONG><A NAME="item_w_%5Bline%5D">w [line]</A></STRONG><BR>
  190. <DD>
  191. List window (a few lines) around the current line.
  192. <P></P>
  193. <DT><STRONG><A NAME="item_%2E">.</A></STRONG><BR>
  194. <DD>
  195. Return the internal debugger pointer to the line last
  196. executed, and print out that line.
  197. <P></P>
  198. <DT><STRONG><A NAME="item_f_filename">f filename</A></STRONG><BR>
  199. <DD>
  200. Switch to viewing a different file or <A HREF="../../lib/Pod/perlfunc.html#item_eval"><CODE>eval</CODE></A> statement.  If <EM>filename</EM>
  201. is not a full pathname found in the values of %INC, it is considered 
  202. a regex.
  203. <P><A HREF="../../lib/Pod/perlfunc.html#item_eval"><CODE>eval</CODE></A>ed strings (when accessible) are considered to be filenames:
  204. <CODE>f (eval 7)</CODE> and <CODE>f eval 7\b</CODE> access the body of the 7th <A HREF="../../lib/Pod/perlfunc.html#item_eval"><CODE>eval</CODE></A>ed string
  205. (in the order of execution).  The bodies of the currently executed <A HREF="../../lib/Pod/perlfunc.html#item_eval"><CODE>eval</CODE></A>
  206. and of <A HREF="../../lib/Pod/perlfunc.html#item_eval"><CODE>eval</CODE></A>ed strings that define subroutines are saved and thus
  207. accessible.</P>
  208. <P></P>
  209. <DT><STRONG><A NAME="item_%2Fpattern%2F">/pattern/</A></STRONG><BR>
  210. <DD>
  211. Search forwards for pattern (a Perl regex); final / is optional.
  212. <P></P>
  213. <DT><STRONG><A NAME="item_%3Fpattern%3F">?pattern?</A></STRONG><BR>
  214. <DD>
  215. Search backwards for pattern; final ? is optional.
  216. <P></P>
  217. <DT><STRONG><A NAME="item_L">L</A></STRONG><BR>
  218. <DD>
  219. List all breakpoints and actions.
  220. <P></P>
  221. <DT><STRONG><A NAME="item_S_%5B%5B%21%5Dregex%5D">S [[!]regex]</A></STRONG><BR>
  222. <DD>
  223. List subroutine names [not] matching the regex.
  224. <P></P>
  225. <DT><STRONG><A NAME="item_t">t</A></STRONG><BR>
  226. <DD>
  227. Toggle trace mode (see also the <A HREF="#item_AutoTrace"><CODE>AutoTrace</CODE></A> option).
  228. <P></P>
  229. <DT><STRONG><A NAME="item_t_expr">t expr</A></STRONG><BR>
  230. <DD>
  231. Trace through execution of <CODE>expr</CODE>.
  232. See <A HREF="../../lib/Pod/perldebguts.html#frame listing output examples">Frame Listing Output Examples in the perldebguts manpage</A> for examples.
  233. <P></P>
  234. <DT><STRONG><A NAME="item_b_%5Bline%5D_%5Bcondition%5D">b [line] [condition]</A></STRONG><BR>
  235. <DD>
  236. Set a breakpoint before the given line.  If <EM>line</EM> is omitted, set a
  237. breakpoint on the line about to be executed.  If a condition
  238. is specified, it's evaluated each time the statement is reached: a
  239. breakpoint is taken only if the condition is true.  Breakpoints may
  240. only be set on lines that begin an executable statement.  Conditions
  241. don't use <CODE>if</CODE>:
  242. <PRE>
  243.     b 237 $x > 30
  244.     b 237 ++$count237 < 11
  245.     b 33 /pattern/i</PRE>
  246. <P></P>
  247. <DT><STRONG><A NAME="item_b_subname_%5Bcondition%5D">b subname [condition]</A></STRONG><BR>
  248. <DD>
  249. Set a breakpoint before the first line of the named subroutine.  <EM>subname</EM> may
  250. be a variable containing a code reference (in this case <EM>condition</EM>
  251. is not supported).
  252. <P></P>
  253. <DT><STRONG><A NAME="item_b_postpone_subname_%5Bcondition%5D">b postpone subname [condition]</A></STRONG><BR>
  254. <DD>
  255. Set a breakpoint at first line of subroutine after it is compiled.
  256. <P></P>
  257. <DT><STRONG><A NAME="item_b_load_filename">b load filename</A></STRONG><BR>
  258. <DD>
  259. Set a breakpoint before the first executed line of the <EM>filename</EM>,
  260. which should be a full pathname found amongst the %INC values.
  261. <P></P>
  262. <DT><STRONG><A NAME="item_b_compile_subname">b compile subname</A></STRONG><BR>
  263. <DD>
  264. Sets a breakpoint before the first statement executed after the specified
  265. subroutine is compiled.
  266. <P></P>
  267. <DT><STRONG><A NAME="item_d_%5Bline%5D">d [line]</A></STRONG><BR>
  268. <DD>
  269. Delete a breakpoint from the specified <EM>line</EM>.  If <EM>line</EM> is omitted, deletes
  270. the breakpoint from the line about to be executed.
  271. <P></P>
  272. <DT><STRONG><A NAME="item_D">D</A></STRONG><BR>
  273. <DD>
  274. Delete all installed breakpoints.
  275. <P></P>
  276. <DT><STRONG><A NAME="item_a_%5Bline%5D_command">a [line] command</A></STRONG><BR>
  277. <DD>
  278. Set an action to be done before the line is executed.  If <EM>line</EM> is
  279. omitted, set an action on the line about to be executed.
  280. The sequence of steps taken by the debugger is
  281. <PRE>
  282.   1. check for a breakpoint at this line
  283.   2. print the line if necessary (tracing)
  284.   3. do any actions associated with that line
  285.   4. prompt user if at a breakpoint or in single-step
  286.   5. evaluate line</PRE>
  287. <P>For example, this will print out $foo every time line
  288. 53 is passed:</P>
  289. <PRE>
  290.     a 53 print "DB FOUND $foo\n"</PRE>
  291. <P></P>
  292. <DT><STRONG><A NAME="item_a_%5Bline%5D">a [line]</A></STRONG><BR>
  293. <DD>
  294. Delete an action from the specified line.  If <EM>line</EM> is omitted, delete
  295. the action on the line that is about to be executed.
  296. <P></P>
  297. <DT><STRONG><A NAME="item_A">A</A></STRONG><BR>
  298. <DD>
  299. Delete all installed actions.
  300. <P></P>
  301. <DT><STRONG><A NAME="item_W_expr">W expr</A></STRONG><BR>
  302. <DD>
  303. Add a global watch-expression.  We hope you know what one of these
  304. is, because they're supposed to be obvious.  <STRONG>WARNING</STRONG>: It is far
  305. too easy to destroy your watch expressions by accidentally omitting
  306. the <EM>expr</EM>.
  307. <P></P>
  308. <DT><STRONG><A NAME="item_W">W</A></STRONG><BR>
  309. <DD>
  310. Delete all watch-expressions.
  311. <P></P>
  312. <DT><STRONG><A NAME="item_O_booloption_%2E%2E%2E">O booloption ...</A></STRONG><BR>
  313. <DD>
  314. Set each listed Boolean option to the value <CODE>1</CODE>.
  315. <P></P>
  316. <DT><STRONG><A NAME="item_O_anyoption%3F_%2E%2E%2E">O anyoption? ...</A></STRONG><BR>
  317. <DD>
  318. Print out the value of one or more options.
  319. <P></P>
  320. <DT><STRONG><A NAME="item_O_option%3Dvalue_%2E%2E%2E">O option=value ...</A></STRONG><BR>
  321. <DD>
  322. Set the value of one or more options.  If the value has internal
  323. whitespace, it should be quoted.  For example, you could set <CODE>O
  324. pager="less -MQeicsNfr"</CODE> to call <STRONG>less</STRONG> with those specific options.
  325. You may use either single or double quotes, but if you do, you must
  326. escape any embedded instances of same sort of quote you began with,
  327. as well as any escaping any escapes that immediately precede that
  328. quote but which are not meant to escape the quote itself.  In other
  329. words, you follow single-quoting rules irrespective of the quote;
  330. eg: <CODE>O option='this isn\'t bad'</CODE> or <CODE>O option="She said, \"Isn't
  331. it?\""</CODE>.
  332. <P>For historical reasons, the <CODE>=value</CODE> is optional, but defaults to
  333. 1 only where it is safe to do so--that is, mostly for Boolean
  334. options.  It is always better to assign a specific value using <CODE>=</CODE>.
  335. The <CODE>option</CODE> can be abbreviated, but for clarity probably should
  336. not be.  Several options can be set together.  See <A HREF="#options">Options</A> for
  337. a list of these.</P>
  338. <P></P>
  339. <DT><STRONG><A NAME="item_%3C_%3F">< ?</A></STRONG><BR>
  340. <DD>
  341. List out all pre-prompt Perl command actions.
  342. <P></P>
  343. <DT><STRONG><A NAME="item_%3C_%5B_command_%5D">< [ command ]</A></STRONG><BR>
  344. <DD>
  345. Set an action (Perl command) to happen before every debugger prompt.
  346. A multi-line command may be entered by backslashing the newlines.  
  347. <STRONG>WARNING</STRONG> If <A HREF="#item_command"><CODE>command</CODE></A> is missing, all actions are wiped out!
  348. <P></P>
  349. <DT><STRONG><A NAME="item_%3C%3C_command"><< command</A></STRONG><BR>
  350. <DD>
  351. Add an action (Perl command) to happen before every debugger prompt.
  352. A multi-line command may be entered by backwhacking the newlines.
  353. <P></P>
  354. <DT><STRONG><A NAME="item_%3E_%3F">> ?</A></STRONG><BR>
  355. <DD>
  356. List out post-prompt Perl command actions.
  357. <P></P>
  358. <DT><STRONG><A NAME="item_%3E_command">> command</A></STRONG><BR>
  359. <DD>
  360. Set an action (Perl command) to happen after the prompt when you've
  361. just given a command to return to executing the script.  A multi-line
  362. command may be entered by backslashing the newlines (we bet you
  363. couldn't've guessed this by now).  <STRONG>WARNING</STRONG> If <A HREF="#item_command"><CODE>command</CODE></A> is
  364. missing, all actions are wiped out!
  365. <P></P>
  366. <DT><STRONG><A NAME="item_%3E%3E_command">>> command</A></STRONG><BR>
  367. <DD>
  368. Adds an action (Perl command) to happen after the prompt when you've
  369. just given a command to return to executing the script.  A multi-line
  370. command may be entered by slackbashing the newlines.
  371. <P></P>
  372. <DT><STRONG><A NAME="item_%7B_%3F">{ ?</A></STRONG><BR>
  373. <DD>
  374. List out pre-prompt debugger commands.
  375. <P></P>
  376. <DT><STRONG><A NAME="item_%7B_%5B_command_%5D">{ [ command ]</A></STRONG><BR>
  377. <DD>
  378. Set an action (debugger command) to happen before every debugger prompt.
  379. A multi-line command may be entered in the customary fashion.  
  380. <STRONG>WARNING</STRONG> If <A HREF="#item_command"><CODE>command</CODE></A> is missing, all actions are wiped out!
  381. <P>Because this command is in some senses new, a warning is issued if
  382. you appear to have accidentally entered a block instead.  If that's
  383. what you mean to do, write it as with <CODE>;{ ... }</CODE> or even 
  384. <A HREF="../../lib/Pod/perlfunc.html#item_do"><CODE>do { ... }</CODE></A>.</P>
  385. <P></P>
  386. <DT><STRONG><A NAME="item_%7B%7B_command">{{ command</A></STRONG><BR>
  387. <DD>
  388. Add an action (debugger command) to happen before every debugger prompt.
  389. A multi-line command may be entered, if you can guess how: see above.
  390. <P></P>
  391. <DT><STRONG><A NAME="item_%21_number">! number</A></STRONG><BR>
  392. <DD>
  393. Redo a previous command (defaults to the previous command).
  394. <P></P>
  395. <DT><STRONG><A NAME="item_%21_%2Dnumber">! -number</A></STRONG><BR>
  396. <DD>
  397. Redo number'th previous command.
  398. <P></P>
  399. <DT><STRONG><A NAME="item_%21_pattern">! pattern</A></STRONG><BR>
  400. <DD>
  401. Redo last command that started with pattern.
  402. See <CODE>O recallCommand</CODE>, too.
  403. <P></P>
  404. <DT><STRONG><A NAME="item_%21%21_cmd">!! cmd</A></STRONG><BR>
  405. <DD>
  406. Run cmd in a subprocess (reads from DB::IN, writes to DB::OUT) See
  407. <CODE>O shellBang</CODE>, also.  Note that the user's current shell (well,
  408. their <CODE>$ENV{SHELL}</CODE> variable) will be used, which can interfere
  409. with proper interpretation of exit status or signal and coredump
  410. information.
  411. <P></P>
  412. <DT><STRONG><A NAME="item_H_%2Dnumber">H -number</A></STRONG><BR>
  413. <DD>
  414. Display last n commands.  Only commands longer than one character are
  415. listed.  If <EM>number</EM> is omitted, list them all.
  416. <P></P>
  417. <DT><STRONG><A NAME="item_q_or_%5ED">q or ^D</A></STRONG><BR>
  418. <DD>
  419. Quit.  (``quit'' doesn't work for this, unless you've made an alias)
  420. This is the only supported way to exit the debugger, though typing
  421. <A HREF="../../lib/Pod/perlfunc.html#item_exit"><CODE>exit</CODE></A> twice might work.
  422. <P>Set the <A HREF="#item_inhibit_exit"><CODE>inhibit_exit</CODE></A> option to 0 if you want to be able to step
  423. off the end the script.  You may also need to set $finished to 0 
  424. if you want to step through global destruction.</P>
  425. <P></P>
  426. <DT><STRONG><A NAME="item_R">R</A></STRONG><BR>
  427. <DD>
  428. Restart the debugger by <A HREF="../../lib/Pod/perlfunc.html#item_exec"><CODE>exec()</CODE></A>ing a new session.  We try to maintain
  429. your history across this, but internal settings and command-line options
  430. may be lost.
  431. <P>The following setting are currently preserved: history, breakpoints,
  432. actions, debugger options, and the Perl command-line
  433. options <STRONG>-w</STRONG>, <STRONG>-I</STRONG>, and <STRONG>-e</STRONG>.</P>
  434. <P></P>
  435. <DT><STRONG><A NAME="item_%7Cdbcmd">|dbcmd</A></STRONG><BR>
  436. <DD>
  437. Run the debugger command, piping DB::OUT into your current pager.
  438. <P></P>
  439. <DT><STRONG><A NAME="item_%7C%7Cdbcmd">||dbcmd</A></STRONG><BR>
  440. <DD>
  441. Same as <A HREF="#item_%7Cdbcmd"><CODE>|dbcmd</CODE></A> but DB::OUT is temporarily <A HREF="../../lib/Pod/perlfunc.html#item_select"><CODE>select</CODE></A>ed as well.
  442. <P></P>
  443. <DT><STRONG><A NAME="item_%3D_%5Balias_value%5D">= [alias value]</A></STRONG><BR>
  444. <DD>
  445. Define a command alias, like
  446. <PRE>
  447.     = quit q</PRE>
  448. <P>or list current aliases.</P>
  449. <P></P>
  450. <DT><STRONG><A NAME="item_command">command</A></STRONG><BR>
  451. <DD>
  452. Execute command as a Perl statement.  A trailing semicolon will be
  453. supplied.  If the Perl statement would otherwise be confused for a
  454. Perl debugger, use a leading semicolon, too.
  455. <P></P>
  456. <DT><STRONG><A NAME="item_m_expr">m expr</A></STRONG><BR>
  457. <DD>
  458. List which methods may be called on the result of the evaluated
  459. expression.  The expression may evaluated to a reference to a 
  460. blessed object, or to a package name.
  461. <P></P>
  462. <DT><STRONG><A NAME="item_man_%5Bmanpage%5D">man [manpage]</A></STRONG><BR>
  463. <DD>
  464. Despite its name, this calls your system's default documentation
  465. viewer on the given page, or on the viewer itself if <EM>manpage</EM> is
  466. omitted.  If that viewer is <STRONG>man</STRONG>, the current <CODE>Config</CODE> information
  467. is used to invoke <STRONG>man</STRONG> using the proper MANPATH or <STRONG>-M</STRONG>
  468. <EM>manpath</EM> option.  Failed lookups of the form <CODE>XXX</CODE> that match
  469. known manpages of the form <EM>perlXXX</EM> will be retried.  This lets
  470. you type <CODE>man debug</CODE> or <CODE>man op</CODE> from the debugger.
  471. <P>On systems traditionally bereft of a usable <STRONG>man</STRONG> command, the
  472. debugger invokes <STRONG>perldoc</STRONG>.  Occasionally this determination is
  473. incorrect due to recalcitrant vendors or rather more felicitously,
  474. to enterprising users.  If you fall into either category, just
  475. manually set the $DB::doccmd variable to whatever viewer to view
  476. the Perl documentation on your system.  This may be set in an rc
  477. file, or through direct assignment.  We're still waiting for a
  478. working example of something along the lines of:</P>
  479. <PRE>
  480.     $DB::doccmd = 'netscape -remote <A HREF="http://something.here/">http://something.here/</A>';</PRE>
  481. <P></P></DL>
  482. <P>
  483. <H2><A NAME="configurable options">Configurable Options</A></H2>
  484. <P>The debugger has numerous options settable using the <CODE>O</CODE> command,
  485. either interactively or from the environment or an rc file.</P>
  486. <DL>
  487. <DT><STRONG><A NAME="item_recallCommand%2C_ShellBang"><CODE>recallCommand</CODE>, <CODE>ShellBang</CODE></A></STRONG><BR>
  488. <DD>
  489. The characters used to recall command or spawn shell.  By
  490. default, both are set to <CODE>!</CODE>, which is unfortunate.
  491. <P></P>
  492. <DT><STRONG><A NAME="item_pager"><CODE>pager</CODE></A></STRONG><BR>
  493. <DD>
  494. Program to use for output of pager-piped commands (those beginning
  495. with a <CODE>|</CODE> character.)  By default, <CODE>$ENV{PAGER}</CODE> will be used.
  496. Because the debugger uses your current terminal characteristics
  497. for bold and underlining, if the chosen pager does not pass escape
  498. sequences through unchanged, the output of some debugger commands
  499. will not be readable when sent through the pager.
  500. <P></P>
  501. <DT><STRONG><A NAME="item_tkRunning"><CODE>tkRunning</CODE></A></STRONG><BR>
  502. <DD>
  503. Run Tk while prompting (with ReadLine).
  504. <P></P>
  505. <DT><STRONG><A NAME="item_signalLevel%2C_warnLevel%2C_dieLevel"><CODE>signalLevel</CODE>, <CODE>warnLevel</CODE>, <CODE>dieLevel</CODE></A></STRONG><BR>
  506. <DD>
  507. Level of verbosity.  By default, the debugger leaves your exceptions
  508. and warnings alone, because altering them can break correctly running
  509. programs.  It will attempt to print a message when uncaught INT, BUS, or
  510. SEGV signals arrive.  (But see the mention of signals in <EM>BUGS</EM> below.)
  511. <P>To disable this default safe mode, set these values to something higher
  512. than 0.  At a level of 1, you get backtraces upon receiving any kind
  513. of warning (this is often annoying) or exception (this is
  514. often valuable).  Unfortunately, the debugger cannot discern fatal
  515. exceptions from non-fatal ones.  If <CODE>dieLevel</CODE> is even 1, then your
  516. non-fatal exceptions are also traced and unceremoniously altered if they
  517. came from <CODE>eval'd</CODE> strings or from any kind of <A HREF="../../lib/Pod/perlfunc.html#item_eval"><CODE>eval</CODE></A> within modules
  518. you're attempting to load.  If <CODE>dieLevel</CODE> is 2, the debugger doesn't
  519. care where they came from:  It usurps your exception handler and prints
  520. out a trace, then modifies all exceptions with its own embellishments.
  521. This may perhaps be useful for some tracing purposes, but tends to hopelessly
  522. destroy any program that takes its exception handling seriously.</P>
  523. <P></P>
  524. <DT><STRONG><A NAME="item_AutoTrace"><CODE>AutoTrace</CODE></A></STRONG><BR>
  525. <DD>
  526. Trace mode (similar to <A HREF="#item_t"><CODE>t</CODE></A> command, but can be put into
  527. <CODE>PERLDB_OPTS</CODE>).
  528. <P></P>
  529. <DT><STRONG><A NAME="item_LineInfo"><CODE>LineInfo</CODE></A></STRONG><BR>
  530. <DD>
  531. File or pipe to print line number info to.  If it is a pipe (say,
  532. <CODE>|visual_perl_db</CODE>), then a short message is used.  This is the
  533. mechanism used to interact with a slave editor or visual debugger,
  534. such as the special <CODE>vi</CODE> or <CODE>emacs</CODE> hooks, or the <CODE>ddd</CODE> graphical
  535. debugger.
  536. <P></P>
  537. <DT><STRONG><A NAME="item_inhibit_exit"><CODE>inhibit_exit</CODE></A></STRONG><BR>
  538. <DD>
  539. If 0, allows <EM>stepping off</EM> the end of the script.
  540. <P></P>
  541. <DT><STRONG><A NAME="item_PrintRet"><CODE>PrintRet</CODE></A></STRONG><BR>
  542. <DD>
  543. Print return value after <A HREF="#item_r"><CODE>r</CODE></A> command if set (default).
  544. <P></P>
  545. <DT><STRONG><A NAME="item_ornaments"><CODE>ornaments</CODE></A></STRONG><BR>
  546. <DD>
  547. Affects screen appearance of the command line (see <A HREF="../../lib/Term/ReadLine.html">the Term::ReadLine manpage</A>).
  548. There is currently no way to disable these, which can render
  549. some output illegible on some displays, or with some pagers.
  550. This is considered a bug.
  551. <P></P>
  552. <DT><STRONG><A NAME="item_frame"><CODE>frame</CODE></A></STRONG><BR>
  553. <DD>
  554. Affects the printing of messages upon entry and exit from subroutines.  If
  555. <A HREF="#item_frame"><CODE>frame & 2</CODE></A> is false, messages are printed on entry only. (Printing
  556. on exit might be useful if interspersed with other messages.)
  557. <P>If <A HREF="#item_frame"><CODE>frame & 4</CODE></A>, arguments to functions are printed, plus context
  558. and caller info.  If <A HREF="#item_frame"><CODE>frame & 8</CODE></A>, overloaded <CODE>stringify</CODE> and
  559. <A HREF="../../lib/Pod/perlfunc.html#item_tie"><CODE>tie</CODE></A>d <CODE>FETCH</CODE> is enabled on the printed arguments.  If <A HREF="#item_frame"><CODE>frame
  560. & 16</CODE></A>, the return value from the subroutine is printed.</P>
  561. <P>The length at which the argument list is truncated is governed by the
  562. next option:</P>
  563. <P></P>
  564. <DT><STRONG><A NAME="item_maxTraceLen"><CODE>maxTraceLen</CODE></A></STRONG><BR>
  565. <DD>
  566. Length to truncate the argument list when the <A HREF="#item_frame"><CODE>frame</CODE></A> option's
  567. bit 4 is set.
  568. <P></P></DL>
  569. <P>The following options affect what happens with <CODE>V</CODE>, <CODE>X</CODE>, and <CODE>x</CODE>
  570. commands:</P>
  571. <DL>
  572. <DT><STRONG><A NAME="item_arrayDepth%2C_hashDepth"><CODE>arrayDepth</CODE>, <CODE>hashDepth</CODE></A></STRONG><BR>
  573. <DD>
  574. Print only first N elements ('' for all).
  575. <P></P>
  576. <DT><STRONG><A NAME="item_compactDump%2C_veryCompact"><CODE>compactDump</CODE>, <CODE>veryCompact</CODE></A></STRONG><BR>
  577. <DD>
  578. Change the style of array and hash output.  If <CODE>compactDump</CODE>, short array
  579. may be printed on one line.
  580. <P></P>
  581. <DT><STRONG><A NAME="item_globPrint"><CODE>globPrint</CODE></A></STRONG><BR>
  582. <DD>
  583. Whether to print contents of globs.
  584. <P></P>
  585. <DT><STRONG><A NAME="item_DumpDBFiles"><CODE>DumpDBFiles</CODE></A></STRONG><BR>
  586. <DD>
  587. Dump arrays holding debugged files.
  588. <P></P>
  589. <DT><STRONG><A NAME="item_DumpPackages"><CODE>DumpPackages</CODE></A></STRONG><BR>
  590. <DD>
  591. Dump symbol tables of packages.
  592. <P></P>
  593. <DT><STRONG><A NAME="item_DumpReused"><CODE>DumpReused</CODE></A></STRONG><BR>
  594. <DD>
  595. Dump contents of ``reused'' addresses.
  596. <P></P>
  597. <DT><STRONG><A NAME="item_quote%2C_HighBit%2C_undefPrint"><CODE>quote</CODE>, <CODE>HighBit</CODE>, <CODE>undefPrint</CODE></A></STRONG><BR>
  598. <DD>
  599. Change the style of string dump.  The default value for <CODE>quote</CODE>
  600. is <CODE>auto</CODE>; one can enable double-quotish or single-quotish format
  601. by setting it to <CODE>"</CODE> or <CODE>'</CODE>, respectively.  By default, characters
  602. with their high bit set are printed verbatim.
  603. <P></P>
  604. <DT><STRONG><A NAME="item_UsageOnly"><CODE>UsageOnly</CODE></A></STRONG><BR>
  605. <DD>
  606. Rudimentary per-package memory usage dump.  Calculates total
  607. size of strings found in variables in the package.  This does not
  608. include lexicals in a module's file scope, or lost in closures.
  609. <P></P></DL>
  610. <P>During startup, options are initialized from <CODE>$ENV{PERLDB_OPTS}</CODE>.
  611. You may place the initialization options <A HREF="#item_TTY"><CODE>TTY</CODE></A>, <A HREF="#item_noTTY"><CODE>noTTY</CODE></A>,
  612. <A HREF="#item_ReadLine"><CODE>ReadLine</CODE></A>, and <A HREF="#item_NonStop"><CODE>NonStop</CODE></A> there.</P>
  613. <P>If your rc file contains:</P>
  614. <PRE>
  615.   parse_options("NonStop=1 LineInfo=db.out AutoTrace");</PRE>
  616. <P>then your script will run without human intervention, putting trace
  617. information into the file <EM>db.out</EM>.  (If you interrupt it, you'd
  618. better reset <A HREF="#item_LineInfo"><CODE>LineInfo</CODE></A> to <EM>/dev/tty</EM> if you expect to see anything.)</P>
  619. <DL>
  620. <DT><STRONG><A NAME="item_TTY"><CODE>TTY</CODE></A></STRONG><BR>
  621. <DD>
  622. The TTY to use for debugging I/O.
  623. <P></P>
  624. <DT><STRONG><A NAME="item_noTTY"><CODE>noTTY</CODE></A></STRONG><BR>
  625. <DD>
  626. If set, the debugger goes into <A HREF="#item_NonStop"><CODE>NonStop</CODE></A> mode and will not connect to a TTY.  If
  627. interrupted (or if control goes to the debugger via explicit setting of
  628. $DB::signal or $DB::single from the Perl script), it connects to a TTY
  629. specified in the <A HREF="#item_TTY"><CODE>TTY</CODE></A> option at startup, or to a tty found at
  630. runtime using the <CODE>Term::Rendezvous</CODE> module of your choice.
  631. <P>This module should implement a method named <CODE>new</CODE> that returns an object
  632. with two methods: <CODE>IN</CODE> and <CODE>OUT</CODE>.  These should return filehandles to use
  633. for debugging input and output correspondingly.  The <CODE>new</CODE> method should
  634. inspect an argument containing the value of <CODE>$ENV{PERLDB_NOTTY}</CODE> at
  635. startup, or <CODE>"/tmp/perldbtty$$"</CODE> otherwise.  This file is not 
  636. inspected for proper ownership, so security hazards are theoretically
  637. possible.</P>
  638. <P></P>
  639. <DT><STRONG><A NAME="item_ReadLine"><CODE>ReadLine</CODE></A></STRONG><BR>
  640. <DD>
  641. If false, readline support in the debugger is disabled in order
  642. to debug applications that themselves use ReadLine.
  643. <P></P>
  644. <DT><STRONG><A NAME="item_NonStop"><CODE>NonStop</CODE></A></STRONG><BR>
  645. <DD>
  646. If set, the debugger goes into non-interactive mode until interrupted, or
  647. programmatically by setting $DB::signal or $DB::single.
  648. <P></P></DL>
  649. <P>Here's an example of using the <CODE>$ENV{PERLDB_OPTS}</CODE> variable:</P>
  650. <PRE>
  651.     $ PERLDB_OPTS="NonStop frame=2" perl -d myprogram</PRE>
  652. <P>That will run the script <STRONG>myprogram</STRONG> without human intervention,
  653. printing out the call tree with entry and exit points.  Note that
  654. <CODE>NonStop=1 frame=2</CODE> is equivalent to <CODE>N f=2</CODE>, and that originally,
  655. options could be uniquely abbreviated by the first letter (modulo
  656. the <CODE>Dump*</CODE> options).  It is nevertheless recommended that you
  657. always spell them out in full for legibility and future compatibility.</P>
  658. <P>Other examples include</P>
  659. <PRE>
  660.     $ PERLDB_OPTS="NonStop frame=2" perl -d myprogram</PRE>
  661. <P>which runs script non-interactively, printing info on each entry
  662. into a subroutine and each executed line into the file named <EM>listing</EM>.
  663. (If you interrupt it, you would better reset <A HREF="#item_LineInfo"><CODE>LineInfo</CODE></A> to something
  664. ``interactive''!)</P>
  665. <P>Other examples include (using standard shell syntax to show environment
  666. variable settings):</P>
  667. <PRE>
  668.   $ ( PERLDB_OPTS="NonStop frame=1 AutoTrace LineInfo=tperl.out"
  669.       perl -d myprogram )</PRE>
  670. <P>which may be useful for debugging a program that uses <CODE>Term::ReadLine</CODE>
  671. itself.  Do not forget to detach your shell from the TTY in the window that
  672. corresponds to <EM>/dev/ttyXX</EM>, say, by issuing a command like</P>
  673. <PRE>
  674.   $ sleep 1000000</PRE>
  675. <P>See <A HREF="../../lib/Pod/perldebguts.html#debugger internals">Debugger Internals in the perldebguts manpage</A> for details.</P>
  676. <P>
  677. <H2><A NAME="debugger input/output">Debugger input/output</A></H2>
  678. <DL>
  679. <DT><STRONG><A NAME="item_Prompt">Prompt</A></STRONG><BR>
  680. <DD>
  681. The debugger prompt is something like
  682. <PRE>
  683.     DB<8></PRE>
  684. <P>or even</P>
  685. <PRE>
  686.     DB<<17>></PRE>
  687. <P>where that number is the command number, and which you'd use to
  688. access with the built-in <STRONG>csh</STRONG>-like history mechanism.  For example,
  689. <CODE>!17</CODE> would repeat command number 17.  The depth of the angle
  690. brackets indicates the nesting depth of the debugger.  You could
  691. get more than one set of brackets, for example, if you'd already
  692. at a breakpoint and then printed the result of a function call that
  693. itself has a breakpoint, or you step into an expression via <CODE>s/n/t
  694. expression</CODE> command.</P>
  695. <P></P>
  696. <DT><STRONG><A NAME="item_Multiline_commands">Multiline commands</A></STRONG><BR>
  697. <DD>
  698. If you want to enter a multi-line command, such as a subroutine
  699. definition with several statements or a format, escape the newline
  700. that would normally end the debugger command with a backslash.
  701. Here's an example:
  702. <PRE>
  703.       DB<1> for (1..4) {         \
  704.       cont:     print "ok\n";   \
  705.       cont: }
  706.       ok
  707.       ok
  708.       ok
  709.       ok</PRE>
  710. <P>Note that this business of escaping a newline is specific to interactive
  711. commands typed into the debugger.</P>
  712. <P></P>
  713. <DT><STRONG><A NAME="item_Stack_backtrace">Stack backtrace</A></STRONG><BR>
  714. <DD>
  715. Here's an example of what a stack backtrace via <A HREF="#item_T"><CODE>T</CODE></A> command might
  716. look like:
  717. <PRE>
  718.     $ = main::infested called from file `Ambulation.pm' line 10
  719.     @ = Ambulation::legs(1, 2, 3, 4) called from file `camel_flea' line 7
  720.     $ = main::pests('bactrian', 4) called from file `camel_flea' line 4</PRE>
  721. <P>The left-hand character up there indicates the context in which the
  722. function was called, with <CODE>$</CODE> and <CODE>@</CODE> meaning scalar or list
  723. contexts respectively, and <A HREF="#item_%2E"><CODE>.</CODE></A> meaning void context (which is
  724. actually a sort of scalar context).  The display above says
  725. that you were in the function <CODE>main::infested</CODE> when you ran the
  726. stack dump, and that it was called in scalar context from line
  727. 10 of the file <EM>Ambulation.pm</EM>, but without any arguments at all,
  728. meaning it was called as <CODE>&infested</CODE>.  The next stack frame shows
  729. that the function <CODE>Ambulation::legs</CODE> was called in list context
  730. from the <EM>camel_flea</EM> file with four arguments.  The last stack
  731. frame shows that <CODE>main::pests</CODE> was called in scalar context,
  732. also from <EM>camel_flea</EM>, but from line 4.</P>
  733. <P>If you execute the <A HREF="#item_T"><CODE>T</CODE></A> command from inside an active <A HREF="../../lib/Pod/perlfunc.html#item_use"><CODE>use</CODE></A>
  734. statement, the backtrace will contain both a <A HREF="../../lib/Pod/perlfunc.html#item_require"><CODE>require</CODE></A> frame and
  735. an <A HREF="../../lib/Pod/perlfunc.html#item_eval"><CODE>eval</CODE></A>) frame.</P>
  736. <P></P>
  737. <DT><STRONG><A NAME="item_Line_Listing_Format">Line Listing Format</A></STRONG><BR>
  738. <DD>
  739. This shows the sorts of output the <A HREF="#item_l"><CODE>l</CODE></A> command can produce:
  740. <PRE>
  741.     DB<<13>> l
  742.   101:                @i{@i} = ();
  743.   102:b               @isa{@i,$pack} = ()
  744.   103                     if(exists $i{$prevpack} || exists $isa{$pack});
  745.   104             }
  746.   105
  747.   106             next
  748.   107==>              if(exists $isa{$pack});
  749.   108
  750.   109:a           if ($extra-- > 0) {
  751.   110:                %isa = ($pack,1);</PRE>
  752. <P>Breakable lines are marked with <CODE>:</CODE>.  Lines with breakpoints are
  753. marked by <CODE>b</CODE> and those with actions by <CODE>a</CODE>.  The line that's
  754. about to be executed is marked by <CODE>==></CODE>.</P>
  755. <P></P>
  756. <DT><STRONG><A NAME="item_Frame_listing">Frame listing</A></STRONG><BR>
  757. <DD>
  758. When the <A HREF="#item_frame"><CODE>frame</CODE></A> option is set, the debugger would print entered (and
  759. optionally exited) subroutines in different styles.  See <A HREF="../../lib/Pod/perldebguts.html">the perldebguts manpage</A>
  760. for incredibly long examples of these.
  761. <P></P></DL>
  762. <P>
  763. <H2><A NAME="debugging compiletime statements">Debugging compile-time statements</A></H2>
  764. <P>If you have compile-time executable statements (such as code within
  765. BEGIN and CHECK blocks or <A HREF="../../lib/Pod/perlfunc.html#item_use"><CODE>use</CODE></A> statements), these will <EM>not</EM> be
  766. stopped by debugger, although <A HREF="../../lib/Pod/perlfunc.html#item_require"><CODE>require</CODE></A>s and INIT blocks will, and
  767. compile-time statements can be traced with <A HREF="#item_AutoTrace"><CODE>AutoTrace</CODE></A> option set
  768. in <CODE>PERLDB_OPTS</CODE>).  From your own Perl code, however, you can
  769. transfer control back to the debugger using the following statement,
  770. which is harmless if the debugger is not running:</P>
  771. <PRE>
  772.     $DB::single = 1;</PRE>
  773. <P>If you set <CODE>$DB::single</CODE> to 2, it's equivalent to having
  774. just typed the <CODE>n</CODE> command, whereas a value of 1 means the <A HREF="../../lib/Pod/perlfunc.html#item_s"><CODE>s</CODE></A>
  775. command.  The <CODE>$DB::trace</CODE>  variable should be set to 1 to simulate
  776. having typed the <A HREF="#item_t"><CODE>t</CODE></A> command.</P>
  777. <P>Another way to debug compile-time code is to start the debugger, set a
  778. breakpoint on the <EM>load</EM> of some module:</P>
  779. <PRE>
  780.     DB<7> b load f:/perllib/lib/Carp.pm
  781.   Will stop on load of `f:/perllib/lib/Carp.pm'.</PRE>
  782. <P>and then restart the debugger using the <A HREF="#item_R"><CODE>R</CODE></A> command (if possible).  One can use <A HREF="#item_b_compile_subname"><CODE>b
  783. compile subname</CODE></A> for the same purpose.</P>
  784. <P>
  785. <H2><A NAME="debugger customization">Debugger Customization</A></H2>
  786. <P>The debugger probably contains enough configuration hooks that you
  787. won't ever have to modify it yourself.  You may change the behaviour
  788. of debugger from within the debugger using its <CODE>O</CODE> command, from
  789. the command line via the <CODE>PERLDB_OPTS</CODE> environment variable, and
  790. from customization files.</P>
  791. <P>You can do some customization by setting up a <EM>.perldb</EM> file, which
  792. contains initialization code.  For instance, you could make aliases
  793. like these (the last one is one people expect to be there):</P>
  794. <PRE>
  795.     $DB::alias{'len'}  = 's/^len(.*)/p length($1)/';
  796.     $DB::alias{'stop'} = 's/^stop (at|in)/b/';
  797.     $DB::alias{'ps'}   = 's/^ps\b/p scalar /';
  798.     $DB::alias{'quit'} = 's/^quit(\s*)/exit/';</PRE>
  799. <P>You can change options from <EM>.perldb</EM> by using calls like this one;</P>
  800. <PRE>
  801.     parse_options("NonStop=1 LineInfo=db.out AutoTrace=1 frame=2");</PRE>
  802. <P>The code is executed in the package <CODE>DB</CODE>.  Note that <EM>.perldb</EM> is
  803. processed before processing <CODE>PERLDB_OPTS</CODE>.  If <EM>.perldb</EM> defines the
  804. subroutine <CODE>afterinit</CODE>, that function is called after debugger
  805. initialization ends.  <EM>.perldb</EM> may be contained in the current
  806. directory, or in the home directory.  Because this file is sourced
  807. in by Perl and may contain arbitrary commands, for security reasons,
  808. it must be owned by the superuser or the current user, and writable
  809. by no one but its owner.</P>
  810. <P>If you want to modify the debugger, copy <EM>perl5db.pl</EM> from the
  811. Perl library to another name and hack it to your heart's content.
  812. You'll then want to set your <A HREF="../../lib/Pod/perlrun.html#item_PERL5DB"><CODE>PERL5DB</CODE></A> environment variable to say
  813. something like this:</P>
  814. <PRE>
  815.     BEGIN { require "myperl5db.pl" }</PRE>
  816. <P>As a last resort, you could also use <A HREF="../../lib/Pod/perlrun.html#item_PERL5DB"><CODE>PERL5DB</CODE></A> to customize the debugger
  817. by directly setting internal variables or calling debugger functions.</P>
  818. <P>Note that any variables and functions that are not documented in
  819. this document (or in <A HREF="../../lib/Pod/perldebguts.html">the perldebguts manpage</A>) are considered for internal
  820. use only, and as such are subject to change without notice.</P>
  821. <P>
  822. <H2><A NAME="readline support">Readline Support</A></H2>
  823. <P>As shipped, the only command-line history supplied is a simplistic one
  824. that checks for leading exclamation points.  However, if you install
  825. the Term::ReadKey and Term::ReadLine modules from CPAN, you will
  826. have full editing capabilities much like GNU <EM>readline</EM>(3) provides.
  827. Look for these in the <EM>modules/by-module/Term</EM> directory on CPAN.
  828. These do not support normal <STRONG>vi</STRONG> command-line editing, however.</P>
  829. <P>A rudimentary command-line completion is also available.
  830. Unfortunately, the names of lexical variables are not available for
  831. completion.</P>
  832. <P>
  833. <H2><A NAME="editor support for debugging">Editor Support for Debugging</A></H2>
  834. <P>If you have the FSF's version of <STRONG>emacs</STRONG> installed on your system,
  835. it can interact with the Perl debugger to provide an integrated
  836. software development environment reminiscent of its interactions
  837. with C debuggers.</P>
  838. <P>Perl comes with a start file for making <STRONG>emacs</STRONG> act like a
  839. syntax-directed editor that understands (some of) Perl's syntax.
  840. Look in the <EM>emacs</EM> directory of the Perl source distribution.</P>
  841. <P>A similar setup by Tom Christiansen for interacting with any
  842. vendor-shipped <STRONG>vi</STRONG> and the X11 window system is also available.
  843. This works similarly to the integrated multiwindow support that
  844. <STRONG>emacs</STRONG> provides, where the debugger drives the editor.  At the
  845. time of this writing, however, that tool's eventual location in the
  846. Perl distribution was uncertain.</P>
  847. <P>Users of <STRONG>vi</STRONG> should also look into <STRONG>vim</STRONG> and <STRONG>gvim</STRONG>, the mousey
  848. and windy version, for coloring of Perl keywords.</P>
  849. <P>Note that only perl can truly parse Perl, so all such CASE tools
  850. fall somewhat short of the mark, especially if you don't program
  851. your Perl as a C programmer might.</P>
  852. <P>
  853. <H2><A NAME="the perl profiler">The Perl Profiler</A></H2>
  854. <P>If you wish to supply an alternative debugger for Perl to run, just
  855. invoke your script with a colon and a package argument given to the
  856. <STRONG>-d</STRONG> flag.  The most popular alternative debuggers for Perl is the
  857. Perl profiler.  Devel::DProf is now included with the standard Perl
  858. distribution.  To profile your Perl program in the file <EM>mycode.pl</EM>,
  859. just type:</P>
  860. <PRE>
  861.     $ perl -d:DProf mycode.pl</PRE>
  862. <P>When the script terminates the profiler will dump the profile
  863. information to a file called <EM>tmon.out</EM>.  A tool like <STRONG>dprofpp</STRONG>,
  864. also supplied with the standard Perl distribution, can be used to
  865. interpret the information in that profile.</P>
  866. <P>
  867. <HR>
  868. <H1><A NAME="debugging regular expressions">Debugging regular expressions</A></H1>
  869. <P><CODE>use re 'debug'</CODE> enables you to see the gory details of how the
  870. Perl regular expression engine works.  In order to understand this
  871. typically voluminous output, one must not only have some idea about
  872. about how regular expression matching works in general, but also
  873. know how Perl's regular expressions are internally compiled into
  874. an automaton.  These matters are explored in some detail in
  875. <A HREF="../../lib/Pod/perldebguts.html#debugging regular expressions">Debugging regular expressions in the perldebguts manpage</A>.</P>
  876. <P>
  877. <HR>
  878. <H1><A NAME="debugging memory usage">Debugging memory usage</A></H1>
  879. <P>Perl contains internal support for reporting its own memory usage,
  880. but this is a fairly advanced concept that requires some understanding
  881. of how memory allocation works.
  882. See <A HREF="../../lib/Pod/perldebguts.html#debugging perl memory usage">Debugging Perl memory usage in the perldebguts manpage</A> for the details.</P>
  883. <P>
  884. <HR>
  885. <H1><A NAME="see also">SEE ALSO</A></H1>
  886. <P>You did try the <STRONG>-w</STRONG> switch, didn't you?</P>
  887. <P><A HREF="../../lib/Pod/perldebguts.html">the perldebguts manpage</A>,
  888. <A HREF="../../lib/re.html">the re manpage</A>,
  889. <A HREF="../../lib/DB.html">the DB manpage</A>,
  890. <A HREF="../../Devel/Dprof.html">the Devel::Dprof manpage</A>,
  891. <EM>dprofpp</EM>,
  892. <A HREF="../../lib/Dumpvalue.html">the Dumpvalue manpage</A>,
  893. and
  894. <A HREF="../../lib/Pod/perlrun.html">the perlrun manpage</A>.</P>
  895. <P>
  896. <HR>
  897. <H1><A NAME="bugs">BUGS</A></H1>
  898. <P>You cannot get stack frame information or in any fashion debug functions
  899. that were not compiled by Perl, such as those from C or C++ extensions.</P>
  900. <P>If you alter your @_ arguments in a subroutine (such as with <A HREF="../../lib/Pod/perlfunc.html#item_shift"><CODE>shift</CODE></A>
  901. or <A HREF="../../lib/Pod/perlfunc.html#item_pop"><CODE>pop</CODE></A>, the stack backtrace will not show the original values.</P>
  902. <P>The debugger does not currently work in conjunction with the <STRONG>-W</STRONG>
  903. command-line switch, because it itself is not free of warnings.</P>
  904. <P>If you're in a slow syscall (like <A HREF="../../lib/Pod/perlfunc.html#item_wait"><CODE>wait</CODE></A>ing, <A HREF="../../lib/Pod/perlfunc.html#item_accept"><CODE>accept</CODE></A>ing, or <A HREF="../../lib/Pod/perlfunc.html#item_read"><CODE>read</CODE></A>ing
  905. from your keyboard or a socket) and haven't set up your own <CODE>$SIG{INT}</CODE>
  906. handler, then you won't be able to CTRL-C your way back to the debugger,
  907. because the debugger's own <CODE>$SIG{INT}</CODE> handler doesn't understand that
  908. it needs to raise an exception to <CODE>longjmp(3)</CODE> out of slow syscalls.</P>
  909. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  910. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  911. <STRONG><P CLASS=block> perldebug - Perl debugging</P></STRONG>
  912. </TD></TR>
  913. </TABLE>
  914.  
  915. </BODY>
  916.  
  917. </HTML>
  918.