summaryrefslogtreecommitdiff
path: root/src/manual
diff options
context:
space:
mode:
authormichelou <michelou@epfl.ch>2007-04-18 14:10:07 +0000
committermichelou <michelou@epfl.ch>2007-04-18 14:10:07 +0000
commita7da970fa8df1a2ef304c5228ba1c6294ca5ebe6 (patch)
tree0b5b73c2fb2ae39875013a998293b4b865a58e48 /src/manual
parent46a32e94ffb7c95700b61cb09bc105321daf6c05 (diff)
downloadscala-a7da970fa8df1a2ef304c5228ba1c6294ca5ebe6.tar.gz
scala-a7da970fa8df1a2ef304c5228ba1c6294ca5ebe6.tar.bz2
scala-a7da970fa8df1a2ef304c5228ba1c6294ca5ebe6.zip
added variable JAVA_OPTS to generated man pages
Diffstat (limited to 'src/manual')
-rw-r--r--src/manual/scala/man1/Command.scala2
-rw-r--r--src/manual/scala/man1/fsc.scala23
-rw-r--r--src/manual/scala/man1/scala.scala22
-rw-r--r--src/manual/scala/man1/scalac.scala18
4 files changed, 53 insertions, 12 deletions
diff --git a/src/manual/scala/man1/Command.scala b/src/manual/scala/man1/Command.scala
index 136f97a9ab..e681830a06 100644
--- a/src/manual/scala/man1/Command.scala
+++ b/src/manual/scala/man1/Command.scala
@@ -52,7 +52,7 @@ trait Command {
//private val df = new java.text.SimpleDateFormat("MMM d, yyyy")
//private val rightNow = new java.util.Date()
- def lastModified: String = "December 15, 2006" // df.format(rightNow)
+ def lastModified: String = "April 18, 2007" // df.format(rightNow)
def manpage: Document
}
diff --git a/src/manual/scala/man1/fsc.scala b/src/manual/scala/man1/fsc.scala
index e42fdba413..e101dc4547 100644
--- a/src/manual/scala/man1/fsc.scala
+++ b/src/manual/scala/man1/fsc.scala
@@ -39,9 +39,9 @@ object fsc extends Command {
"change, for example due to upgrading a library, then the daemon "&
"should be explicitly shut down with " & MBold("-shutdown") & ".",
- "Note that the "&Link(MBold("scala"),"scala.html")&" script runner "&
- "will also use "&
- "the offline compiler by default, with the sae advantages and caveats.")
+ "Note that the " & Link(MBold("scala"), "scala.html") & " script runner " &
+ "will also use " &
+ "the offline compiler by default, with the same advantages and caveats.")
val options = Section("OPTIONS",
@@ -111,8 +111,21 @@ object fsc extends Command {
"Specify the " & MBold("java") & " command to be used " &
"for running the Scala code. Arguments may be specified " &
"as part of the environment variable; spaces, quotation marks, " &
- "etc., will be passed directly to the shell for expansion.")))
+ "etc., will be passed directly to the shell for expansion."),
+ Definition(
+ MBold("JAVA_OPTS"),
+ SeqPara(
+ "Specify the options to be passed to the " & MBold("java") &
+ " command defined by " & MBold("JAVACMD") & ".",
+
+ "With Java 1.5 (or newer) one may for example configure the " &
+ "memory usage of the JVM as follows: " &
+ Mono("JAVA_OPTS=-Xmx512M -Xms16M -Xss16M"),
+ "With " & Link("GNU Java", "http://gcc.gnu.org/java/") & " one " &
+ "may configure the memory usage of the GIJ as follows: " &
+ Mono("JAVA_OPTS=--mx512m --ms16m")
+ ))))
val exitStatus = Section("EXIT STATUS",
@@ -132,7 +145,7 @@ object fsc extends Command {
title = command
date = lastModified
author = "Lex Spoon"
- version = "0.2"
+ version = "0.4"
sections = List(
name,
synopsis,
diff --git a/src/manual/scala/man1/scala.scala b/src/manual/scala/man1/scala.scala
index 76ebbccff0..24c0e3060b 100644
--- a/src/manual/scala/man1/scala.scala
+++ b/src/manual/scala/man1/scala.scala
@@ -149,8 +149,22 @@ object scala extends Command {
MBold("JAVACMD"),
"Specify the " & MBold("java") & " command to be used " &
"for running the Scala code. Arguments may be specified " &
- "as part of the environment variable; spaces, quotation marks " &
- "etc., will be passed directly to the shell for expansion.")))
+ "as part of the environment variable; spaces, quotation marks, " &
+ "etc., will be passed directly to the shell for expansion."),
+ Definition(
+ MBold("JAVA_OPTS"),
+ SeqPara(
+ "Specify the options to be passed to the " & MBold("java") &
+ " command defined by " & MBold("JAVACMD") & ".",
+
+ "With Java 1.5 (or newer) one may for example configure the " &
+ "memory usage of the JVM as follows: " &
+ Mono("JAVA_OPTS=-Xmx512M -Xms16M -Xss16M"),
+
+ "With " & Link("GNU Java", "http://gcc.gnu.org/java/") & " one " &
+ "may configure the memory usage of the GIJ as follows: " &
+ Mono("JAVA_OPTS=--mx512m --ms16m")
+ ))))
val examples = Section("EXAMPLES",
@@ -228,8 +242,8 @@ object scala extends Command {
def manpage = new Document {
title = command
date = lastModified
- author = "LAMP"
- version = "0.3"
+ author = "Stephane Micheloud"
+ version = "0.4"
sections = List(
name,
synopsis,
diff --git a/src/manual/scala/man1/scalac.scala b/src/manual/scala/man1/scalac.scala
index af8108fb9e..c09c3d0aca 100644
--- a/src/manual/scala/man1/scalac.scala
+++ b/src/manual/scala/man1/scalac.scala
@@ -332,8 +332,22 @@ object scalac extends Command {
MBold("JAVACMD"),
"Specify the " & MBold("java") & " command to be used " &
"for running the Scala code. Arguments may be specified " &
- "as part of the environment variable; spaces, quotation marks " &
- "etc., will be passed directly to the shell for expansion.")))
+ "as part of the environment variable; spaces, quotation marks, " &
+ "etc., will be passed directly to the shell for expansion."),
+ Definition(
+ MBold("JAVA_OPTS"),
+ SeqPara(
+ "Specify the options to be passed to the " & MBold("java") &
+ " command defined by " & MBold("JAVACMD") & ".",
+
+ "With Java 1.5 (or newer) one may for example configure the " &
+ "memory usage of the JVM as follows: " &
+ Mono("JAVA_OPTS=-Xmx512M -Xms16M -Xss16M"),
+
+ "With " & Link("GNU Java", "http://gcc.gnu.org/java/") & " one " &
+ "may configure the memory usage of the GIJ as follows: " &
+ Mono("JAVA_OPTS=--mx512m --ms16m")
+ ))))
val examples = Section("EXAMPLES",