summaryrefslogtreecommitdiff
path: root/src/manual
diff options
context:
space:
mode:
authorGilles Dubochet <gilles.dubochet@epfl.ch>2007-07-16 13:15:36 +0000
committerGilles Dubochet <gilles.dubochet@epfl.ch>2007-07-16 13:15:36 +0000
commit2b7574b14f9b88bf059c462713f36a8eeb66e8e1 (patch)
tree579fa6b2337ab278ecd1d3bde2e1a3e26b7a025b /src/manual
parenta5b37442c35a099471bdd22efc2afb39b133bf86 (diff)
downloadscala-2b7574b14f9b88bf059c462713f36a8eeb66e8e1.tar.gz
scala-2b7574b14f9b88bf059c462713f36a8eeb66e8e1.tar.bz2
scala-2b7574b14f9b88bf059c462713f36a8eeb66e8e1.zip
Updated Scalac man page for changed command-lin...
Updated Scalac man page for changed command-line options.
Diffstat (limited to 'src/manual')
-rw-r--r--src/manual/scala/man1/scalac.scala176
1 files changed, 69 insertions, 107 deletions
diff --git a/src/manual/scala/man1/scalac.scala b/src/manual/scala/man1/scalac.scala
index 0534118e86..52b3792558 100644
--- a/src/manual/scala/man1/scalac.scala
+++ b/src/manual/scala/man1/scalac.scala
@@ -67,12 +67,17 @@ object scalac extends Command {
CmdOption("nowarn"),
"Generate no warnings"),
Definition(
- CmdOption("noassert"),
- "Generate no assertions and assumptions"),
- Definition(
CmdOption("verbose"),
"Output messages about what the compiler is doing"),
Definition(
+ CmdOption("deprecation"),
+ SeqPara(
+ "Indicate whether source should be compiled with deprecation " &
+ "information; defaults to " & Mono("off") & " (" &
+ "accepted values are: " & Mono("on") & ", " & Mono("off") &
+ ", " & Mono("yes") & " and " & Mono("no") & ")",
+ "Available since Scala version 2.2.1")),
+ Definition(
CmdOption("classpath", Argument("path")),
SeqPara(
"Specify where to find user class files (on Unix-based systems " &
@@ -114,144 +119,101 @@ object scalac extends Command {
"msil,cldc") & ").",
"The default value is " & Mono("\"jvm-1.4\"") & ".")),
Definition(
- CmdOption("o", Argument("file")),
- "Name of the output assembly (only relevant with -target:msil)"),
- Definition(
- CmdOption("r", Argument("path")),
- "List of assemblies referenced by the program (only relevant with -target:msil)"),
+ CmdOption("print"),
+ "Print program with all Scala-specific features removed"
+ ),
Definition(
- CmdOption("deprecation"),
- SeqPara(
- "Indicate whether source should be compiled with deprecation " &
- "information; defaults to " & Mono("off") & " (" &
- "accepted values are: " & Mono("on") & ", " & Mono("off") &
- ", " & Mono("yes") & " and " & Mono("no") & ")",
- "Available since Scala version 2.2.1")),
+ CmdOption("optimise"),
+ "Generates faster bytecode by applying optimisations to the program"
+ ),
Definition(
- CmdOption("unchecked"),
- SeqPara(
- "Enable detailed unchecked warnings",
- "Non variable type-arguments in type patterns are unchecked " &
- "since they are eliminated by erasure",
- "Available since Scala version 2.3.0")),
+ CmdOption("explaintypes"),
+ "Explain type errors in more detail."),
Definition(
- CmdOption("resident"),
- "Compiler stays resident, files to compile are read from standard " &
- "input."),
+ CmdOption("uniqid"),
+ "Print identifiers with unique names (debugging option)."),
Definition(
CmdOption("version"),
"Print product version and exit."),
Definition(
/*CmdOption("?") & "| " &*/ CmdOption("help"),
- "Print a synopsis of standard options."),
- Definition(
- CmdOption("nouescape"),
- "Disable handling of " & BSlash & "u unicode escapes"))),
+ "Print a synopsis of standard options."))),
- Section("Non-Standard Options",
+ Section("Advanced Options",
DefinitionList(
Definition(
- CmdOption("Xinline"),
- "Perform inlining when possible."),
- Definition(
- CmdOption("Xcloselim"),
- "Perform closure elimination."),
- Definition(
- CmdOption("Xdce"),
- "Perform dead code elimination"),
- Definition(
- CmdOption("XbytecodeRead"),
- "Enable bytecode reader."),
- Definition(
- CmdOption("Xshowcls", Argument("class")),
- "Show class info."),
- Definition(
- CmdOption("Xshowobj", Argument("object")),
- "Show object info."),
- Definition(
- CmdOption("Xshowicode"),
- "Print the generated ICode."),
+ CmdOption("Xassem", Argument("file")),
+ "Name of the output assembly (only relevant with -target:msil)"),
Definition(
- CmdOption("Xlinearizer:", Argument("Xlinearizer")),
- SeqPara(
- "Linearizer to use (" & Mono("dfs,dump,normal,rpo") & ").",
- "The default value is " & Mono("\"rpo\"") & ".")),
+ CmdOption("Xassem-path", Argument("path")),
+ "List of assemblies referenced by the program (only relevant with -target:msil)"),
Definition(
- CmdOption("Xgenerics"),
- "Use generic Java types."),
+ CmdOption("Xcheck-null"),
+ "Emit warning on selection of nullable reference"),
Definition(
- CmdOption("Xprintpos"),
- "Print tree positions (as offsets)"),
+ CmdOption("Xdebug"),
+ "Output debugging messages."),
Definition(
- CmdOption("Xscript"),
- "Compile script file"),
+ CmdOption("Xdisable-assertions"),
+ "Generate no assertions and assumptions"),
Definition(
CmdOption("Xexperimental"),
"enable experimental extensions"),
Definition(
- CmdOption("Xplugtypes"),
+ CmdOption("Xno-uescape"),
+ "Disable handling of " & BSlash & "u unicode escapes"),
+ Definition(
+ CmdOption("Xplug-types"),
"Parse but ignore annotations in more locations"),
Definition(
- CmdOption("Xkilloption"),
- "Optimizes option types"),
+ CmdOption("Xplugin:", Argument("file")),
+ "Load a plugin from a file"),
Definition(
- CmdOption("XprintOuterMatches"),
- "Prints outer-checks caused by pattern matching")
- )
- ),
-
- Section("Debug Options",
- DefinitionList(
+ CmdOption("Xplugin-disable:", Argument("plugin")),
+ "Disable a plugin"),
Definition(
- CmdOption("debug"),
- "Output debugging messages."),
+ CmdOption("Xplugin-list"),
+ "Print a synopsis of loaded plugins"),
Definition(
- CmdOption("statistics"),
- "Print compiler statistics."),
+ CmdOption("Xplugin-opt:", Argument("plugin:opt")),
+ "Pass an option to a plugin"),
Definition(
- CmdOption("explaintypes"),
- "Explain type errors in more detail."),
+ CmdOption("Xplugin-require:", Argument("plugin")),
+ "Abort unless a plugin is available"),
Definition(
- CmdOption("uniqid"),
- "Print identifiers with unique names (debugging option)."),
+ CmdOption("print:", Argument("phases")),
+ "Print out program after " & Argument("phases") & " (see below)."),
Definition(
- CmdOption("printtypes"),
- "Print tree types (debugging option)."),
+ CmdOption("Xprint-pos"),
+ "Print tree positions (as offsets)"),
Definition(
- CmdOption("prompt"),
- "Display a prompt after each error (debugging option)."),
+ CmdOption("Xprint-types"),
+ "Print tree types (debugging option)."),
Definition(
- CmdOption("noimports"),
- "Compile without any implicit imports."),
+ CmdOption("Xresident"),
+ "Compiler stays resident, files to compile are read from standard " &
+ "input."),
Definition(
- CmdOption("nopredefs"),
- "Compile without any implicit predefined values."),
+ CmdOption("Xshow-class", Argument("class")),
+ "Show class info."),
Definition(
- CmdOption("skip:", Argument("phases")),
- "Skip " & Argument("phases") & " (see below)."),
+ CmdOption("Xshow-object", Argument("object")),
+ "Show object info."),
Definition(
- CmdOption("check:", Argument("phases")),
- "Check the tree after " & Argument("phases") & " (see below)."),
+ CmdOption("Xshow-phases"),
+ "Print a synopsis of compiler phases."),
Definition(
- CmdOption("print:", Argument("phases")),
- "Print out program after " & Argument("phases") & " (see below)."),
+ CmdOption("Xsource-reader", Argument("classname")),
+ "Specify a custom method for reading source files."),
Definition(
- CmdOption("printer:", Argument("printer")),
+ CmdOption("Xunchecked"),
SeqPara(
- "Printer to use (" & Mono("text,html") & ").",
- "The default value is " & Mono("\"text\"") & ".")),
- Definition(
- CmdOption("print-file", Argument("file")),
- "Specify file in which to print trees."),
- Definition(
- CmdOption("graph:", Argument("phases")),
- "Graph the program after " & Argument("phases") & " (see below)."),
- Definition(
- CmdOption("stop:", Argument("phases")),
- "Stop after first phase in " & Argument("phases") & " (see below)."),
- Definition(
- CmdOption("log:", Argument("phases")),
- "Log operations in " & Argument("phases") & " (see below)."))),
+ "Enable detailed unchecked warnings",
+ "Non variable type-arguments in type patterns are unchecked " &
+ "since they are eliminated by erasure",
+ "Available since Scala version 2.3.0")),
+ )
+ ),
Section("Compilation Phases",
DefinitionList(
@@ -384,7 +346,7 @@ object scalac extends Command {
def manpage = new Document {
title = command
date = lastModified // e.g. "June 8, 2006"
- author = "Stephane Micheloud"
+ author = "Stephane Micheloud & LAMP"
version = "0.4"
sections = List(
name,