*** empty log message ***

5 files changed, 196 insertions, 58 deletions

diff --git a/doc/man/man1/scala.1 b/doc/man/man1/scala.1
index f7753ef6fc..9dee330ddf 100644
--- a/doc/man/man1/scala.1
+++ b/doc/man/man1/scala.1
@@ -43,9 +43,9 @@ 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.
+The method must not return any value, and it must accept a \fBString\fR
+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,
@@ -60,10 +60,19 @@ 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>
+\fB\-cp -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\-help\fR
+Print this help message.
+.TP
+\fB\-showversion\fR
+Print product version and continue.
+.TP
+\fB\-version\fR
+Print product version and exit.
 .\"
 .\" ############################### EXAMPLES #################################
 .\"
@@ -105,6 +114,7 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 .\"
 .SH "SEE ALSO"
 .BR scalac(1),
+.BR scaladoc(1),
 .BR scalaint(1),
 .BR scalarun(1)
 .\"
diff --git a/doc/man/man1/scalac.1 b/doc/man/man1/scalac.1
index a33acbd557..fd4748b2b1 100644
--- a/doc/man/man1/scalac.1
+++ b/doc/man/man1/scalac.1
@@ -76,30 +76,61 @@ standard built-in classes, such as "scala.List").
 \fB\-extdirs\fR <\fIdirs\fR>
 Override location of installed extensions.
 .TP
-\fB\-d\fR <directory>
+\fB\-d\fR <\fIdirectory\fR>
 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).
+Read symbol files for separate compilation: (\fIyes\fR, \fIno\fR).
 .TP
 \fB\-target:\fR<\fItarget\fR>
-Specify which backend to use (jvm, msil).
+Specify which backend to use (\fIjvm\fR, \fImsil\fR).
 .TP
-\fB\-r\fR <assembly files>
-Assemblies referenced by the source program (only relevant with
+\fB\-r\fR <\fIassembly files\fR>
+CLR 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').
+\fB\-o\fR <\fIassembly name\fR>
+Name of the output assembly (only relevant with option '-target:msil').
 .TP
 \fB\-version\fR
 Print product version and exit.
 .TP
 \fB\-? -help\fR
 Print a synopsis of standard options.
+.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 Debug Options
 .TP
 .B \-debug
@@ -109,13 +140,13 @@ Output debugging messages.
 Explain type errors in more detail.
 .TP
 \fB\-uniqid\fR
-Print identifiers with unique names (debugging option).
+Print identifiers with unique names.
 .TP
 \fB\-types\fR
-Print tree types (debugging option).
+Print tree types.
 .TP
 \fB\-prompt\fR
-Display a prompt after each error (debugging option).
+Display a prompt after each error.
 .TP
 \fB\-noimports\fR
 Compile without any implicit imports.
@@ -124,7 +155,7 @@ Compile without any implicit imports.
 Compile without any implicit predefined values.
 .TP
 \fB\-skip:\fR<\fIphases\fR>
-Skip <phases> (see below).
+Skip <\fIphases\fR> (see below).
 .TP
 \fB\-check:\fR<\fIphases\fR>
 Check the tree after <\fIphases\fR> (see below).
@@ -132,51 +163,20 @@ Check the tree after <\fIphases\fR> (see below).
 \fB\-print:\fR<phases>
 Print out program after <\fIphases\fR> (see below).
 .TP
-\fB\-printer:\fR<printer>
+\fB\-printer:\fR<\fIprinter\fR>
 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).
+Graph the program after <\fIphases\fR> (see below).
 .TP
 \fB\-stop:\fR<\fIphases\fR>
-Stop after first phase in <phases> (see below).
+Stop after first phase in <\fIphases\fR> (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
@@ -252,11 +252,13 @@ matches all phases
 .TP
 Compile a Scala program
 \fBscalac\fR HelloWorld
-.PP
 .TP
-Compile a Scala program to a user-defined target directory \fBclasses\fR
+Compile a Scala program to the destination directory \fBclasses\fR
 \fBscalac\fR \-d classes HelloWorld.scala
-.PP
+.TP
+Compile all Scala files found in the source directory \fBsrc\fR to the
+destination directory \fBclasses\fR
+\fBscalac\fR \-d classes src/*.scala 
 .\"
 .\" ############################# EXIT STATUS ################################
 .\"
@@ -286,6 +288,7 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 .\"
 .SH "SEE ALSO"
 .BR scala(1),
+.BR scaladoc(1),
 .BR scalaint(1),
 .BR scalarun(1)
 .\"
diff --git a/doc/man/man1/scaladoc.1 b/doc/man/man1/scaladoc.1
new file mode 100644
index 0000000000..38dd96ddbc
--- /dev/null
+++ b/doc/man/man1/scaladoc.1
@@ -0,0 +1,118 @@
+.\" ##########################################################################
+.\" #                      __                                                #
+.\" #      ________ ___   / /  ___     Scala On-line Manual Pages            #
+.\" #     / __/ __// _ | / /  / _ |    (c) 2002-2005, LAMP/EPFL              #
+.\" #   __\ \/ /__/ __ |/ /__/ __ |                                          #
+.\" #  /____/\___/_/ |_/____/_/ | |    http://scala.epfl.ch/                 #
+.\" #                           |/                                           #
+.\" ##########################################################################
+.\"
+.\" Process this file with nroff -man scaladoc.1
+.\"
+.TH scaladoc 1  "April 29, 2005" "version 0.1" "USER COMMANDS"
+.\"
+.\" ################################# NAME ###################################
+.\"
+.SH NAME
+scaladoc \- Scala API documentation generator
+.\"
+.\" ############################### SYNOPSIS #################################
+.\"
+.SH SYNOPSIS
+\fBscaladoc\fR [ <\fIoptions\fR> ] <\fIsource files\fR> [ -- <\fIpackages\fR> ]
+.\"
+.\" ############################### PARAMETERS ###############################
+.\"
+.SH PARAMETERS
+.TP
+<\fIoptions\fR>
+Command line options. See \fBOPTIONS\fR below.
+.TP
+<\fIsource files\fR>
+A series of source file names, separated by spaces, each of which can
+include paths and wildcards such as asterisk (*).
+.TP
+<\fIpackages\fR>
+.
+.\"
+.\" ############################## DESCRIPTION ###############################
+.\"
+.SH DESCRIPTION
+The Scaladoc tool parses the declarations and documentation comments in a
+set of Scala source files and produces a corresponding set of HTML pages
+describing (by default) the public and protected classes, nested classes,
+traits, objects, methods, and fields.
+
+During a run, the Scaladoc tool automatically adds cross-reference links to
+package, class and member names that are being documented as part of that run.
+Links appear in several places:
+
+       · Declarations (return types, argument types, field types)
+
+       · "See Also" sections generated from @see tags
+
+       · In-line text generated from {@link} tags
+
+       · Exception names generated from @throws tags
+
+.\"
+.\" ############################### OPTIONS ##################################
+.\"
+.SH OPTIONS
+The Scaladoc tool supports the following options.
+.TP
+\fB\-g\fR
+Generate debugging info.
+.TP
+\fB\-d\fR <\fIdirectory\fR>
+Specify where to place generated HTML files. The output directory
+<\fIdirectory\fR> must exist.
+.TP
+\fB\-windowtitle\fR <\fItext\fR>
+Browser window title for the documentation.
+.TP
+\fB\-doctitle\fR <\fIhtml-code\fR>
+Include title for the overview page.
+.\"
+.\" ############################### EXAMPLES #################################
+.\"
+.SH EXAMPLES
+.TP
+Generate the Scala documentation in the specified directory \fB/tmp\fR
+\fBscaladoc\fR -d /tmp HelloWorld
+.PP
+.\"
+.\" ############################# EXIT STATUS ################################
+.\"
+.SH "EXIT STATUS"
+\fBscaladoc\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),
+.BR scalarun(1)
+.\"
+.\" ##########################################################################
+.\" $Id$
diff --git a/doc/man/man1/scalaint.1 b/doc/man/man1/scalaint.1
index 63f8b45463..b35a333076 100644
--- a/doc/man/man1/scalaint.1
+++ b/doc/man/man1/scalaint.1
@@ -1,4 +1,4 @@
-.\" ##########################################################################
+.\" ##########################################################################
 .\" #                      __                                                #
 .\" #      ________ ___   / /  ___     Scala On-line Manual Pages            #
 .\" #     / __/ __// _ | / /  / _ |    (c) 2002-2005, LAMP/EPFL              #
@@ -62,10 +62,8 @@ The \fBscalaint\fR command supports the following options
 \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).
+\fB\-interactive\fR
+Start interpreter in interactive mode.
 .TP
 \fB\-nologo\fR
 Print no logo at interactive interpreter start.
@@ -78,6 +76,11 @@ Generate debugging info.
 .TP
 \fB\-nowarn\fR
 Generate no warnings.
+.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 #################################
 .\"
@@ -116,6 +119,7 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 .SH "SEE ALSO"
 .BR scala(1),
 .BR scalac(1),
+.BR scaladoc(1),
 .BR scalarun(1)
 .\"
 .\" ##########################################################################
diff --git a/doc/man/man1/scalarun.1 b/doc/man/man1/scalarun.1
index c928dca44b..139829b370 100644
--- a/doc/man/man1/scalarun.1
+++ b/doc/man/man1/scalarun.1
@@ -115,5 +115,8 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 .SH "SEE ALSO"
 .BR scala(1),
 .BR scalac(1),
+.BR scaladoc(1),
 .BR scalaint(1)
-
+.\"
+.\" ##########################################################################
+.\" $Id$