projects / OpenSPARC-T2-DV / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perlmod / OutputDirector / 1.01 / man / man3 / OutputDirector.3
CommitLineData
86530b38
AT		 1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "OutputDirector 3"
132.TH OutputDirector 3 "2002-10-28" "perl v5.8.0" "User Contributed Perl Documentation"
133.SH "NAME"
134OutputDirector \- Object interface to output streams to allow easy redirection
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& use OutputDirector;
139.Ve
140.PP
141.Vb 1
142\& my $OUT = OutputDirector->new();
143.Ve
144.PP
145.Vb 2
146\& $OUT->print_status("Hello, world!\en");
147\& $OUT->print_error("Things are not good.\en");
148.Ve
149.SH "ABSTRACT"
150.IX Header "ABSTRACT"
151.Vb 3
152\& This module provides an object interface for status and error output
153\& streams. The intent is that a module that uses an OutputDirector
154\& can be trivially modified to redirect output.
155.Ve
156.SH "DESCRIPTION"
157.IX Header "DESCRIPTION"
158This module provides an object interface to status and error streams.
159The intent is that a module or script that uses an OutputDirector can
160be easily (and dynamically) modified to redirect its output.
161.Sh "Construction"
162.IX Subsection "Construction"
163The OutputDirector is created by the class method \fInew()\fR. The
164arguments to new form a hash of arguments whose legal keys are as follows:
165.IP "print_status" 4
166.IX Item "print_status"
167Value is a coderef to use in the print_status method. Default method
168prints arguments to \s-1STDOUT\s0.
169.IP "printf_status" 4
170.IX Item "printf_status"
171Value is a coderef to use in the printf_status method. Default method
172prints formatted string to \s-1STDOUT\s0.
173.IP "print_error" 4
174.IX Item "print_error"
175Value is a coderef to use in the print_error method. Default method
176prints arguments to \s-1STDERR\s0.
177.IP "printf_error" 4
178.IX Item "printf_error"
179Value is a coderef to use in the printf_error method. Default method
180prints formatted string to \s-1STDERR\s0.
181.PP
182The default OutputDirector is constructed as shown in the default
183section. If, for instance, you wanted to redefine how messages are
184printed to the error stream, use:
185.PP
186.Vb 4
187\& my $OUT = OutputDirector->new(
188\& print_error => \e&my_print_error,
189\& printf_error => \e&my_printf_error,
190\& );
191.Ve
192.PP
193.Vb 1
194\& $OUT->print_error("This string goes to my_print_error\en");
195.Ve
196.Sh "Methods"
197.IX Subsection "Methods"
198The OutputDirector has 4 object methods:
199.IP "print_status(@args)" 4
200.IX Item "print_status(@args)"
201Print the arguments to the status stream.
202.ie n .IP "printf_status($format, @args)" 4
203.el .IP "printf_status($format, \f(CW@args\fR)" 4
204.IX Item "printf_status($format, @args)"
205Print formatted string to the status stream.
206.IP "print_error(@args)" 4
207.IX Item "print_error(@args)"
208Print the arguments to the error stream.
209.ie n .IP "printf_error($format, @args)" 4
210.el .IP "printf_error($format, \f(CW@args\fR)" 4
211.IX Item "printf_error($format, @args)"
212Print formatted string to the error stream.
213.SH "SEE ALSO"
214.IX Header "SEE ALSO"
215\&\fITriage\fR\|(3).
Full OpenSPARC design & verification tarball including full HDL.