Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Remove the previous 4.5.0 release's documents.

  • Loading branch information...
commit d08f1e1629891e070d6e3932ad7d5940972d1611 1 parent 51a4da0
Reini Urban rurban authored

Showing 454 changed files with 0 additions and 33,360 deletions. Show diff stats Hide diff stats

  1. +0 70 Makefile
  2. +0 24 README.md
  3. +0 230 README.pod
  4. +0 24 binaries/README.pod
  5. +0 54 binaries/ops2c.pod
  6. +0 80 binaries/parrot-nqp.pod
  7. +0 98 binaries/parrot-prove.pod
  8. +0 417 binaries/parrot.pod
  9. +0 36 binaries/parrot_config.pod
  10. +0 73 binaries/parrot_nci_thunk_gen.pod
  11. +0 95 binaries/parrotbug.pod
  12. +0 67 binaries/pbc_to_exe.pod
  13. +0 147 binaries/plumage.pod
  14. +0 40 binaries/winxed.pod
  15. +0 62 book/draft/README.pod
  16. +0 314 book/draft/appa_glossary.pod
  17. +0 138 book/draft/appb_patch_submission.pod
  18. +0 306 book/draft/appc_command_line_options.pod
  19. +0 93 book/draft/appd_build_options.pod
  20. +0 72 book/draft/appe_source_code.pod
  21. +0 215 book/draft/ch01_introduction.pod
  22. +0 182 book/draft/ch02_getting_started.pod
  23. +0 234 book/draft/ch07_dynpmcs.pod
  24. +0 259 book/draft/ch08_dynops.pod
  25. +0 2,915 book/draft/ch10_opcode_reference.pod
  26. +0 210 book/draft/ch11_directive_reference.pod
  27. +0 299 book/draft/ch12_operator_reference.pod
  28. +0 293 book/draft/chXX_hlls.pod
  29. +0 107 book/draft/chXX_library.pod
  30. +0 128 book/draft/chXX_testing_and_debugging.pod
  31. +0 215 book/pct/ch01_introduction.pod
  32. +0 182 book/pct/ch02_getting_started.pod
  33. +0 333 book/pct/ch03_compiler_tools.pod
  34. +0 1,567 book/pct/ch04_pge.pod
  35. +0 221 book/pct/ch05_nqp.pod
  36. +0 113 book/pir/ch01_introduction.pod
  37. +0 78 book/pir/ch02_getting_started.pod
  38. +0 314 book/pir/ch03_basic_syntax.pod
  39. +0 1,834 book/pir/ch04_variables.pod
  40. +0 343 book/pir/ch05_control_structures.pod
  41. +0 1,300 book/pir/ch06_subroutines.pod
  42. +0 497 book/pir/ch07_objects.pod
  43. +0 411 book/pir/ch08_io.pod
  44. +0 397 book/pir/ch09_exceptions.pod
  45. +0 777 compiler_faq.pod
  46. +0 304 configuration.pod
  47. +0 244 debug.pod
  48. +0 399 debugger.pod
  49. +0 231 deprecations/deprecations.pod
  50. +0 75 deprecations/deprecations_2_6.pod
  51. +0 202 deprecations/deprecations_2_9.pod
  52. +0 224 deprecations/deprecations_3_0.pod
  53. +0 30 deprecations/deprecations_3_3.pod
  54. +0 61 deprecations/deprecations_3_6.pod
  55. +0 138 deprecations/how_to_deprecate.pod
  56. +0 158 dev/byteorder.pod
  57. +0 234 dev/c_functions.pod
  58. +0 61 dev/coverage.pod
  59. +0 124 dev/debugging_with_msvc.pod
  60. +0 118 dev/events.pod
  61. +0 42 dev/headerizer.pod
  62. +0 321 dev/infant.pod
  63. +0 66 dev/longopt.pod
  64. +0 181 dev/optimizer.pod
  65. +0 47 dev/parrot_api.pod
  66. +0 138 dev/pcc_methods.pod
  67. +0 113 dev/pcc_state.pod
  68. +0 236 dev/pmc_freeze.pod
  69. +0 251 dev/pmc_obj_design_meeting_notes.pod
  70. +0 130 dev/profiling.pod
  71. +0 1,619 embed.pod
  72. +0 336 embed_new.pod
  73. +0 46 extend.pod
  74. +0 86 faq.pod
  75. +0 203 gettingstarted.pod
  76. +0 321 glossary.pod
  77. +0 76 html/DONORS.pod.html
  78. +0 52 html/book.html
  79. +0 101 html/developer.html
  80. +0 186 html/docs/book/draft/appa_glossary.pod.html
  81. +0 136 html/docs/book/draft/appb_patch_submission.pod.html
  82. +0 161 html/docs/book/draft/appc_command_line_options.pod.html
  83. +0 108 html/docs/book/draft/appd_build_options.pod.html
  84. +0 74 html/docs/book/draft/appe_source_code.pod.html
  85. +0 254 html/docs/book/draft/ch01_introduction.pod.html
  86. +0 158 html/docs/book/draft/ch02_getting_started.pod.html
  87. +0 226 html/docs/book/draft/ch07_dynpmcs.pod.html
  88. +0 248 html/docs/book/draft/ch08_dynops.pod.html
  89. +0 3,274 html/docs/book/draft/ch10_opcode_reference.pod.html
  90. +0 304 html/docs/book/draft/ch11_directive_reference.pod.html
  91. +0 420 html/docs/book/draft/ch12_operator_reference.pod.html
  92. +0 325 html/docs/book/draft/chXX_hlls.pod.html
  93. +0 138 html/docs/book/draft/chXX_library.pod.html
  94. +0 131 html/docs/book/draft/chXX_testing_and_debugging.pod.html
  95. +0 254 html/docs/book/pct/ch01_introduction.pod.html
  96. +0 158 html/docs/book/pct/ch02_getting_started.pod.html
  97. +0 346 html/docs/book/pct/ch03_compiler_tools.pod.html
  98. +0 645 html/docs/book/pct/ch04_pge.pod.html
  99. +0 230 html/docs/book/pct/ch05_nqp.pod.html
  100. +0 160 html/docs/book/pir/ch01_introduction.pod.html
  101. +0 91 html/docs/book/pir/ch02_getting_started.pod.html
  102. +0 220 html/docs/book/pir/ch03_basic_syntax.pod.html
  103. +0 1,182 html/docs/book/pir/ch04_variables.pod.html
  104. +0 306 html/docs/book/pir/ch05_control_structures.pod.html
  105. +0 793 html/docs/book/pir/ch06_subroutines.pod.html
Sorry, we could not display the entire diff because too many files (454) changed.
70 Makefile
... ... @@ -1,70 +0,0 @@
1   -# ex: set ro:
2   -# DO NOT EDIT THIS FILE
3   -# Generated by Parrot::Configure::Compiler from config/gen/makefiles/docs.in
4   -
5   -# Copyright (C) 2001-2010, Parrot Foundation.
6   -
7   -# Setup of some commands
8   -PERL = /usr/bin/perl
9   -CHMOD = $(PERL) -MExtUtils::Command -e chmod
10   -MKPATH = $(PERL) -MExtUtils::Command -e mkpath
11   -TOUCH = $(PERL) -MExtUtils::Command -e touch
12   -RM_F = $(PERL) -MExtUtils::Command -e rm_f
13   -RM_RF = $(PERL) -MExtUtils::Command -e rm_rf
14   -PERLDOC_BIN = /usr/bin/perldoc
15   -VERSION = 4.5.0-devel
16   -
17   -#
18   -# Targets
19   -#
20   -# This is a listing of all targets, that are meant to be called by users
21   -# Most of them are proxied in the root makefile parrot/Makefile
22   -help :
23   - @echo ""
24   - @echo "Following targets are available:"
25   - @echo ""
26   - @echo "help Generate this usage statement."
27   - @echo " This is the default target."
28   - @echo ""
29   - @echo "html Generate html documentation"
30   - @echo "html-clean Remove html documentation"
31   - @echo ""
32   - @echo "htmlhelp: windows only, generate a .chm file."
33   - @echo "htmlhelp-clean: Remove generated .chm"
34   - @echo ""
35   - @echo "pdf: Generate a PDF from the html docs"
36   - @echo "pdf-clean: Remove generated pdf"
37   - @echo ""
38   - @echo " clean: Invoke all clean targets"
39   - @echo ""
40   -
41   -clean: htmlhelp-clean html-clean
42   -
43   -html:
44   - $(PERL) -I../lib ../tools/docs/mk_html_docs.pl --version=$(VERSION)
45   -html-clean:
46   - $(RM_RF) html
47   -
48   -# If you are missing the command 'pdflatex' then you have first to install a
49   -# LaTeX distribution with it. For Windows and UNIX downloads are for example
50   -# available from: http://miktex.org, http://tug.org/texlive or
51   -# http://www.ctan.org
52   -pdf: ../tools/docs/filename_and_chapter.pl
53   - $(MKPATH) build/modified_pod
54   - $(PERL) ../tools/docs/filename_and_chapter.pl
55   - cd build && pdflatex parrot-book.tex && pdflatex parrot-book.tex
56   -
57   -#pdf-release: build/parrot-book.pdf
58   -# cp build/parrot-book.pdf build/parrot-book-$$(date +"%Y.%m").pdf
59   -
60   -pdf-clean:
61   - $(RM_RF) build
62   -
63   -htmlhelp: html
64   -
65   -htmlhelp-clean:
66   -
67   -# Local variables:
68   -# mode: makefile
69   -# End:
70   -# vim: ft=make:
24 README.md
Source Rendered
... ... @@ -1,24 +0,0 @@
1   -## README - Readme for the conversion of 'docs.parrot.org' to github pages.
2   -
3   -# DESCRIPTION
4   -
5   -This README sets out the reason for the relocation of Parrot's documentation,
6   -which ordinarily resides on 'docs.parrot.org', to [Github
7   -pages](http://pages.github.com). The basic idea is to make editing of the
8   -documentation more readily accessible. That is, with these pages now up on
9   -github, folks can more easily fix or, alternatively, provide pull requests to
10   -correct any errors in the documentation.
11   -
12   -So, everyone, feel free to contribute!
13   -
14   -# NOTE
15   -
16   -As a rule, the Parrot team does not use the markdown format in Parrot's
17   -repositories. We use pod. We have made an exception in this instance because
18   -of a conflict between our 'README.pod' file and the contents of this readme,
19   -and because github renders markdown before all other formats. This allows
20   -us to display this page, rather than the contents of 'README.pod'.
21   -
22   -# COPYRIGHT
23   -
24   -Copyright (C) 2011-2012, Parrot Foundation.
230 README.pod
Source Rendered
... ... @@ -1,230 +0,0 @@
1   -# Copyright (C) 2001-2012, Parrot Foundation.
2   -
3   -=pod
4   -
5   -=head1 NAME
6   -
7   -docs/README.pod - Readme file for the 'docs/' directory.
8   -
9   -=head1 DESCRIPTION
10   -
11   -This README sets out the documents and directories in the 'docs/' top-level
12   -directory.[1]
13   -
14   -=head2 Documentation
15   -
16   -=over 4
17   -
18   -=item F<binaries/>
19   -
20   -The pod files for Parrot's installable executables.
21   -
22   -=item F<book/>
23   -
24   -The pod files for the "PCT Book," the "PIR Book," and a draft of the "Parrot
25   -Developer's Guide: PIR Book".
26   -
27   -=item F<compiler_faq.pod>
28   -
29   -A Parrot FAQ for compiler writers in PIR.[2]
30   -
31   -=item F<configuration.pod>
32   -
33   -A document on Parrot's Configuration System.
34   -
35   -=item F<debugger.pod>
36   -
37   -Documentation for C<parrot_debugger>, the Parrot debugger.
38   -
39   -=item F<debug.pod>
40   -
41   -A beginner's guide to debugging the Parrot executable.
42   -
43   -=item F<deprecations/>
44   -
45   -Documentation on Parrot's deprecation policy and documents on various Parrot
46   -deprecations.
47   -
48   -=item F<dev/>
49   -
50   -This subdirectory contains a number of files discussing various implementation
51   -decisions made during the course of the development of Parrot. The intent is
52   -to keep discussion of implementation-specific issues separate from the basic
53   -design issues discussed in the PDDs.
54   -
55   -=item F<embed_new.pod>
56   -
57   -An overview of Parrot's embedding system.
58   -
59   -=item F<embed.pod>
60   -
61   -Describes the embedding subsystem in excruciating detail.
62   -
63   -=item F<extend.pod>
64   -
65   -A (mostly empty) description of Parrot's extension system.
66   -
67   -=item F<faq.pod>
68   -
69   -The Parrot FAQ.
70   -
71   -=item F<gettingstarted.pod>
72   -
73   -The Parrot Developer FAQ.[3]
74   -
75   -=item F<glossary.pod>
76   -
77   -A guide to some of the jargon which crops up repeatedly in Parrot development
78   -and throughout the documentation.
79   -
80   -=item F<html/>
81   -
82   -This subdirectory contains an html version of Parrot's Documentation Set.
83   -
84   -=item F<imcc/>
85   -
86   -This subdirectory contains documentation on Parrot's Intermediate Code
87   -Compiler (IMCC).
88   -
89   -=item F<index/>
90   -
91   -This subdirectory contains the json formatted files with which to generate
92   -Parrot's html Documentation Set.
93   -
94   -=item F<intro.pod>
95   -
96   -An introductory article on what Parrot is and how to do some interesting
97   -things with it.
98   -
99   -=item F<memory_internals.pod>
100   -
101   -An introduction to the Parrot GC subsystem
102   -
103   -=item F<multidispatch.pod>
104   -
105   -An (outdated document) on Parrot's multimethod dispatch for binary opcode
106   -functions.
107   -
108   -=item F<optable.pod>
109   -
110   -An ALPHA pod, describing the PGE operator precedence table and parser.
111   -
112   -=item F<overview.pod>
113   -
114   -An overview of Parrot's architecture and design.
115   -
116   -=item F<parrotbyte.pod>
117   -
118   -The Parrot bytecode format.
119   -
120   -=item F<parrothist.pod>
121   -
122   -A document which records Parrot source code releases, and their release
123   -managers.
124   -
125   -=item F<parrot.pod>
126   -
127   -A general document for the uninitiated which points to several "good starting
128   -points" throughout Parrot's Documentation Set.
129   -
130   -=item F<pct/>
131   -
132   -This subdirectory contains documentation on the Parrot Compiler Toolkit.
133   -
134   -=item F<pdds/>
135   -
136   -This subdirectory contains all of the current Parrot Design Documents (PDDs).
137   -PDDs are detailed guides to the design of the various Parrot subsystems,
138   -I<e.g.,> F<pdd03_calling_conventions.pod> specifies Parrot's inter-routine
139   -calling conventions.
140   -
141   -=item F<pmc/>
142   -
143   -This subdirectory contains documentation on several of the PMC types available
144   -to Parrot.
145   -
146   -
147   -=item F<pmc2c.pod>
148   -
149   -A document on the F<tools/build/pmc2c.pl> and how to use the tool to generate
150   -C code files from PMC definition files.
151   -
152   -=item F<pmc.pod>
153   -
154   -A general overview of PMC.
155   -
156   -=item F<porting_intro.pod>
157   -
158   -"This document is an introduction to porting the optional subsystems of Parrot
159   -onto a new architecture once the core successfully builds."
160   -
161   -=item F<project/>
162   -
163   -This subdirectory contains documentation important to Parrot Developers and
164   -administrators, I<e.g.,> F<docs/projects/release_manager_guide.pod>.
165   -
166   -=item F<req/>
167   -
168   -This subdirectory contains a document on "Model Users For Parrot Design
169   -Decisions."[4]
170   -
171   -=item F<resources/>
172   -
173   -This subdirectory contains various "resource" files, I<e.g.,>
174   -F<parrot_logo.png>, F<parrot.css>, etc.
175   -
176   -=item F<running.pod>
177   -
178   -Brief descriptions of the different executables and how to run them.
179   -
180   -=item F<stability.pod>
181   -
182   -"This document classifies Parrot components and interfaces based on their
183   -stability."
184   -
185   -=item F<submissions.pod>
186   -
187   -This is a document on "[h]ow to submit bug reports, patches and new files to
188   -Parrot."
189   -
190   -=item F<tests.pod>
191   -
192   -Hints on writing tests for the Parrot interpreter.
193   -
194   -=item F<translations/>
195   -
196   -This subdirectory contains multiple translations of Parrot's plaintext
197   -'README', I<e.g.,> F<README.deutsch>, F<README.espanol>, etc.
198   -
199   -=item F<user/>
200   -
201   -This subdirectory contains various documents of general interest to users,
202   -wanting to target Parrot.
203   -
204   -=item F<vtables.pod>
205   -
206   -A brief introduction to the vtable at the heart of all PMCs, and how to
207   -implement your own PMC type.
208   -
209   -=back
210   -
211   -=head1 NOTES
212   -
213   -[1] The contents of this 'README.pod' are, at present, tentative and,
214   -therefore, are subject to change.
215   -
216   -[2] We should change the name of this FAQ to better conform with the purpose
217   -of the FAQ. F<compiler_faq.pod> is far too ambiguous to be helpful.
218   -
219   -[3] We should change the name of this FAQ to better conform with the purpose
220   -of the FAQ. F<getttingstarted.pod> is far too general and implies something
221   -other than the Parrot Developer FAQ.
222   -
223   -[4] Is there any reason to retain this document? It seems, ten years later,
224   -more of a curiousity than an actual guide.
225   -
226   -=head1 COPYRIGHT
227   -
228   -Copyright (C) 2012, Parrot Foundation.
229   -
230   -=cut
24 binaries/README.pod
Source Rendered
... ... @@ -1,24 +0,0 @@
1   -# Copyright (C) 2001-2012, Parrot Foundation.
2   -
3   -=pod
4   -
5   -=head1 NAME
6   -
7   -docs/binaries/README.pod - Readme file for the 'docs/binaries/' directory.
8   -
9   -=head1 DESCRIPTION
10   -
11   -This directory contains the *.pod files to the installable binaries in the
12   -Parrot distribution. These files are also (or soon will be) used to generate
13   -*roff pages.[1]
14   -
15   -=head1 NOTES
16   -
17   -[1] The probable location and name of the conversion script will be,
18   -F<tools/docs/mk_pod2man.pl>
19   -
20   -=head1 COPYRIGHT
21   -
22   -Copyright (C) 2012, Parrot Foundation.
23   -
24   -=cut
54 binaries/ops2c.pod
Source Rendered
... ... @@ -1,54 +0,0 @@
1   -# Copyright (C) 2011, Parrot Foundation.
2   -
3   -=head1 NAME
4   -
5   -ops2c - Convert Parrot opcodes to C
6   -
7   -=head1 SYNOPSIS
8   -
9   -ops2c [option]
10   -
11   -=head1 DESCRIPTION
12   -
13   -Translate Parrot opcode files (.ops) to C files.
14   -
15   -=head2 Command line Options
16   -
17   -For help, use :
18   -
19   - -h
20   - --help
21   -
22   -To generate the C code for core ops (must be run from within Parrot's build directory), use :
23   -
24   - -c
25   - --core
26   -
27   -To generate the C code for dynamic ops in a single .ops file, use :
28   -
29   - -d <file.ops>
30   - --dynamic <file.ops>
31   -
32   -To suppress error messages, use :
33   -
34   - -q
35   - --quiet
36   -
37   -To suppress #line directives in generated C code (line numbers are not currently supported), use :
38   -
39   - -n
40   - --no-lines
41   -
42   -For debugging option :
43   -To perform all processing without writing to any files, use :
44   -
45   - -g
46   - --debug
47   -
48   -=head1 HELP
49   -
50   -For more help or any other question you go to L<http://parrot.org> or
51   -L<http://github.com/parrot/parrot>.Or you can send email to 'parrot-dev@parrot.org'.
52   -You are also invited to join the #parrot IRC channel on irc.parrot.org.
53   -
54   -=cut
80 binaries/parrot-nqp.pod
Source Rendered
... ... @@ -1,80 +0,0 @@
1   -# Copyright (C) 2001-2011, Parrot Foundation.
2   -
3   -=head1 NAME
4   -
5   -parrot-nqp - Not Quite Perl (6)
6   -
7   -=head1 SYNOPSIS
8   -
9   -parrot-nqp <file>
10   -
11   -=head1 DESCRIPTION
12   -
13   -This is "Not Quite Perl (6)" -- a High Level Language (HLL) which allows one to
14   -write Perl6-like code. The key feature of NQP is that it's designed to be an
15   -easy-to-parse subset of Perl 6. It is geared towards being a high-level way to
16   -create transformers for Parrot (especially HLL compilers). It is based on
17   -PCT::HLLCompiler.
18   -
19   -NQP is used as a bootstrapping language in for Rakudo, and hence developed
20   -outside of the main Parrot git repository. It is occasionally snapshotted into
21   -the main Parrot codebase so it can be bundled with Parrot releases and be used
22   -by core Parrot developers as well as HLL developers.
23   -
24   -=head2 Command Line Usage
25   -
26   -For help use :
27   -
28   - -h
29   - --help
30   -
31   -To show version use :
32   -
33   - -v
34   - --version
35   -
36   -To display the parse tree for regular expression use :
37   -
38   - --target=parse
39   -
40   -To dispaly the PIR subroutine gererated to match the regular expression use :
41   -
42   - --target=pir
43   -
44   -For dumper use :
45   -
46   - --dumper=s
47   -
48   -To trace use :
49   -
50   - -t=s
51   - --trace=s
52   -
53   -For encoding use :
54   -
55   - --encoding=s
56   -
57   -To combine use :
58   -
59   - --combine
60   -
61   -For stage stats use :
62   -
63   - --stagestats
64   -
65   -For backtrace use :
66   -
67   - --ll-backtrace
68   -
69   -For output use :
70   -
71   - -o=s
72   - --output=s
73   -
74   -=head1 HELP
75   -
76   -For more help or any other question you go to L<http://parrot.org> or
77   -L<http://github.com/parrot/parrot>.Or you can send email to 'parrot-dev@parrot.org'.
78   -You are also invited to join the #parrot IRC channel on irc.parrot.org.
79   -
80   -=cut
98 binaries/parrot-prove.pod
Source Rendered
... ... @@ -1,98 +0,0 @@
1   -# Copyright (C) 2001-2011, Parrot Foundation.
2   -
3   -=head1 NAME
4   -
5   -parrot-prove - Prove is a PIR-based TAP (Test Anything Protocol) Harness
6   -
7   -=head1 SYNOPSIS
8   -
9   -parrot-prove [option] [files]
10   -
11   -=head1 DESCRIPTION
12   -
13   -It eats test output (i.e. is a TAP consumer) and tells humans if the
14   -test suite passed, and if not, which kind of pretty colors of smoke
15   -came out. It is mostly equivalent to 'prove' from Perl 5.
16   -
17   -=head2 Command line boolean options
18   -
19   -To print all test lines use :
20   -
21   - -v
22   - --verbose
23   -
24   -To run the tests in random order use :
25   -
26   - -s
27   - --shuffle
28   -
29   -To show failed tests use :
30   -
31   - -f
32   - --failures
33   -
34   -To show comments use :
35   -
36   - -o
37   - --comments
38   -
39   -To ignore exit status from test scripts use :
40   -
41   - --ignore-exit
42   -
43   -To merge test scripts STDERR with their STDOUT use :
44   -
45   - -m
46   - --merge
47   -
48   -To run tests in reverse order use :
49   -
50   - --reverse
51   -
52   -To suppress some test output while running tests use :
53   -
54   - -q
55   - --quiet
56   -
57   -To print only summary result use :
58   -
59   - -Q
60   - --QUIET
61   -
62   -To show only results with TODO or SKIP directives use :
63   -
64   - --directives
65   -
66   -To normalize TAP output in verbose output use :
67   -
68   - --normalize
69   -
70   -To display help use :
71   -
72   - -h
73   - --help
74   -
75   -To display version use :
76   -
77   - -v
78   - --version
79   -
80   -=head2 Command line options that take arguments
81   -
82   -To interpreter to run the tests (' ' for compiled tests.) use :
83   -
84   - -e
85   - --exec
86   -
87   -To store the resulting TAP in an archive file use :
88   -
89   - -a
90   - --archive
91   -
92   -=head1 HELP
93   -
94   -For more help or any other question you go to L<http://parrot.org> or
95   -L<http://github.com/parrot/parrot>.Or you can send email to 'parrot-dev@parrot.org'.
96   -You are also invited to join the #parrot IRC channel on irc.parrot.org.
97   -
98   -=cut
417 binaries/parrot.pod
Source Rendered
... ... @@ -1,417 +0,0 @@
1   -# Copyright (C) 2011, Parrot Foundation.
2   -
3   -=pod
4   -
5   -=head1 NAME
6   -
7   -parrot - Parrot Virtual Machine
8   -
9   -=head1 SYNOPSIS
10   -
11   -B<parrot> [-options] <file> [arguments ...]
12   -
13   -=head1 DESCRIPTION
14   -
15   -Parrot is a virtual machine designed to efficiently compile and execute
16   -bytecode for dynamic languages. Parrot currently hosts a variety of language
17   -implementations in various stages of completion, including Tcl, Javascript,
18   -Ruby, Lua, Scheme, PHP, Python, Perl 6, APL, and a .NET bytecode translator.
19   -Parrot is not about parrots, but we are rather fond of them, for obvious
20   -reasons.
21   -
22   -=head1 OPTIONS
23   -
24   -=over 4
25   -
26   -=item B<-h>
27   -
28   -=item B<--help> Print the option summary on the command line.
29   -
30   -=item
31   -
32   -=item B<-V>
33   -
34   -=item B<--version> Print version information and exit.
35   -
36   -=item
37   -
38   -=item B<-I>
39   -
40   -=item B<--include> Add C<path> to the include search path.
41   -
42   -=item
43   -
44   -=item B<-L>
45   -
46   -=item B<--library> Add C<path> to the library search path.
47   -
48   -=item
49   -
50   -=item B<--hash-seed> [hexnum]
51   -
52   -=over 11
53   -
54   -Sets the hash seed to the specified value. This option is useful for debugging intermittent
55   -failures, but should I<not> be used in production. For more information about this option,
56   -I<see> F<docs/dev/profiling.pod>, F<docs/project/hacking_tips.pod>, F<docs/running.pod>,
57   -and F<docs/submissions.pod>.
58   -
59   -=back
60   -
61   -=item B<-X>
62   -
63   -=item B<--dynext> Add C<path> to the dynamic extension search path.
64   -
65   -=back
66   -
67   -=head2 Run core options
68   -
69   -These options select the runcore, which is useful for performance tuning and debugging. For more
70   -information about these options, I<see> the "About runcores" section in F<docs/running.pod>.
71   -
72   -=over 4
73   -
74   -=item B<-R>
75   -
76   -=item B<--runcore> [CORE]
77   -
78   -=over 11
79   -
80   -Select the runcore. The following cores are available in Parrot, but not all
81   -may be available on your system:
82   -
83   - slow, bounds bounds checking core (default)
84   -
85   - fast bare-bones core without bounds-checking or
86   - context-updating
87   -
88   - subprof subroutine-level profiler
89   - (see POD in 'src/runcore/subprof.c')
90   -
91   - trace bounds checking core with trace info
92   - (see 'parrot --help-debug')
93   -
94   - profiling see 'docs/dev/profilling.pod'
95   -
96   - gcdebug performs a full GC run before every op dispatch
97   - (good for debugging GC problems)
98   -
99   -=back
100   -
101   -=item B<-p>
102   -
103   -=item B<--profile> Run with the slow core and print an execution profile.
104   -
105   -=item
106   -
107   -=item B<-t>
108   -
109   -=item B<--trace> Run with the slow core and print trace information to B<stderr>.
110   -
111   -=over 11
112   -
113   -I<See> C<parrot --help-debug> for available flag bits.
114   -
115   -=back
116   -
117   -=back
118   -
119   -=head2 VM options
120   -
121   -=over 4
122   -
123   -=item B<-D>
124   -
125   -=item B<--parrot-debug>[=HEXFLAGS]
126   -
127   -=over 11
128   -
129   -Turn on interpreter debug flag. I<See> C<parrot --help-debug> for available flag bits.
130   -
131   -=back
132   -
133   -=item B<--help-debug> Print the summary of debugging and tracing flag bits.
134   -
135   -=item
136   -
137   -=item B<-w>
138   -
139   -=item B<--warnings> Turn on warnings.
140   -
141   -=over 11
142   -
143   -I<See> C<parrot --help-debug> for available flag bits.
144   -
145   -=back
146   -
147   -=item B<-G>
148   -
149   -=item B<--no-gc> Turn off GC.
150   -
151   -=over 11
152   -
153   -This may prove useful for finding GC-related bugs.
154   -
155   -=back
156   -
157   -=over 11
158   -
159   -=item Note:
160   -
161   -Do not use this option for longer running programs: since memory is no longer recycled, it may
162   -quickly become exhausted.
163   -
164   -=back
165   -
166   -=item B<-g>
167   -
168   -=item B<--gc> [GC-type]
169   -
170   -=back
171   -
172   -=head3 GC MS2 options
173   -
174   -=over 4
175   -
176   -=item B<--gc-dynamic-threshold>=percentage
177   -
178   -=over 11
179   -
180   -Maximum memory wasted by GC
181   -
182   -=back
183   -
184   -=item B<--gc-min-threshold>=Kb
185   -
186   -=back
187   -
188   -=head3 GC GMS options
189   -
190   -=over 4
191   -
192   -=item B<--gc-nursery-size>=percent of system
193   -
194   -=over 11
195   -
196   -Size of gen0 (default 2)
197   -
198   -=back
199   -
200   -=item B<--gc-debug> Turn on GC (Garbage Collection) debugging.
201   -
202   -=over 11
203   -
204   -This imposes some stress on the GC subsystem and can considerably slow
205   -down execution.
206   -
207   -=back
208   -
209   -=item B<--leak-test|--destroy-at-end>
210   -
211   -=over 11
212   -
213   -Free all memory of the last interpreter. This is useful when running leak
214   -checkers.
215   -
216   -=back
217   -
218   -=item B<-.>
219   -
220   -=item B<--wait> Read a keystroke before starting.
221   -
222   -=over 11
223   -
224   -This is useful when you want to attach a debugger on platforms such as Windows.
225   -
226   -=back
227   -
228   -=item B<--runtime-prefix>
229   -
230   -=over 11
231   -
232   -Print the runtime prefix path and exit.
233   -
234   -=back
235   -
236   -=back
237   -
238   -=head2 Compiler options
239   -
240   -=over 4
241   -
242   -=item B<-d>
243   -
244   -=item B<--imcc-debug>=[HEXFLAGS]
245   -
246   -=over 11
247   -
248   -The B<-d> switch takes an optional argument, consisting of a hexadecimal value
249   -of debug bits. If no value is supplied, 'debug' is set to 1.
250   -
251   -To list the individual bits on the command line, use the B<--help-debug> switch.
252   -
253   -To produce a vary large output on F<stderr>, run C<"parrot B<-d 0ffff> ...">.
254   -
255   -=back
256   -
257   -=item B<-v>
258   -
259   -=item B<--verbose> One C<-v> shows which files are worked on and prints
260   -
261   -=over 11
262   -
263   -a summary over register usage and optimization stats per I<subroutine>. With
264   -two C<-v> switches, C<parrot> prints a line per individual processing step too.
265   -
266   -=back
267   -
268   -=item B<-E>
269   -
270   -=item B<--pre-process-only>
271   -
272   -=over 11
273   -
274   -Preprocess source file (expand macros) and print result to C<stdout>:
275   -
276   - $> parrot -E t/op/macro_10.pasm
277   - $> parrot -E t/op/macro_10.pasm | parrot -- -
278   -
279   -=back
280   -
281   -=item B<-o>
282   -
283   -=item B<--output>=FILE Act like an assembler, but do not execute the code,
284   -
285   -=over 11
286   -
287   -unless the B<-r> is supplied as well. If 'outputfile' ends with F<.pbc>,
288   -'parrot' will write a PBC file. If it ends with F<.pasm>, 'parrot' will output
289   -a PASM file, even from PASM input. This can be useful when needing to check
290   -various optimizations, including C<-Op>.
291   -
292   -=back
293   -
294   -=item B<--output-pbc> Act like an assembler, but always output bytecode,
295   -
296   -=over 11
297   -
298   -even if the output file does not end in F<.pbc>
299   -
300   -=back
301   -
302   -=item B<-O>
303   -
304   -=item B<--optimize>[=LEVEL]
305   -
306   -=over 11
307   -
308   -Optimization levels
309   -
310   - -O0 no optimization (default)
311   - -O1 optimizations without life info (e.g. branches)
312   - -O same
313   - -O2 optimizations with life info
314   - -Op rewrite I and N PASM registers most used first
315   - -Ot select fastest runcore
316   - -Oc turns on the optional/experimental tail call optimizations
317   -
318   -I<See> F<docs/dev/optimizer.pod> for more information on the optimizer.
319   -
320   -=back
321   -
322   -=over 11
323   -
324   -=item Note:
325   -
326   -Optimization is currently an experimental feature and these options are likely to change.
327   -
328   -=back
329   -
330   -=item B<-a>
331   -
332   -=item B<--pasm> Assume PASM input on C<stdin>.
333   -
334   -=item B<-c>
335   -
336   -=item B<--pbc> Assume PBC file on C<stdin> and execute it.
337   -
338   -=over 11
339   -
340   -NOTE: If whitespace separates the B<-d> switch from the argument, the argument
341   -I<must> start with a number, I<i.e.>, a decimal digit.
342   -
343   -=back
344   -
345   -=item B<-r>
346   -
347   -=item B<--run-pbc> Only useful after C<-o> or C<--output-pbc>.
348   -
349   -=over 11
350   -
351   -Execute the program from the compiled in-memory image. If two C<-r> options are
352   -supplied, the F<.pbc> file is read from disc and executed. This is needed,
353   -primarily, for tests.
354   -
355   -=back
356   -
357   -=item B<-y>
358   -
359   -=item B<--yydebug> Turn on yydebug in F<yacc>/F<bison>.
360   -
361   -=back
362   -
363   -=head2 <file>
364   -
365   -If the file ends in F<.pbc> it will be interpreted immediately.
366   -
367   -If the file ends in F<.pasm>, then it is parsed as PASM code. Otherwise, it is
368   -parsed as PIR code. In both cases, it will then be executed, unless the C<-o>
369   -flag was supplied.
370   -
371   -If the C<file> is a single dash, input from C<stdin> is read.
372   -
373   -=head2 [arguments ...]
374   -
375   -Optional arguments passed to the running program as ARGV. The program is
376   -assumed to know what to do with the arguments.
377   -
378   -=head1 ENVIRONMENT
379   -
380   -=over 4
381   -
382   -=item PARROT_RUNTIME
383   -
384   -If this environment variable is set, parrot will use this path as its runtime
385   -prefix instead of the compiled-in path. This is useful if you want to execute
386   -a version of parrot different from the one on the "compiled-in" path.
387   -
388   -=item PARROT_GC_DEBUG
389   -
390   -Turn on the I<--gc-debug> flag.
391   -
392   -=back
393   -
394   -=head1 SEE ALSO
395   -
396   -'docs/running.pod' Additional information on command line options.
397   -
398   -http://www.parrot.org/ The official Parrot web site.
399   -
400   -http://docs.parrot.org/ Parrot's official documentation site.
401   -
402   -http://parrot.github.com/ An alternative documentation site.
403   -
404   -=head1 REPORTING BUGS
405   -
406   -For information on how to submit a bug report, I<see> F<docs/submissions.pod>.
407   -
408   -=head1 AUTHORS
409   -
410   -Parrot is a product of the contributions of a great many people. For a list of
411   -most of these people, I<see> F<CREDITS>.
412   -
413   -=head1 COPYRIGHT
414   -
415   -Copyright (C) 2001-2011, Parrot Foundation.
416   -
417   -=cut
36 binaries/parrot_config.pod
Source Rendered
... ... @@ -1,36 +0,0 @@
1   -# Copyright (C) 2011 Parrot Foundation.
2   -
3   -=head1 Name
4   -
5   -parrot_config - Parrot Configuration
6   -
7   -=head1 DESCRIPTION
8   -
9   -parrot_config can be used find out compile-time configuration information about
10   -the Parrot executable.
11   -
12   -=head1 SYNOPSIS
13   -
14   -To print every available key:
15   -
16   - parrot_config --dump
17   -
18   -With specific key it will print only it's corresponding value.
19   -
20   -To get the current version of Parrot:
21   -
22   - parrot_config VERSION
23   -
24   -To get a descriptive version string that will uniquely identify
25   -commits which are not releases:
26   -
27   - parrot_config git_describe
28   -
29   -=head1 Help
30   -
31   -For more help or any other question you go to L<http://parrot.org> or
32   -L<http://github.com/parrot/parrot>.Or you can send email to
33   -'parrot-dev@parrot.org'. You can also join Parrot IRC channel: #parrot
34   -on irc.parrot.org .
35   -
36   -=cut
73 binaries/parrot_nci_thunk_gen.pod
Source Rendered
... ... @@ -1,73 +0,0 @@
1   -# Copyright (C) 2001-2011, Parrot Foundation.
2   -
3   -=head1 NAME
4   -
5   -parrot_nci_thunk_gen - Create Parrot NCI thunks
6   -
7   -=head1 SYNOPSIS
8   -
9   - parrot_nci_thunk_gen [option] -o output_c_file.c < input_signature_list.nci
10   -
11   -=head1 DESCRIPTION
12   -
13   -This utility creates C file of routines suitable for use as Parrot Native Call Interface thunks.
14   -
15   -=head2 Command line Options
16   -
17   -To print help message and exit use :
18   -
19   - --help
20   -
21   -To print version number of this utility use :
22   -
23   - --version
24   -
25   -Not to complain about duplicated signatures (default is to warn) use :
26   -
27   - -f
28   - --no-warn-dups
29   -
30   -To output a thunk file suitable for inclusion in Parrot core (default is no) use :
31   -
32   - --core
33   -
34   -To use default values for loader-name, loader-storage-class, and target suitable
35   -for use in Parrot dyntex library use :
36   -
37   - --dyntex
38   -
39   -To specify output file use :
40   -
41   - -o
42   - --output <file>
43   -
44   -To select what to output (valid operation are 'head', 'thunks', 'loader',
45   -'loader-dyntex', 'coda', 'all', 'all-dyntex', 'names' and 'signatures')
46   -(default is 'all') use :
47   -
48   - --target <target>
49   -
50   -To set storage class used for the thunks (default value is static) use :
51   -
52   - --thunk-storage-class <storage class>
53   -
54   -To set the prototype used for the thunk function names.Must be a printf
55   -format with arity 1 (default value is 'pcf_%s') use :
56   -
57   - --thunk-name-proto <printf prototype>
58   -
59   -To set the storage class used for the loader funtion (default value is none) use :
60   -
61   - --loader-storage-class
62   -
63   -To set the name used for the leader function (default value is 'Parrot_load_nci_thunks') use :
64   -
65   - --loader-name
66   -
67   -=head1 HELP
68   -
69   -For more help or any other question you go to L<http://parrot.org> or
70   -L<http://github.com/parrot/parrot>.Or you can send email to 'parrot-dev@parrot.org'.
71   -You are also invited to join the #parrot IRC channel on irc.parrot.org.
72   -
73   -=cut
95 binaries/parrotbug.pod
Source Rendered
... ... @@ -1,95 +0,0 @@
1   -# Copyright (C) 2001-2011, Parrot Foundation.
2   -
3   -=head1 NAME
4   -
5   -parrotbug.pod - Parrot bug report
6   -
7   -=head1 SYNOPSIS
8   -
9   -parrotbug [option] [action]
10   -
11   -=head1 DESCRIPTION
12   -
13   -A program to help generate bug reports about parrot, and mail them.
14   -It is designed to be used interactively. Normally no arguments will
15   -be needed.
16   -
17   -=head2 Command line Options
18   -
19   -To report successful build on this system to parrot developers use :