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 / perl-5.8.0 / man / man3 / ExtUtils::Installed.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 "ExtUtils::Installed 3"
132.TH ExtUtils::Installed 3 "2003-08-18" "perl v5.8.0" "User Contributed Perl Documentation"
133.SH "NAME"
134ExtUtils::Installed \- Inventory management of installed modules
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 9
138\& use ExtUtils::Installed;
139\& my ($inst) = ExtUtils::Installed->new();
140\& my (@modules) = $inst->modules();
141\& my (@missing) = $inst->validate("DBI");
142\& my $all_files = $inst->files("DBI");
143\& my $files_below_usr_local = $inst->files("DBI", "all", "/usr/local");
144\& my $all_dirs = $inst->directories("DBI");
145\& my $dirs_below_usr_local = $inst->directory_tree("DBI", "prog");
146\& my $packlist = $inst->packlist("DBI");
147.Ve
148.SH "DESCRIPTION"
149.IX Header "DESCRIPTION"
150ExtUtils::Installed provides a standard way to find out what core and module
151files have been installed. It uses the information stored in .packlist files
152created during installation to provide this information. In addition it
153provides facilities to classify the installed files and to extract directory
154information from the .packlist files.
155.SH "USAGE"
156.IX Header "USAGE"
157The \fInew()\fR function searches for all the installed .packlists on the system, and
158stores their contents. The .packlists can be queried with the functions
159described below.
160.SH "FUNCTIONS"
161.IX Header "FUNCTIONS"
162.IP "\fInew()\fR" 4
163.IX Item "new()"
164This takes no parameters, and searches for all the installed .packlists on the
165system. The packlists are read using the ExtUtils::packlist module.
166.IP "\fImodules()\fR" 4
167.IX Item "modules()"
168This returns a list of the names of all the installed modules. The perl 'core'
169is given the special name 'Perl'.
170.IP "\fIfiles()\fR" 4
171.IX Item "files()"
172This takes one mandatory parameter, the name of a module. It returns a list of
173all the filenames from the package. To obtain a list of core perl files, use
174the module name 'Perl'. Additional parameters are allowed. The first is one
175of the strings \*(L"prog\*(R", \*(L"doc\*(R" or \*(L"all\*(R", to select either just program files,
176just manual files or all files. The remaining parameters are a list of
177directories. The filenames returned will be restricted to those under the
178specified directories.
179.IP "\fIdirectories()\fR" 4
180.IX Item "directories()"
181This takes one mandatory parameter, the name of a module. It returns a list of
182all the directories from the package. Additional parameters are allowed. The
183first is one of the strings \*(L"prog\*(R", \*(L"doc\*(R" or \*(L"all\*(R", to select either just
184program directories, just manual directories or all directories. The remaining
185parameters are a list of directories. The directories returned will be
186restricted to those under the specified directories. This method returns only
187the leaf directories that contain files from the specified module.
188.IP "\fIdirectory_tree()\fR" 4
189.IX Item "directory_tree()"
190This is identical in operation to \fIdirectories()\fR, except that it includes all the
191intermediate directories back up to the specified directories.
192.IP "\fIvalidate()\fR" 4
193.IX Item "validate()"
194This takes one mandatory parameter, the name of a module. It checks that all
195the files listed in the modules .packlist actually exist, and returns a list of
196any missing files. If an optional second argument which evaluates to true is
197given any missing files will be removed from the .packlist
198.IP "\fIpacklist()\fR" 4
199.IX Item "packlist()"
200This returns the ExtUtils::Packlist object for the specified module.
201.IP "\fIversion()\fR" 4
202.IX Item "version()"
203This returns the version number for the specified module.
204.SH "EXAMPLE"
205.IX Header "EXAMPLE"
206See the example in ExtUtils::Packlist.
207.SH "AUTHOR"
208.IX Header "AUTHOR"
209Alan Burlison <Alan.Burlison@uk.sun.com>
Full OpenSPARC design & verification tarball including full HDL.