Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man1 / perlcc.1
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 "PERLCC 1"
132.TH PERLCC 1 "2002-08-28" "perl v5.8.0" "Perl Programmers Reference Guide"
133.SH "NAME"
134perlcc \- generate executables from Perl programs
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 2
138\& $ perlcc hello # Compiles into executable 'a.out'
139\& $ perlcc -o hello hello.pl # Compiles into executable 'hello'
140.Ve
141.PP
142.Vb 2
143\& $ perlcc -O file # Compiles using the optimised C backend
144\& $ perlcc -B file # Compiles using the bytecode backend
145.Ve
146.PP
147.Vb 4
148\& $ perlcc -c file # Creates a C file, 'file.c'
149\& $ perlcc -S -o hello file # Creates a C file, 'file.c',
150\& # then compiles it to executable 'hello'
151\& $ perlcc -c out.c file # Creates a C file, 'out.c' from 'file'
152.Ve
153.PP
154.Vb 2
155\& $ perlcc -e 'print q//' # Compiles a one-liner into 'a.out'
156\& $ perlcc -c -e 'print q//' # Creates a C file 'a.out.c'
157.Ve
158.PP
159.Vb 2
160\& $ perlcc -I /foo hello # extra headers (notice the space after -I)
161\& $ perlcc -L /foo hello # extra libraries (notice the space after -L)
162.Ve
163.PP
164.Vb 3
165\& $ perlcc -r hello # compiles 'hello' into 'a.out', runs 'a.out'.
166\& $ perlcc -r hello a b c # compiles 'hello' into 'a.out', runs 'a.out'.
167\& # with arguments 'a b c'
168.Ve
169.PP
170.Vb 2
171\& $ perlcc hello -log c # compiles 'hello' into 'a.out' logs compile
172\& # log into 'c'.
173.Ve
174.SH "DESCRIPTION"
175.IX Header "DESCRIPTION"
176\&\fIperlcc\fR creates standalone executables from Perl programs, using the
177code generators provided by the B module. At present, you may
178either create executable Perl bytecode, using the \f(CW\*(C`\-B\*(C'\fR option, or
179generate and compile C files using the standard and 'optimised' C
180backends.
181.PP
182The code generated in this way is not guaranteed to work. The whole
183codegen suite (\f(CW\*(C`perlcc\*(C'\fR included) should be considered \fBvery\fR
184experimental. Use for production purposes is strongly discouraged.
185.SH "OPTIONS"
186.IX Header "OPTIONS"
187.IP "\-L\fIlibrary directories\fR" 4
188.IX Item "-Llibrary directories"
189Adds the given directories to the library search path when C code is
190passed to your C compiler.
191.IP "\-I\fIinclude directories\fR" 4
192.IX Item "-Iinclude directories"
193Adds the given directories to the include file search path when C code is
194passed to your C compiler; when using the Perl bytecode option, adds the
195given directories to Perl's include path.
196.IP "\-o \fIoutput file name\fR" 4
197.IX Item "-o output file name"
198Specifies the file name for the final compiled executable.
199.IP "\-c \fIC file name\fR" 4
200.IX Item "-c C file name"
201Create C code only; do not compile to a standalone binary.
202.IP "\-e \fIperl code\fR" 4
203.IX Item "-e perl code"
204Compile a one\-liner, much the same as \f(CW\*(C`perl \-e '...'\*(C'\fR
205.IP "\-S" 4
206.IX Item "-S"
207Do not delete generated C code after compilation.
208.IP "\-B" 4
209.IX Item "-B"
210Use the Perl bytecode code generator.
211.IP "\-O" 4
212.IX Item "-O"
213Use the 'optimised' C code generator. This is more experimental than
214everything else put together, and the code created is not guaranteed to
215compile in finite time and memory, or indeed, at all.
216.IP "\-v" 4
217.IX Item "-v"
218Increase verbosity of output; can be repeated for more verbose output.
219.IP "\-r" 4
220.IX Item "-r"
221Run the resulting compiled script after compiling it.
222.IP "\-log" 4
223.IX Item "-log"
224Log the output of compiling to a file rather than to stdout.