diff options
Diffstat (limited to 'docs/man')
-rw-r--r-- | docs/man/man1/scaladoc.1 | 119 | ||||
-rw-r--r-- | docs/man/man1/scalaint.1 | 127 | ||||
-rw-r--r-- | docs/man/man1/scalarun.1 | 123 |
3 files changed, 0 insertions, 369 deletions
diff --git a/docs/man/man1/scaladoc.1 b/docs/man/man1/scaladoc.1 deleted file mode 100644 index 5063c72918..0000000000 --- a/docs/man/man1/scaladoc.1 +++ /dev/null @@ -1,119 +0,0 @@ -.\" ########################################################################## -.\" # __ # -.\" # ________ ___ / / ___ 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 -.BR -\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/docs/man/man1/scalaint.1 b/docs/man/man1/scalaint.1 deleted file mode 100644 index 5f67995723..0000000000 --- a/docs/man/man1/scalaint.1 +++ /dev/null @@ -1,127 +0,0 @@ -.\" ########################################################################## -.\" # __ # -.\" # ________ ___ / / ___ 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\-interactive\fR -Start interpreter in interactive mode. -.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. -.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 -Run a Scala program located in the current directory -.BR -\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 scaladoc(1), -.BR scalarun(1) -.\" -.\" ########################################################################## -.\" $Id$ diff --git a/docs/man/man1/scalarun.1 b/docs/man/man1/scalarun.1 deleted file mode 100644 index 14bc78faaf..0000000000 --- a/docs/man/man1/scalarun.1 +++ /dev/null @@ -1,123 +0,0 @@ -.\" ########################################################################## -.\" # __ # -.\" # ________ ___ / / ___ 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 -.BR -\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 scaladoc(1), -.BR scalaint(1) -.\" -.\" ########################################################################## -.\" $Id$ |