- man pages for Scala commands.

4 files changed, 646 insertions, 0 deletions

diff --git a/doc/man/man1/scala.1 b/doc/man/man1/scala.1
new file mode 100644
index 0000000000..f7753ef6fc
--- /dev/null
+++ b/doc/man/man1/scala.1
@@ -0,0 +1,112 @@
+.\" ##########################################################################
+.\" #                      __                                                #
+.\" #      ________ ___   / /  ___     Scala On-line Manual Pages            #
+.\" #     / __/ __// _ | / /  / _ |    (c) 2002-2005, LAMP/EPFL              #
+.\" #   __\ \/ /__/ __ |/ /__/ __ |                                          #
+.\" #  /____/\___/_/ |_/____/_/ | |    http://scala.epfl.ch/                 #
+.\" #                           |/                                           #
+.\" ##########################################################################
+.\"
+.\" Process this file with nroff -man scala.1
+.\"
+.TH scala 1  "April 29, 2005" "version 0.1" "USER COMMANDS"
+.\"
+.\" ################################# NAME ###################################
+.\"
+.SH NAME
+scala \- Launcher for the Scala language
+.\"
+.\" ############################### SYNOPSIS #################################
+.\"
+.SH SYNOPSIS
+\fBscala\fR [ <\fIoptions\fR> ] <\fIclass file\fR> [ <\fIargs\fR> ]
+.\"
+.\" ############################### PARAMETERS ###############################
+.\"
+.SH PARAMETERS
+.TP
+<\fIoptions\fR>
+Command line options. See \fBOPTIONS\fR below.
+.TP
+<\fIclass file\fR>
+Name of the class to be invoked.
+.TP
+<\fIargs\fR>
+Program arguments passed to the main function.
+.\"
+.\" ############################## DESCRIPTION ###############################
+.\"
+.SH DESCRIPTION
+The \fBscala\fR utility launches a Scala application. It does this by starting
+a Java runtime environment, loading a specified class, and invoking that
+class’s \fBmain\fR method. The method must have the following signature:
+.PP
+          \fBdef\fR main(args: Array[String]): Unit
+.PP
+The method must not return any value, and it must accept a String array as a
+parameter. By default, the first non-option argument is the name of the class
+to be invoked. A fully-qualified class name should be used.
+.PP
+The Scala runtime searches for the startup class, and other classes used, in
+three sets of locations: the bootstrap class path, the installed extensions,
+and the user class path.
+.\"
+.\" ############################### OPTIONS ##################################
+.\"
+.SH OPTIONS
+The launcher has a set of standard options that are supported on the current
+runtime environment and will be supported in future releases. An additional
+set of non-standard options are specific to the current virtual machine
+implementation and are subject to change in the future. Non-standard options
+begin with \fB-X\fR.
+.TP
+\fB\-classpath\fR <\fIpath\fR>
+Specify where to find user class files (on Unix-based systems a
+colon-separated list of paths, on Windows-based systems, a semicolon-separate
+list of paths).
+.\"
+.\" ############################### EXAMPLES #################################
+.\"
+.SH EXAMPLES
+.TP
+Execute a Scala program generated in the current directory
+\fBscala\fR HelloWorld
+.PP
+.TP
+Execute a Scala program generated in a user-defined directory \fBclasses\fR
+\fBscala\fR \-classpath classes hello.HelloWorld
+.PP
+.\"
+.\" ############################# EXIT STATUS ################################
+.\"
+.SH "EXIT STATUS"
+\fBscala\fR returns a zero exist status if it succeeds. Non zero is returned
+in case of failure.
+.\"
+.\" ############################## AUTHOR(S) #################################
+.\"
+.SH AUTHOR
+Written by Stephane Micheloud.
+.\"
+.\" ################################ BUGS ####################################
+.\"
+.SH "REPORTING BUGS"
+Report bugs to <scala@lists.epfl.ch>.
+.\"
+.\" ############################# COPYRIGHT ##################################
+.\"
+.SH COPYRIGHT
+Copyright \(co 2002-2005 LAMP/EPFL
+.PP
+This is free software; see the distribution for copying conditions.  There is
+NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.\"
+.\" ############################### SEE ALSO #################################
+.\"
+.SH "SEE ALSO"
+.BR scalac(1),
+.BR scalaint(1),
+.BR scalarun(1)
+.\"
+.\" ##########################################################################
+.\" $Id$
diff --git a/doc/man/man1/scalac.1 b/doc/man/man1/scalac.1
new file mode 100644
index 0000000000..a33acbd557
--- /dev/null
+++ b/doc/man/man1/scalac.1
@@ -0,0 +1,293 @@
+.\" ##########################################################################
+.\" #                      __                                                #
+.\" #      ________ ___   / /  ___     Scala On-line Manual Pages            #
+.\" #     / __/ __// _ | / /  / _ |    (c) 2002-2005, LAMP/EPFL              #
+.\" #   __\ \/ /__/ __ |/ /__/ __ |                                          #
+.\" #  /____/\___/_/ |_/____/_/ | |    http://scala.epfl.ch/                 #
+.\" #                           |/                                           #
+.\" ##########################################################################
+.\"
+.\" Process this file with nroff -man scalac.1
+.\"
+.TH scalac 1  "April 29, 2005" "version 0.1" "USER COMMANDS"
+.\"
+.\" ################################# NAME ###################################
+.\"
+.SH NAME
+scalac \- Compiler for the Scala language
+.\"
+.\" ############################### SYNOPSIS #################################
+.\"
+.SH SYNOPSIS
+\fBscalac\fR [ <\fIoptions\fR> ] <\fIsource files\fR>
+.\"
+.\" ############################### PARAMETERS ###############################
+.\"
+.SH PARAMETERS
+.TP
+<\fIoptions\fR>
+Command line options. See \fBOPTIONS\fR below.
+.TP
+<\fIsource files\fR>
+One or more source files to be compiled (such as MyClass.scala).
+.\"
+.\" ############################## DESCRIPTION ###############################
+.\"
+.SH DESCRIPTION
+The \fBscalac\fR tool reads class and object definitions, written in the
+Scala programming language, and compiles them into bytecode class files.
+.PP
+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
+\fBOPTIONS\fR, below).
+.\"
+.\" ############################### OPTIONS ##################################
+.\"
+.SH OPTIONS
+The compiler has a set of standard options that are supported on the current
+development environment and will be supported in future releases.  An
+additional set of non-standard options are specific to the current virtual
+machine implementation and are subject to change in the future.  Non-standard
+options begin with \fB-X\fR.
+.SS Standard Options
+.TP
+\fB\-g\fR
+Generate debugging info
+.TP
+\fB\-nowarn\fR
+Generate no warnings
+.TP
+\fB\-verbose\fR
+Output messages about what the compiler is doing
+.TP
+\fB\-classpath\fR <\fIpath\fR>
+Specify where to find user class files (on Unix-based systems
+a colon-separated list of paths, on Windows-based systems, a
+semicolon-separate list of paths). This does not override the
+built-in ("boot") search path.
+.TP
+\fB\-sourcepath\fR <\fIpath\fR>
+Specify where to find input source files.
+.TP
+\fB\-bootclasspath\fR <\fIpath\fR>
+Override location of bootstrap class files (where to find the
+standard built-in classes, such as "scala.List").
+.TP
+\fB\-extdirs\fR <\fIdirs\fR>
+Override location of installed extensions.
+.TP
+\fB\-d\fR <directory>
+Specify where to place generated class files.
+.TP
+\fB\-encoding\fR <\fIencoding\fR>
+Specify character encoding used by source files.
+.TP
+\fB\-separate:\fR<\fIseparate\fR>
+Read symbol files for separate compilation: (yes, no).
+.TP
+\fB\-target:\fR<\fItarget\fR>
+Specify which backend to use (jvm, msil).
+.TP
+\fB\-r\fR <assembly files>
+Assemblies referenced by the source program (only relevant with
+option '-target:msil').
+.TP
+\fB\-o\fR <assembly name>
+Name of the output assembly (only relevant with '-target:msil').
+.TP
+\fB\-version\fR
+Print product version and exit.
+.TP
+\fB\-? -help\fR
+Print a synopsis of standard options.
+.SS Debug Options
+.TP
+.B \-debug
+Output debugging messages.
+.TP
+\fB\-explaintypes\fR
+Explain type errors in more detail.
+.TP
+\fB\-uniqid\fR
+Print identifiers with unique names (debugging option).
+.TP
+\fB\-types\fR
+Print tree types (debugging option).
+.TP
+\fB\-prompt\fR
+Display a prompt after each error (debugging option).
+.TP
+\fB\-noimports\fR
+Compile without any implicit imports.
+.TP
+\fB\-nopredefs\fR
+Compile without any implicit predefined values.
+.TP
+\fB\-skip:\fR<\fIphases\fR>
+Skip <phases> (see below).
+.TP
+\fB\-check:\fR<\fIphases\fR>
+Check the tree after <\fIphases\fR> (see below).
+.TP
+\fB\-print:\fR<phases>
+Print out program after <\fIphases\fR> (see below).
+.TP
+\fB\-printer:\fR<printer>
+Printer to use.
+.TP
+\fB\-print-file\fR <\fIfile\fR>
+Specify file in which to print trees.
+.TP
+\fB\-graph:\fR<\fIphases\fR>
+Graph the program after <phases> (see below).
+.TP
+\fB\-stop:\fR<\fIphases\fR>
+Stop after first phase in <phases> (see below).
+.TP
+\fB\-log:\fR<\fIphases\fR>
+Log operations in <\fIphases\fR> (see below).
+.SS Non-Standard Options
+.TP
+\fB\-Xshortname\fR
+Display short file names in error reports.
+.TP
+\fB\-Xmarkup\fR
+No effect, only for compatibility.
+.TP
+\fB\-Xnewmatch\fR
+New pattern matching.
+.TP
+\fB\-XpreserveWS\fR
+Don't trim whitespace in XML literals.
+.TP
+\fB\-XrootClass\fR <\fIclass\fR>
+Specify the root class of the global application.
+.TP
+\fB\-XappFile\fR <\fIfile\fR>
+Specify the filename where to dump the whole-application inferred from the rootclass.
+.TP
+\fB\-XdotFile\fR <\fIfile\fR>
+Specify the filename where to print the AST in graphviz dot format.
+.TP
+\fB\-Xrta\fR
+Perform Rapid Type analysis for method call resolution.
+.TP
+\fB\-Xinline\fR
+Inline method calls that can be resolved statically.
+.TP
+\fB\-Xrtt\fR
+Enable run-time types.
+.SS Compilation Phases
+.TP
+\fIinitial\fR
+initializing compiler
+.TP
+\fIparse\fR
+parse source files
+.TP
+\fInamer\fR
+create symbols
+.TP
+\fIanalyze\fR
+name and type analysis
+.TP
+\fIrefcheck\fR
+reference checking
+.TP
+\fIuncurry\fR
+uncurry function types and applications
+.TP
+\fItransmatch\fR
+translate match expressions
+.TP
+\fIlambdalift\fR
+lambda lifter
+.TP
+\fItypesasvalues\fR
+represent types as values
+.TP
+\fIaddaccessors\fR
+add accessors for constructor arguments
+.TP
+\fIexplicitouterclasses\fR
+make links from inner classes to enclosing one explicit
+.TP
+\fIaddconstructors\fR
+add explicit constructor for each class
+.TP
+\fItailcall\fR
+add tail-calls
+.TP
+\fIwholeprog\fR
+perform whole program analysis
+.TP
+\fIaddinterfaces\fR
+add one interface per class
+.TP
+\fIexpandmixins\fR
+expand mixins by code copying
+.TP
+\fIboxing\fR
+makes boxing explicit
+.TP
+\fIerasure\fR
+type eraser
+.TP
+\fIicode\fR
+generate icode
+.TP
+\fIcodegen\fR
+enable code generation
+.TP
+\fIterminal\fR
+compilation terminated
+.TP
+\fIall\fR
+matches all phases
+
+.\"
+.\" ############################### EXAMPLES #################################
+.\"
+.SH EXAMPLES
+.TP
+Compile a Scala program
+\fBscalac\fR HelloWorld
+.PP
+.TP
+Compile a Scala program to a user-defined target directory \fBclasses\fR
+\fBscalac\fR \-d classes HelloWorld.scala
+.PP
+.\"
+.\" ############################# EXIT STATUS ################################
+.\"
+.SH "EXIT STATUS"
+\fBscalac\fR returns a zero exist status if it succeeds to compile the
+specified input files. Non zero is returned in case of failure.
+.\"
+.\" ############################## AUTHOR(S) #################################
+.\"
+.SH AUTHOR
+Written by Stephane Micheloud.
+.\"
+.\" ################################ BUGS ####################################
+.\"
+.SH "REPORTING BUGS"
+Report bugs to <scala@lists.epfl.ch>.
+.\"
+.\" ############################# COPYRIGHT ##################################
+.\"
+.SH COPYRIGHT
+Copyright \(co 2002-2005 LAMP/EPFL
+.PP
+This is free software; see the distribution for copying conditions.  There is
+NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.\"
+.\" ############################## SEE ALSO ##################################
+.\"
+.SH "SEE ALSO"
+.BR scala(1),
+.BR scalaint(1),
+.BR scalarun(1)
+.\"
+.\" ##########################################################################
+.\" $Id$
diff --git a/doc/man/man1/scalaint.1 b/doc/man/man1/scalaint.1
new file mode 100644
index 0000000000..63f8b45463
--- /dev/null
+++ b/doc/man/man1/scalaint.1
@@ -0,0 +1,122 @@
+.\" ##########################################################################
+.\" #                      __                                                #
+.\" #      ________ ___   / /  ___     Scala On-line Manual Pages            #
+.\" #     / __/ __// _ | / /  / _ |    (c) 2002-2005, LAMP/EPFL              #
+.\" #   __\ \/ /__/ __ |/ /__/ __ |                                          #
+.\" #  /____/\___/_/ |_/____/_/ | |    http://scala.epfl.ch/                 #
+.\" #                           |/                                           #
+.\" ##########################################################################
+.\"
+.\" Process this file with nroff -man scalaint.1
+.\"
+.TH scalaint 1  "April 29, 2005" "version 0.1" "USER COMMANDS"
+.\"
+.\" ################################# NAME ###################################
+.\"
+.SH NAME
+scalaint \- Interactive interpreter for the Scala language
+.\"
+.\" ############################### SYNOPSIS #################################
+.\"
+.SH SYNOPSIS
+\fBscalaint\fR [ <\fIoptions\fR> ] <\fIsource files\fR> [ -- <\fImodule\fR> [ <\fIargs\fR> ] ]
+.\"
+.\" ############################### PARAMETERS ###############################
+.\"
+.SH PARAMETERS
+.TP
+<\fIoptions\fR>
+Command line options. See \fBOPTIONS\fR below.
+.TP
+<\fIsource files\fR>
+One or more source files to be interpreted (such as MyClass.scala).
+.TP
+<\fImodule\fR>
+Name of the Scala object containing the main function.
+.TP
+<\fIargs\fR>
+Program arguments passed to the main function.
+.\"
+.\" ############################## DESCRIPTION ###############################
+.\"
+.SH DESCRIPTION
+The \fBscalaint\fR utility starts an interpreter shell and executes the
+specified Scala application. It does this by loading the class <\fImodule\fR>
+and invoking that class’s \fBmain\fR method. The method must have the
+following signature:
+.PP
+          \fBdef\fR main(args: Array[String]): Unit
+.PP
+The method must not return any value, and it must accept a String array as a
+parameter.
+.PP
+The Scala interpreter searches for the startup class, and other classes used,
+in three sets of locations: the bootstrap class path, the installed
+extensions, and the user class path.
+.\"
+.\" ############################### OPTIONS ##################################
+.\"
+.SH OPTIONS
+The \fBscalaint\fR command supports the following options
+.TP
+\fB\-c\fR <\fIstring\fR>
+Evaluate <\fIstring\fR> and print result.
+.TP
+\fB\-classpath\fR <\fIpath\fR>
+Specify where to find user class files (on Unix-based systems
+a colon-separated list of paths, on Windows-based systems, a
+semicolon-separate list of paths).
+.TP
+\fB\-nologo\fR
+Print no logo at interactive interpreter start.
+.TP
+\fB\-emacs\fR
+Use Emacs editing mode.
+.TP
+\fB\-g\fR
+Generate debugging info.
+.TP
+\fB\-nowarn\fR
+Generate no warnings.
+.\"
+.\" ############################### EXAMPLES #################################
+.\"
+.SH EXAMPLES
+.TP
+Run a Scala program located in the current directory
+\fBscalaint\fR -nologo HelloWorld.scala -- HelloWorld
+.PP
+.\"
+.\" ############################# EXIT STATUS ################################
+.\"
+.SH "EXIT STATUS"
+\fBscalaint\fR returns a zero exist status if it succeeds. Non zero is
+returned in case of failure.
+.\"
+.\" ############################## AUTHOR(S) #################################
+.\"
+.SH AUTHOR
+Written by Stephane Micheloud.
+.\"
+.\" ################################ BUGS ####################################
+.\"
+.SH "REPORTING BUGS"
+Report bugs to <scala@lists.epfl.ch>.
+.\"
+.\" ############################# COPYRIGHT ##################################
+.\"
+.SH COPYRIGHT
+Copyright \(co 2002-2005 LAMP/EPFL
+.PP
+This is free software; see the distribution for copying conditions.  There is
+NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.\"
+.\" ############################### SEE ALSO #################################
+.\"
+.SH "SEE ALSO"
+.BR scala(1),
+.BR scalac(1),
+.BR scalarun(1)
+.\"
+.\" ##########################################################################
+.\" $Id$
diff --git a/doc/man/man1/scalarun.1 b/doc/man/man1/scalarun.1
new file mode 100644
index 0000000000..c928dca44b
--- /dev/null
+++ b/doc/man/man1/scalarun.1
@@ -0,0 +1,119 @@
+.\" ##########################################################################
+.\" #                      __                                                #
+.\" #      ________ ___   / /  ___     Scala On-line Manual Pages            #
+.\" #     / __/ __// _ | / /  / _ |    (c) 2002-2005, LAMP/EPFL              #
+.\" #   __\ \/ /__/ __ |/ /__/ __ |                                          #
+.\" #  /____/\___/_/ |_/____/_/ | |    http://scala.epfl.ch/                 #
+.\" #                           |/                                           #
+.\" ##########################################################################
+.\"
+.\" Process this file with nroff -man scalarun.1
+.\"
+.TH scalarun 1  "April 29, 2005" "version 0.1" "USER COMMANDS"
+.\"
+.\" ################################# NAME ###################################
+.\"
+.SH NAME
+scalarun \- Non-interactive interpreter for the Scala language
+.\"
+.\" ############################### SYNOPSIS #################################
+.\"
+.SH SYNOPSIS
+\fBscalarun\fR [ <\fIoptions\fR> ] <\fIsource files\fR> [ -- <\fImodule\fR> [ <\fIargs\fR> ] ]
+.\"
+.\" ############################### PARAMETERS ###############################
+.\"
+.SH PARAMETERS
+.TP
+<\fIoptions\fR>
+Command line options. See \fBOPTIONS\fR below.
+.TP
+<\fIsource files\fR>
+One or more source files to be interpreted (such as MyClass.scala).
+.TP
+<\fImodule\fR>
+Name of the Scala object containing the main function.
+.TP
+<\fIargs\fR>
+Program arguments passed to the main function.
+.\"
+.\" ############################## DESCRIPTION ###############################
+.\"
+.SH DESCRIPTION
+The \fBscalarun\fR utility interpretes a Scala application. It does this by
+loading the class <\fImodule\fR> and invoking that class’s \fBmain\fR method.
+The method must have the following signature:
+.PP
+          \fBdef\fR main(args: Array[String]): Unit
+.PP
+The method must not return any value, and it must accept a String array as a
+parameter.
+.PP
+The Scala interpreter searches for the startup class, and other classes used,
+in three sets of locations: the bootstrap class path, the installed
+extensions, and the user class path.
+.\"
+.\" ############################### OPTIONS ##################################
+.\"
+.SH OPTIONS
+The \fBscalarun\fR command supports the following options
+.TP
+\fB\-c\fR <\fIstring\fR>
+Evaluate <\fIstring\fR> and print result.
+.TP
+\fB\-classpath\fR <\fIpath\fR>
+Specify where to find user class files (on Unix-based systems
+a colon-separated list of paths, on Windows-based systems, a
+semicolon-separate list of paths).
+.TP
+\fB\-nologo\fR
+Print no logo at interactive interpreter start.
+.TP
+\fB\-emacs\fR
+Use Emacs editing mode.
+.TP
+\fB\-g\fR
+Generate debugging info.
+.TP
+\fB\-nowarn\fR
+Generate no warnings.
+.\"
+.\" ############################### EXAMPLES #################################
+.\"
+.SH EXAMPLES
+.TP
+Run a Scala program located in the current directory
+\fBscalarun\fR HelloWorld.scala -- HelloWord
+.PP
+.\"
+.\" ############################# EXIT STATUS ################################
+.\"
+.SH "EXIT STATUS"
+\fBscalarun\fR returns a zero exist status if it succeeds. Non zero is
+returned in case of failure.
+.\"
+.\" ############################## AUTHOR(S) #################################
+.\"
+.SH AUTHOR
+Written by Stephane Micheloud.
+.\"
+.\" ################################ BUGS ####################################
+.\"
+.SH "REPORTING BUGS"
+Report bugs to <scala@lists.epfl.ch>.
+.\"
+.\" ############################# COPYRIGHT ##################################
+.\"
+.SH COPYRIGHT
+Copyright \(co 2002-2005 LAMP/EPFL
+.PP
+This is free software; see the distribution for copying conditions.  There is
+NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.\"
+.\" ############################### SEE ALSO #################################
+.\"
+.SH "SEE ALSO"
+.BR scala(1),
+.BR scalac(1),
+.BR scalaint(1)
+