Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / man / man3 / ExtUtils::Command::MM.3
CommitLineData
920dae64
AT
1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
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 "ExtUtils::Command::MM 3"
132.TH ExtUtils::Command::MM 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
133.SH "NAME"
134ExtUtils::Command::MM \- Commands for the MM's to use in Makefiles
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& perl "-MExtUtils::Command::MM" -e "function" "--" arguments...
139.Ve
140.SH "DESCRIPTION"
141.IX Header "DESCRIPTION"
142\&\fB\s-1FOR\s0 \s-1INTERNAL\s0 \s-1USE\s0 \s-1ONLY\s0!\fR The interface is not stable.
143.PP
144ExtUtils::Command::MM encapsulates code which would otherwise have to
145be done with large \*(L"one\*(R" liners.
146.PP
147Any $(\s-1FOO\s0) used in the examples are make variables, not Perl.
148.IP "\fBtest_harness\fR" 4
149.IX Item "test_harness"
150.Vb 1
151\& test_harness($verbose, @test_libs);
152.Ve
153.Sp
154Runs the tests on \f(CW@ARGV\fR via Test::Harness passing through the \f(CW$verbose\fR
155flag. Any \f(CW@test_libs\fR will be unshifted onto the test's \f(CW@INC\fR.
156.Sp
157@test_libs are run in alphabetical order.
158.IP "\fBpod2man\fR" 4
159.IX Item "pod2man"
160.Vb 5
161\& pod2man( '--option=value',
162\& $podfile1 => $manpage1,
163\& $podfile2 => $manpage2,
164\& ...
165\& );
166.Ve
167.Sp
168.Vb 1
169\& # or args on @ARGV
170.Ve
171.Sp
172\&\fIpod2man()\fR is a function performing most of the duties of the pod2man
173program. Its arguments are exactly the same as pod2man as of 5.8.0
174with the addition of:
175.Sp
176.Vb 1
177\& --perm_rw octal permission to set the resulting manpage to
178.Ve
179.Sp
180And the removal of:
181.Sp
182.Vb 2
183\& --verbose/-v
184\& --help/-h
185.Ve
186.Sp
187If no arguments are given to pod2man it will read from \f(CW@ARGV\fR.
188.IP "\fBwarn_if_old_packlist\fR" 4
189.IX Item "warn_if_old_packlist"
190.Vb 1
191\& perl "-MExtUtils::Command::MM" -e warn_if_old_packlist <somefile>
192.Ve
193.Sp
194Displays a warning that an old packlist file was found. Reads the
195filename from \f(CW@ARGV\fR.
196.IP "\fBperllocal_install\fR" 4
197.IX Item "perllocal_install"
198.Vb 2
199\& perl "-MExtUtils::Command::MM" -e perllocal_install
200\& <type> <module name> <key> <value> ...
201.Ve
202.Sp
203.Vb 3
204\& # VMS only, key|value pairs come on STDIN
205\& perl "-MExtUtils::Command::MM" -e perllocal_install
206\& <type> <module name> < <key>|<value> ...
207.Ve
208.Sp
209Prints a fragment of \s-1POD\s0 suitable for appending to perllocal.pod.
210Arguments are read from \f(CW@ARGV\fR.
211.Sp
212\&'type' is the type of what you're installing. Usually 'Module'.
213.Sp
214\&'module name' is simply the name of your module. (Foo::Bar)
215.Sp
216Key/value pairs are extra information about the module. Fields include:
217.Sp
218.Vb 5
219\& installed into which directory your module was out into
220\& LINKTYPE dynamic or static linking
221\& VERSION module version number
222\& EXE_FILES any executables installed in a space seperated
223\& list
224.Ve
225.IP "\fBuninstall\fR" 4
226.IX Item "uninstall"
227.Vb 1
228\& perl "-MExtUtils::Command::MM" -e uninstall <packlist>
229.Ve
230.Sp
231A wrapper around \fIExtUtils::Install::uninstall()\fR. Warns that
232uninstallation is deprecated and doesn't actually perform the
233uninstallation.