summaryrefslogtreecommitdiff
path: root/src/manual
diff options
context:
space:
mode:
authorLukas Rytz <lukas.rytz@epfl.ch>2009-02-09 16:06:06 +0000
committerLukas Rytz <lukas.rytz@epfl.ch>2009-02-09 16:06:06 +0000
commit76009173e08545c346d4a66eb847a75120649ad2 (patch)
treead271feec9a4411bd9e4d67a7d93ee35b32d0bca /src/manual
parent9191eb8dd882e04bee79907bda69d5018ee5ed99 (diff)
downloadscala-76009173e08545c346d4a66eb847a75120649ad2.tar.gz
scala-76009173e08545c346d4a66eb847a75120649ad2.tar.bz2
scala-76009173e08545c346d4a66eb847a75120649ad2.zip
added build scripts for scalap
Diffstat (limited to 'src/manual')
-rw-r--r--src/manual/scala/man1/fsc.scala3
-rw-r--r--src/manual/scala/man1/sbaz.scala3
-rw-r--r--src/manual/scala/man1/scala.scala3
-rw-r--r--src/manual/scala/man1/scalac.scala3
-rw-r--r--src/manual/scala/man1/scaladoc.scala3
-rw-r--r--src/manual/scala/man1/scalap.scala109
-rw-r--r--src/manual/scala/tools/docutil/resources/index.html20
7 files changed, 135 insertions, 9 deletions
diff --git a/src/manual/scala/man1/fsc.scala b/src/manual/scala/man1/fsc.scala
index 22e1c90c4b..a11ef6a936 100644
--- a/src/manual/scala/man1/fsc.scala
+++ b/src/manual/scala/man1/fsc.scala
@@ -142,7 +142,8 @@ object fsc extends Command {
Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " &
Link(Bold("scala") & "(1)", "scala.html") & ", " &
Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
- Link(Bold("scaladoc") & "(1)", "scaladoc.html"))
+ Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " &
+ Link(Bold("scalap") & "(1)", "scalap.html"))
def manpage = new Document {
title = command
diff --git a/src/manual/scala/man1/sbaz.scala b/src/manual/scala/man1/sbaz.scala
index 49a2ab44da..bf53e3803d 100644
--- a/src/manual/scala/man1/sbaz.scala
+++ b/src/manual/scala/man1/sbaz.scala
@@ -182,7 +182,8 @@ object sbaz extends Command {
Link(Bold("fsc") & "(1)", "fsc.html") & ", " &
Link(Bold("scala") & "(1)", "scala.html") & ", " &
Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
- Link(Bold("scaladoc") & "(1)", "scaladoc.html"))
+ Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " &
+ Link(Bold("scalap") & "(1)", "scalap.html"))
def manpage = new Document {
title = command
diff --git a/src/manual/scala/man1/scala.scala b/src/manual/scala/man1/scala.scala
index 949989d06f..084d40a5a7 100644
--- a/src/manual/scala/man1/scala.scala
+++ b/src/manual/scala/man1/scala.scala
@@ -249,7 +249,8 @@ object scala extends Command {
Link(Bold("fsc") & "(1)", "fsc.html") & ", " &
Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " &
Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
- Link(Bold("scaladoc") & "(1)", "scaladoc.html"))
+ Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " &
+ Link(Bold("scalap") & "(1)", "scalap.html"))
def manpage = new Document {
title = command
diff --git a/src/manual/scala/man1/scalac.scala b/src/manual/scala/man1/scalac.scala
index 37815f90f4..af23aa41e8 100644
--- a/src/manual/scala/man1/scalac.scala
+++ b/src/manual/scala/man1/scalac.scala
@@ -351,7 +351,8 @@ object scalac extends Command {
Link(Bold("fsc") & "(1)", "fsc.html") & ", " &
Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " &
Link(Bold("scala") & "(1)", "scala.html") & ", " &
- Link(Bold("scaladoc") & "(1)", "scaladoc.html"))
+ Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " &
+ Link(Bold("scalap") & "(1)", "scalap.html"))
def manpage = new Document {
title = command
diff --git a/src/manual/scala/man1/scaladoc.scala b/src/manual/scala/man1/scaladoc.scala
index 54970e600f..458ee8da37 100644
--- a/src/manual/scala/man1/scaladoc.scala
+++ b/src/manual/scala/man1/scaladoc.scala
@@ -126,7 +126,8 @@ object scaladoc extends Command {
Link(Bold("fsc") & "(1)", "fsc.html") & ", " &
Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " &
Link(Bold("scala") & "(1)", "scala.html") & ", " &
- Link(Bold("scalac") & "(1)", "scalac.html"))
+ Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
+ Link(Bold("scalap") & "(1)", "scalap.html"))
def manpage = new Document {
title = command
diff --git a/src/manual/scala/man1/scalap.scala b/src/manual/scala/man1/scalap.scala
new file mode 100644
index 0000000000..7d780ffdb8
--- /dev/null
+++ b/src/manual/scala/man1/scalap.scala
@@ -0,0 +1,109 @@
+/* NSC -- new Scala compiler
+ * Copyright 2005-2009 LAMP/EPFL
+ * @author Stephane Micheloud
+ */
+//$Id$
+
+package scala.man1
+
+object scalap extends Command {
+ import _root_.scala.tools.docutil.ManPage._
+
+ protected def cn = new Error().getStackTrace()(0).getClassName()
+
+ val name = Section("NAME",
+
+ MBold(command) & " " & NDash & " Scala class file decoder for the " &
+ Link("Scala 2", "http://scala-lang.org/") & " language")
+
+ val synopsis = Section("SYNOPSIS",
+
+ CmdLine(" [ " & Argument("options") & " ] " & Argument("source file")))
+
+ val parameters = Section("PARAMETERS",
+
+ DefinitionList(
+ Definition(
+ Mono(Argument("options")),
+ "Command line options. See " & Link(Bold("OPTIONS"), "#options") &
+ " below."),
+ Definition(
+ Mono(Argument("source file")),
+ "One class file to be decoded (such as " &
+ Mono("hello.HelloWorld") & ").")))
+
+ val description = Section("DESCRIPTION",
+
+ "The " & MBold(command) & " tool reads a class file generated by the" &
+ "Scala compiler, and displays object and class definitions.",
+
+ "By default, " & MBold(command) & " looks for the given class file " &
+ "in the current directory. You can specify a separate classpath with " &
+ CmdOption("classpath") & "(see " & Link(Bold("OPTIONS"), "#options") & ", below).")
+
+ val options = Section("OPTIONS",
+
+ "The decoder has a set of standard options that are supported on the " &
+ "current development environment and will be supported in future releases.",
+
+ Section("Standard Options",
+ DefinitionList(
+ Definition(
+ CmdOption("help"),
+ "Display this usage message."),
+ Definition(
+ CmdOption("private"),
+ "Print private definitions."),
+ Definition(
+ CmdOption("verbose"),
+ "Print out additional information."),
+ Definition(
+ CmdOption("version"),
+ "Print product version and exit."),
+ Definition(
+ CmdOption("cp") & "| " & CmdOption("classpath"),
+ "Specify where to find user class files."))))
+
+ val examples = Section("EXAMPLES",
+
+ DefinitionList(
+ Definition(
+ "Display definitions for a generated class file",
+ CmdLine("hello.HelloWorld"))))
+
+ val exitStatus = Section("EXIT STATUS",
+
+ MBold(command) & " returns a zero exist status if it succeeds to process " &
+ "the specified input files. Non zero is returned in case of failure.")
+
+ override val authors = Section("AUTHOR",
+
+ "Written by Ilya Sergey.")
+
+ val seeAlso = Section("SEE ALSO",
+
+ Link(Bold("fsc") & "(1)", "fsc.html") & ", " &
+ Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " &
+ Link(Bold("scala") & "(1)", "scala.html") & ", " &
+ Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
+ Link(Bold("scaladoc") & "(1)", "scaladoc.html"))
+
+ def manpage = new Document {
+ title = command
+ date = "June 8, 2006"
+ author = "Stephane Micheloud"
+ version = "0.2"
+ sections = List(
+ name,
+ synopsis,
+ parameters,
+ description,
+ options,
+ examples,
+ exitStatus,
+ authors,
+ bugs,
+ copyright,
+ seeAlso)
+ }
+}
diff --git a/src/manual/scala/tools/docutil/resources/index.html b/src/manual/scala/tools/docutil/resources/index.html
index 7808cd96f8..248bb02a81 100644
--- a/src/manual/scala/tools/docutil/resources/index.html
+++ b/src/manual/scala/tools/docutil/resources/index.html
@@ -45,14 +45,15 @@
<ul class="ContentList">
<li>
<a href="#basic"><b class="SansSerif">Basic Tools</b></a> (<code>sbaz</code>,
- <code>fsc</code>, <code>scala</code>, <code>scalac</code>, <code>scaladoc</code>)
+ <code>fsc</code>, <code>scala</code>, <code>scalac</code>, <code>scaladoc</code>,
+ <code>scalap</code>)
</li>
</ul>
</div>
<p style="font-size: 90%; margin-left: 2em; margin-right: 2em;">
<b>NOTE</b> - Some tools have separate reference pages for Windows, Linux and Solaris
- to accommodate minor differences in configuration and usage -- for example, the character
+ to accommodate minor differences in configuration and usage -- for example, the character
used to specify directory separators may be different.
</p>
@@ -86,7 +87,7 @@
</td>
<td>
[<a class="external"
- href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/classpath.html">Solaris and Linux</a>]
+ href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/classpath.html">Solaris and Linux</a>]
[<a class="external"
href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/classpath.html">Windows</a>]
</td>
@@ -98,7 +99,7 @@
</td>
<td>
[<a class="external"
- href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/findingclasses.html">Solaris, Linux and Windows</a>]
+ href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/findingclasses.html">Solaris, Linux and Windows</a>]
</td>
</tr>
</table>
@@ -174,6 +175,17 @@
[<a href="scaladoc.html">Solaris, Linux and Windows</a>]
</td>
</tr>
+ <tr>
+ <td width="13%" valign="top">
+ <span class="tool">scalap</span>
+ </td>
+ <td width="70%" valign="top">
+ The Scala class file decoder.
+ </td>
+ <td width="17%" valign="top">
+ [<a href="scalap.html">Solaris, Linux and Windows</a>]
+ </td>
+ </tr>
</table>
<hr/>