summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authormichelou <michelou@epfl.ch>2006-06-07 16:16:01 +0000
committermichelou <michelou@epfl.ch>2006-06-07 16:16:01 +0000
commitb43c8579008c27782c0fb0945973dbfc2238e4ba (patch)
tree9359734ceb9049b6fd4340888afba19d0a6b2006 /docs
parentdf73352feac0926c9b48749f6a526934757ba772 (diff)
downloadscala-b43c8579008c27782c0fb0945973dbfc2238e4ba.tar.gz
scala-b43c8579008c27782c0fb0945973dbfc2238e4ba.tar.bz2
scala-b43c8579008c27782c0fb0945973dbfc2238e4ba.zip
added man page for scalap
Diffstat (limited to 'docs')
-rw-r--r--docs/man/build.xml1
-rw-r--r--docs/man/src/man/man1/scala.scala1
-rw-r--r--docs/man/src/man/man1/scalac.scala1
-rw-r--r--docs/man/src/man/man1/scaladoc.scala9
-rw-r--r--docs/man/src/man/man1/scalaint.scala1
-rw-r--r--docs/man/src/man/man1/scalap.scala109
-rw-r--r--docs/man/src/man/man1/scalascript.scala3
7 files changed, 120 insertions, 5 deletions
diff --git a/docs/man/build.xml b/docs/man/build.xml
index c079d4e1c5..1b00542a64 100644
--- a/docs/man/build.xml
+++ b/docs/man/build.xml
@@ -51,6 +51,7 @@
<emit command="scalac"/>
<emit command="scaladoc"/>
<emit command="scalaint"/>
+ <emit command="scalap"/>
<emit command="scalascript"/>
<fixcrlf srcdir="${dist.dir}" eol="lf"/>
</target>
diff --git a/docs/man/src/man/man1/scala.scala b/docs/man/src/man/man1/scala.scala
index 29dde567de..281a1d0585 100644
--- a/docs/man/src/man/man1/scala.scala
+++ b/docs/man/src/man/man1/scala.scala
@@ -121,6 +121,7 @@ object scala extends Command {
Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " &
Link(Bold("scalaint") & "(1)", "scalaint.html") & ", " &
+ Link(Bold("scalap") & "(1)", "scalap.html") & ", " &
Link(Bold("scalascript") & "(1)", "scalascript.html"))
def manpage = new Document {
diff --git a/docs/man/src/man/man1/scalac.scala b/docs/man/src/man/man1/scalac.scala
index 21af878758..35d9f04e2a 100644
--- a/docs/man/src/man/man1/scalac.scala
+++ b/docs/man/src/man/man1/scalac.scala
@@ -290,6 +290,7 @@ object scalac extends Command {
Link(Bold("scala") & "(1)", "scala.html") & ", " &
Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " &
Link(Bold("scalaint") & "(1)", "scalaint.html") & ", " &
+ Link(Bold("scalap") & "(1)", "scalap.html") & ", " &
Link(Bold("scalascript") & "(1)", "scalascript.html"))
def manpage = new Document {
diff --git a/docs/man/src/man/man1/scaladoc.scala b/docs/man/src/man/man1/scaladoc.scala
index feb5d3435d..e512f3bdfd 100644
--- a/docs/man/src/man/man1/scaladoc.scala
+++ b/docs/man/src/man/man1/scaladoc.scala
@@ -82,10 +82,11 @@ object scaladoc extends Command {
val seeAlso = Section("SEE ALSO",
- Link("scala(1)", "scala.html") & ", " &
- Link("scalac(1)", "scalac.html") & ", " &
- Link("scalaint(1)", "scalaint.html") & ", " &
- Link("scalascript(1)", "scalascript.html"))
+ Link(Bold("scala") & "(1)", "scala.html") & ", " &
+ Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
+ Link(Bold("scalaint") & "(1)", "scalaint.html") & ", " &
+ Link(Bold("scalap") & "(1)", "scalap.html") & ", " &
+ Link(Bold("scalascript") & "(1)", "scalascript.html"))
def manpage = new Document {
title = command
diff --git a/docs/man/src/man/man1/scalaint.scala b/docs/man/src/man/man1/scalaint.scala
index a22182f47f..8d881934af 100644
--- a/docs/man/src/man/man1/scalaint.scala
+++ b/docs/man/src/man/man1/scalaint.scala
@@ -57,6 +57,7 @@ object scalaint extends Command {
Link(Bold("scala") & "(1)", "scala.html") & ", " &
Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " &
+ Link(Bold("scalap") & "(1)", "scalap.html") & ", " &
Link(Bold("scalascript") & "(1)", "scalascript.html"))
def manpage = new Document {
diff --git a/docs/man/src/man/man1/scalap.scala b/docs/man/src/man/man1/scalap.scala
new file mode 100644
index 0000000000..6da06eb058
--- /dev/null
+++ b/docs/man/src/man/man1/scalap.scala
@@ -0,0 +1,109 @@
+/* NSC -- new Scala compiler
+ * Copyright 2005-2006 LAMP/EPFL
+ * @author Stephane Micheloud
+ */
+//$Id: $
+
+package man.man1
+
+object scalap extends Command {
+ import ManPage._
+
+ protected val cn = new Error().getStackTrace()(0).getClassName()
+
+ val name = Section("NAME",
+
+ MBold(command) & " " & NDash & " Scala class file decoder for the " &
+ Link("Scala 2", "http://scala.epfl.ch/") & " 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 Matthias Zenger.")
+
+ val seeAlso = Section("SEE ALSO",
+
+ Link("scala(1)", "scala.html") & ", " &
+ Link("scalac(1)", "scalac.html") & ", " &
+ Link("scaladoc(1)", "scaladoc.html") & ", " &
+ Link("scalaint(1)", "scalaint.html") & ", " &
+ Link("scalascript(1)", "scalascript.html"))
+
+ def manpage = new Document {
+ title = command
+ date = "April 29, 2005"
+ author = "Stephane Micheloud"
+ version = "0.1"
+ sections = List(
+ name,
+ synopsis,
+ parameters,
+ description,
+ options,
+ examples,
+ exitStatus,
+ authors,
+ bugs,
+ copyright,
+ seeAlso)
+ }
+}
diff --git a/docs/man/src/man/man1/scalascript.scala b/docs/man/src/man/man1/scalascript.scala
index fdb6e141d8..1ab8b1994f 100644
--- a/docs/man/src/man/man1/scalascript.scala
+++ b/docs/man/src/man/man1/scalascript.scala
@@ -79,7 +79,8 @@ object scalascript extends Command {
Link(Bold("scala") & "(1)", "scala.html") & ", " &
Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " &
- Link(Bold("scalaint") & "(1)", "scalaint.html"))
+ Link(Bold("scalaint") & "(1)", "scalaint.html") & ", " &
+ Link(Bold("scalap") & "(1)", "scalap.html"))
def manpage = new Document {
title = command