[svn:parrot] r48238 - trunk/compilers/opsc

[allison at svn.parrot.org]

Author: allison
Date: Sat Jul 31 17:34:48 2010
New Revision: 48238
URL: https://trac.parrot.org/parrot/changeset/48238

Log:
[cage] Add a basic readme file, needed for generating a manpage for the executable.

Added:
   trunk/compilers/opsc/README.pod

Added: trunk/compilers/opsc/README.pod
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ trunk/compilers/opsc/README.pod	Sat Jul 31 17:34:48 2010	(r48238)
@@ -0,0 +1,47 @@
+# Copyright (C) 2010, Parrot Foundation.
+# $Id: $
+
+=head1 NAME
+
+opsc - An opcode compiler for Parrot
+
+=head1 DESCRIPTION
+
+Ops-to-C is a compiler to generate opcode definition files in C from
+Parrot's opcode definition language.
+
+=head1 SYNOPSIS
+
+ opsc [-options] <file>
+
+=head1 OPTIONS
+
+=over 4
+
+=item -c, --core
+
+Generate C code for core ops (for use only in building the Parrot VM)
+
+=item -d, --dynamic
+
+Generate C code for dynamic ops in a single file.
+
+=item -q, --quiet
+
+Only report error messages, other messages are silent.
+
+=item -h, --help
+
+Print usage information.
+
+=item -n, --no-lines
+
+Do not print #line directives in generated C code.
+
+=item -g, --debug
+
+Perform all processing but do not write to any files.
+
+=back
+
+=cut