summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormichelou <michelou@epfl.ch>2006-07-11 15:18:11 +0000
committermichelou <michelou@epfl.ch>2006-07-11 15:18:11 +0000
commit087920b5e307cfdbf4a0cf4b3ff8dd45db43ae36 (patch)
treefd5e6f0d762c162f4d038718fab26f91eae64ae3
parente6ef9af62f44bf4df35907847723a9e57e092212 (diff)
downloadscala-087920b5e307cfdbf4a0cf4b3ff8dd45db43ae36.tar.gz
scala-087920b5e307cfdbf4a0cf4b3ff8dd45db43ae36.tar.bz2
scala-087920b5e307cfdbf4a0cf4b3ff8dd45db43ae36.zip
added fsc to the man pages
-rw-r--r--build.xml1
-rw-r--r--src/manual/scala/man1/fsc.scala114
-rw-r--r--src/manual/scala/man1/scala.scala3
-rw-r--r--src/manual/scala/man1/scalac.scala1
-rw-r--r--src/manual/scala/man1/scaladoc.scala1
-rw-r--r--src/manual/scala/man1/scalap.scala1
-rw-r--r--src/manual/scala/tools/docutil/resources/index.html15
7 files changed, 132 insertions, 4 deletions
diff --git a/build.xml b/build.xml
index 42a7496192..34a067945d 100644
--- a/build.xml
+++ b/build.xml
@@ -703,6 +703,7 @@ DOCUMENTATION
classpathref="manual.classpath">
<include name="**/*.scala"/>
</quick>
+ <emit command="fsc"/>
<emit command="sbaz"/>
<emit command="scala"/>
<emit command="scalac"/>
diff --git a/src/manual/scala/man1/fsc.scala b/src/manual/scala/man1/fsc.scala
new file mode 100644
index 0000000000..ac03ecc4db
--- /dev/null
+++ b/src/manual/scala/man1/fsc.scala
@@ -0,0 +1,114 @@
+/* NSC -- new Scala compiler
+ * Copyright 2005-2006 LAMP/EPFL
+ * @author Stephane Micheloud
+ */
+//$Id: $
+
+package scala.man1
+
+object fsc extends Command {
+ import _root_.scala.tools.docutil.ManPage._
+
+ protected def cn = new Error().getStackTrace()(0).getClassName()
+
+ val name = Section("NAME",
+
+ MBold(command) & " " & NDash & " Offline compiler for the " &
+ Link("Scala 2", "http://scala.epfl.ch/") & " language")
+
+ val synopsis = Section("SYNOPSIS",
+
+ CmdLine(" [ " & Argument("options") & " ] " &
+ Argument("source files")))
+
+ val parameters = scalac.parameters
+
+ val description = Section("DESCRIPTION",
+
+ "The " & MBold(command) & " tool reads class and object definitions, " &
+ "written in the Scala programming language, and compiles them into " &
+ "bytecode class files.",
+
+ "By default, the compiler puts each class file in the same directory " &
+ "as its source file. You can specify a separate destination directory " &
+ "with -d (see " & Link(Bold("OPTIONS"), "#options") & ", below).")
+
+ val options =
+ Section("Standard Options",
+ DefinitionList(
+ Definition(
+ CmdOption("reset"),
+ "Reset compile server caches"),
+ Definition(
+ CmdOption("shutdown"),
+ "Shutdown compile server"),
+ Definition(
+ CmdOption("server", Argument("hostname:portnumber")),
+ "Specify compile server socket"),
+ Definition(
+ CmdOption("J", Argument("flag")),
+ "Pass <flag> directly to runtime system")
+ ))
+
+ val environment = Section("ENVIRONMENT",
+
+ DefinitionList(
+ Definition(
+ MBold("JAVACMD"),
+ "Specify the " & MBold("java") & " command to be used " &
+ "for running the Scala commands")))
+
+ val examples = Section("EXAMPLES",
+
+ DefinitionList(
+ Definition(
+ "Compile a Scala program to the current directory",
+ CmdLine("HelloWorld")),
+ Definition(
+ "Compile a Scala program to the destination directory " &
+ MBold("classes"),
+ CmdLine(CmdOption("d", "classes") & "HelloWorld.scala")),
+ Definition(
+ "Compile a Scala program using a user-defined " & MBold("java") & " " &
+ "command",
+ MBold("env JAVACMD") & Mono("=/usr/local/bin/cacao ") &
+ CmdLine(CmdOption("d", "classes") & "HelloWorld.scala")),
+ Definition(
+ "Compile all Scala files found in the source directory " &
+ MBold("src") & " to the destination directory " &
+ MBold("classes"),
+ CmdLine(CmdOption("d", "classes") & "src/*.scala"))))
+
+ val exitStatus = Section("EXIT STATUS",
+
+ MBold(command) & " returns a zero exist status if it succeeds to " &
+ "compile the specified input files. Non zero is returned in case " &
+ "of failure.")
+
+ val seeAlso = Section("SEE ALSO",
+
+ 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("scalap") & "(1)", "scalap.html"))
+
+ def manpage = new Document {
+ title = command
+ date = lastModified // e.g. "June 8, 2006"
+ author = "Stephane Micheloud"
+ version = "0.1"
+ sections = List(
+ name,
+ synopsis,
+ parameters,
+ options,
+ environment,
+ examples,
+ exitStatus,
+ authors,
+ bugs,
+ copyright,
+ seeAlso)
+ }
+}
diff --git a/src/manual/scala/man1/scala.scala b/src/manual/scala/man1/scala.scala
index 7a57e600fd..15237babc8 100644
--- a/src/manual/scala/man1/scala.scala
+++ b/src/manual/scala/man1/scala.scala
@@ -81,7 +81,6 @@ object scala extends Command {
Link(Bold("scalac") & "(1)", "scalac.html") & " page for " &
"full details. ",
-
"If an object is specified to run, then that object must be a top-level " &
"Scala object with the specified name. The object must define a method " &
Bold("main") & " with the following signature:",
@@ -114,7 +113,6 @@ object scala extends Command {
" will add " & Quote(".") & ", the current directory, to the " &
"end of the classpath.")
-
val options = Section("OPTIONS",
"If any compiler options are specified, they must be first in the " &
@@ -193,6 +191,7 @@ object scala extends Command {
val seeAlso = Section("SEE ALSO",
+ Link(Bold("fsc") & "(1)", "fsc.html") & ", " &
Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " &
Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " &
diff --git a/src/manual/scala/man1/scalac.scala b/src/manual/scala/man1/scalac.scala
index 6e84d4c886..d8e878872a 100644
--- a/src/manual/scala/man1/scalac.scala
+++ b/src/manual/scala/man1/scalac.scala
@@ -287,6 +287,7 @@ object scalac extends Command {
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("scaladoc") & "(1)", "scaladoc.html") & ", " &
diff --git a/src/manual/scala/man1/scaladoc.scala b/src/manual/scala/man1/scaladoc.scala
index f541ef1b1f..f69209c88c 100644
--- a/src/manual/scala/man1/scaladoc.scala
+++ b/src/manual/scala/man1/scaladoc.scala
@@ -82,6 +82,7 @@ object scaladoc extends Command {
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") & ", " &
diff --git a/src/manual/scala/man1/scalap.scala b/src/manual/scala/man1/scalap.scala
index 09d3ec02b4..3d82879c9b 100644
--- a/src/manual/scala/man1/scalap.scala
+++ b/src/manual/scala/man1/scalap.scala
@@ -82,6 +82,7 @@ object scalap extends Command {
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") & ", " &
diff --git a/src/manual/scala/tools/docutil/resources/index.html b/src/manual/scala/tools/docutil/resources/index.html
index 4799290b5f..eb952e35d1 100644
--- a/src/manual/scala/tools/docutil/resources/index.html
+++ b/src/manual/scala/tools/docutil/resources/index.html
@@ -45,8 +45,8 @@
<ul class="ContentList">
<li>
<a href="#basic"><b class="SansSerif">Basic Tools</b></a> (<code>sbaz</code>,
- <code>scala</code>, <code>scalac</code>, <code>scaladoc</code>,
- <code>scalaint</code>, <code>scalap</code>, <code>scalascript</code>)
+ <code>fsc</code>, <code>scala</code>, <code>scalac</code>, <code>scaladoc</code>,
+ <code>scalap</code>)
</li>
</ul>
</div>
@@ -122,6 +122,17 @@
</tr>
<tr>
<td width="13%" valign="top">
+ <span class="tool">fsc</span>
+ </td>
+ <td width="70%" valign="top">
+ The fast Scala compiler.
+ </td>
+ <td width="17%" valign="top">
+ [<a href="fsc.html">Solaris, Linux and Windows</a>]
+ </td>
+ </tr>
+ <tr>
+ <td width="13%" valign="top">
<span class="tool">sbaz</span>
</td>
<td width="70%" valign="top">