Commit | Line | Data |
---|---|---|
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 "H2PH 1" | |
132 | .TH H2PH 1 "2002-08-28" "perl v5.8.0" "Perl Programmers Reference Guide" | |
133 | .SH "NAME" | |
134 | h2ph \- convert .h C header files to .ph Perl header files | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | \&\fBh2ph [\-d destination directory] [\-r | \-a] [\-l] [headerfiles]\fR | |
138 | .SH "DESCRIPTION" | |
139 | .IX Header "DESCRIPTION" | |
140 | \&\fIh2ph\fR | |
141 | converts any C header files specified to the corresponding Perl header file | |
142 | format. | |
143 | It is most easily run while in /usr/include: | |
144 | .PP | |
145 | .Vb 1 | |
146 | \& cd /usr/include; h2ph * sys/* | |
147 | .Ve | |
148 | .PP | |
149 | or | |
150 | .PP | |
151 | .Vb 1 | |
152 | \& cd /usr/include; h2ph * sys/* arpa/* netinet/* | |
153 | .Ve | |
154 | .PP | |
155 | or | |
156 | .PP | |
157 | .Vb 1 | |
158 | \& cd /usr/include; h2ph -r -l . | |
159 | .Ve | |
160 | .PP | |
161 | The output files are placed in the hierarchy rooted at Perl's | |
162 | architecture dependent library directory. You can specify a different | |
163 | hierarchy with a \fB\-d\fR switch. | |
164 | .PP | |
165 | If run with no arguments, filters standard input to standard output. | |
166 | .SH "OPTIONS" | |
167 | .IX Header "OPTIONS" | |
168 | .IP "\-d destination_dir" 4 | |
169 | .IX Item "-d destination_dir" | |
170 | Put the resulting \fB.ph\fR files beneath \fBdestination_dir\fR, instead of | |
171 | beneath the default Perl library location (\f(CW$Config{'installsitsearch'}\fR). | |
172 | .IP "\-r" 4 | |
173 | .IX Item "-r" | |
174 | Run recursively; if any of \fBheaderfiles\fR are directories, then run \fIh2ph\fR | |
175 | on all files in those directories (and their subdirectories, etc.). \fB\-r\fR | |
176 | and \fB\-a\fR are mutually exclusive. | |
177 | .IP "\-a" 4 | |
178 | .IX Item "-a" | |
179 | Run automagically; convert \fBheaderfiles\fR, as well as any \fB.h\fR files | |
180 | which they include. This option will search for \fB.h\fR files in all | |
181 | directories which your C compiler ordinarily uses. \fB\-a\fR and \fB\-r\fR are | |
182 | mutually exclusive. | |
183 | .IP "\-l" 4 | |
184 | .IX Item "-l" | |
185 | Symbolic links will be replicated in the destination directory. If \fB\-l\fR | |
186 | is not specified, then links are skipped over. | |
187 | .IP "\-h" 4 | |
188 | .IX Item "-h" | |
189 | Put ``hints'' in the .ph files which will help in locating problems with | |
190 | \&\fIh2ph\fR. In those cases when you \fBrequire\fR a \fB.ph\fR file containing syntax | |
191 | errors, instead of the cryptic | |
192 | .Sp | |
193 | .Vb 1 | |
194 | \& [ some error condition ] at (eval mmm) line nnn | |
195 | .Ve | |
196 | .Sp | |
197 | you will see the slightly more helpful | |
198 | .Sp | |
199 | .Vb 1 | |
200 | \& [ some error condition ] at filename.ph line nnn | |
201 | .Ve | |
202 | .Sp | |
203 | However, the \fB.ph\fR files almost double in size when built using \fB\-h\fR. | |
204 | .IP "\-D" 4 | |
205 | .IX Item "-D" | |
206 | Include the code from the \fB.h\fR file as a comment in the \fB.ph\fR file. | |
207 | This is primarily used for debugging \fIh2ph\fR. | |
208 | .IP "\-Q" 4 | |
209 | .IX Item "-Q" | |
210 | ``Quiet'' mode; don't print out the names of the files being converted. | |
211 | .SH "ENVIRONMENT" | |
212 | .IX Header "ENVIRONMENT" | |
213 | No environment variables are used. | |
214 | .SH "FILES" | |
215 | .IX Header "FILES" | |
216 | .Vb 2 | |
217 | \& /usr/include/*.h | |
218 | \& /usr/include/sys/*.h | |
219 | .Ve | |
220 | .PP | |
221 | etc. | |
222 | .SH "AUTHOR" | |
223 | .IX Header "AUTHOR" | |
224 | Larry Wall | |
225 | .SH "SEE ALSO" | |
226 | .IX Header "SEE ALSO" | |
227 | \&\fIperl\fR\|(1) | |
228 | .SH "DIAGNOSTICS" | |
229 | .IX Header "DIAGNOSTICS" | |
230 | The usual warnings if it can't read or write the files involved. | |
231 | .SH "BUGS" | |
232 | .IX Header "BUGS" | |
233 | Doesn't construct the \f(CW%sizeof\fR array for you. | |
234 | .PP | |
235 | It doesn't handle all C constructs, but it does attempt to isolate | |
236 | definitions inside evals so that you can get at the definitions | |
237 | that it can translate. | |
238 | .PP | |
239 | It's only intended as a rough tool. | |
240 | You may need to dicker with the files produced. | |
241 | .PP | |
242 | You have to run this program by hand; it's not run as part of the Perl | |
243 | installation. | |
244 | .PP | |
245 | Doesn't handle complicated expressions built piecemeal, a la: | |
246 | .PP | |
247 | .Vb 7 | |
248 | \& enum { | |
249 | \& FIRST_VALUE, | |
250 | \& SECOND_VALUE, | |
251 | \& #ifdef ABC | |
252 | \& THIRD_VALUE | |
253 | \& #endif | |
254 | \& }; | |
255 | .Ve | |
256 | .PP | |
257 | Doesn't necessarily locate all of your C compiler's internally-defined | |
258 | symbols. |