Debian Codegraph @

upstream/debian-unstable/man3/B::Terse.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "B::Terse 3perl"
58 .TH B::Terse 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 B::Terse \- Walk Perl syntax tree, printing terse info about ops
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& perl \-MO=Terse[,OPTIONS] foo.pl
69 .Ve
70 .SH DESCRIPTION
71 .IX Header "DESCRIPTION"
72 This module prints the contents of the parse tree, but without as much
73 information as CPAN module B::Debug. For comparison, \f(CW\*(C`print "Hello, world."\*(C'\fR
74 produced 96 lines of output from B::Debug, but only 6 from B::Terse.
75 .PP
76 This module is useful for people who are writing their own back end,
77 or who are learning about the Perl internals. It's not useful to the
78 average programmer.
79 .PP
80 This version of B::Terse is really just a wrapper that calls B::Concise
81 with the \fB\-terse\fR option. It is provided for compatibility with old scripts
82 (and habits) but using B::Concise directly is now recommended instead.
83 .PP
84 For compatibility with the old B::Terse, this module also adds a
85 method named \f(CW\*(C`terse\*(C'\fR to B::OP and B::SV objects. The B::SV method is
86 largely compatible with the old one, though authors of new software
87 might be advised to choose a more user-friendly output format. The
88 B::OP \f(CW\*(C`terse\*(C'\fR method, however, doesn't work well. Since B::Terse was
89 first written, much more information in OPs has migrated to the
90 scratchpad datastructure, but the \f(CW\*(C`terse\*(C'\fR interface doesn't have any
91 way of getting to the correct pad. As a kludge, the new version will
92 always use the pad for the main program, but for OPs in subroutines
93 this will give the wrong answer or crash.
94 .SH AUTHOR
95 .IX Header "AUTHOR"
96 The original version of B::Terse was written by Malcolm Beattie,
97 <[email protected]>. This wrapper was written by Stephen
98 McCamant, <[email protected]>.