Initial commit of OpenSPARC T2 architecture model.

[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / man / man1 / h2ph.1

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "H2PH 1"
.TH H2PH 1 "2007-06-19" "perl v5.8.8" "Perl Programmers Reference Guide"
.SH "NAME"
h2ph \- convert .h C header files to .ph Perl header files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBh2ph [\-d destination directory] [\-r | \-a] [\-l] [headerfiles]\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIh2ph\fR
converts any C header files specified to the corresponding Perl header file
format.
It is most easily run while in /usr/include:
.PP
.Vb 1
\&        cd /usr/include; h2ph * sys/*
.Ve
.PP
or
.PP
.Vb 1
\&        cd /usr/include; h2ph * sys/* arpa/* netinet/*
.Ve
.PP
or
.PP
.Vb 1
\&        cd /usr/include; h2ph -r -l .
.Ve
.PP
The output files are placed in the hierarchy rooted at Perl's
architecture dependent library directory.  You can specify a different
hierarchy with a \fB\-d\fR switch.
.PP
If run with no arguments, filters standard input to standard output.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\-d destination_dir" 4
.IX Item "-d destination_dir"
Put the resulting \fB.ph\fR files beneath \fBdestination_dir\fR, instead of
beneath the default Perl library location (\f(CW$Config{'installsitsearch'}\fR).
.IP "\-r" 4
.IX Item "-r"
Run recursively; if any of \fBheaderfiles\fR are directories, then run \fIh2ph\fR
on all files in those directories (and their subdirectories, etc.).  \fB\-r\fR
and \fB\-a\fR are mutually exclusive.
.IP "\-a" 4
.IX Item "-a"
Run automagically; convert \fBheaderfiles\fR, as well as any \fB.h\fR files
which they include.  This option will search for \fB.h\fR files in all
directories which your C compiler ordinarily uses.  \fB\-a\fR and \fB\-r\fR are
mutually exclusive.
.IP "\-l" 4
.IX Item "-l"
Symbolic links will be replicated in the destination directory.  If \fB\-l\fR
is not specified, then links are skipped over.
.IP "\-h" 4
.IX Item "-h"
Put ``hints'' in the .ph files which will help in locating problems with
\&\fIh2ph\fR.  In those cases when you \fBrequire\fR a \fB.ph\fR file containing syntax
errors, instead of the cryptic
.Sp
.Vb 1
\&        [ some error condition ] at (eval mmm) line nnn
.Ve
.Sp
you will see the slightly more helpful
.Sp
.Vb 1
\&        [ some error condition ] at filename.ph line nnn
.Ve
.Sp
However, the \fB.ph\fR files almost double in size when built using \fB\-h\fR.
.IP "\-D" 4
.IX Item "-D"
Include the code from the \fB.h\fR file as a comment in the \fB.ph\fR file.
This is primarily used for debugging \fIh2ph\fR.
.IP "\-Q" 4
.IX Item "-Q"
``Quiet'' mode; don't print out the names of the files being converted.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
No environment variables are used.
.SH "FILES"
.IX Header "FILES"
.Vb 2
\& /usr/include/*.h
\& /usr/include/sys/*.h
.Ve
.PP
etc.
.SH "AUTHOR"
.IX Header "AUTHOR"
Larry Wall
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1)
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
The usual warnings if it can't read or write the files involved.
.SH "BUGS"
.IX Header "BUGS"
Doesn't construct the \f(CW%sizeof\fR array for you.
.PP
It doesn't handle all C constructs, but it does attempt to isolate
definitions inside evals so that you can get at the definitions
that it can translate.
.PP
It's only intended as a rough tool.
You may need to dicker with the files produced.
.PP
You have to run this program by hand; it's not run as part of the Perl
installation.
.PP
Doesn't handle complicated expressions built piecemeal, a la:
.PP
.Vb 7
\&    enum {
\&        FIRST_VALUE,
\&        SECOND_VALUE,
\&    #ifdef ABC
\&        THIRD_VALUE
\&    #endif
\&    };
.Ve
.PP
Doesn't necessarily locate all of your C compiler's internally-defined
symbols.