diff options
author | michelou <michelou@epfl.ch> | 2006-03-10 21:37:12 +0000 |
---|---|---|
committer | michelou <michelou@epfl.ch> | 2006-03-10 21:37:12 +0000 |
commit | 661aade979ed0adeb4b98f27df644dbb0dc87b35 (patch) | |
tree | db53f18e9312b492b5d8dbd9b2dbb476b0a93bf5 /docs/man | |
parent | cb156c0843c4469bb7a0d86e2aaa8daf5a057de8 (diff) | |
download | scala-661aade979ed0adeb4b98f27df644dbb0dc87b35.tar.gz scala-661aade979ed0adeb4b98f27df644dbb0dc87b35.tar.bz2 scala-661aade979ed0adeb4b98f27df644dbb0dc87b35.zip |
updated man pages for Scala 2
Diffstat (limited to 'docs/man')
-rw-r--r-- | docs/man/man1/scala.1 | 4 | ||||
-rw-r--r-- | docs/man/man1/scalac.1 | 4 | ||||
-rw-r--r-- | docs/man/man1/scaladoc.1 | 112 | ||||
-rw-r--r-- | docs/man/man1/scalaint.1 | 74 |
4 files changed, 190 insertions, 4 deletions
diff --git a/docs/man/man1/scala.1 b/docs/man/man1/scala.1 index a6836a3602..0139ad74bb 100644 --- a/docs/man/man1/scala.1 +++ b/docs/man/man1/scala.1 @@ -111,7 +111,7 @@ Written by Stephane Micheloud. .\" ################################ BUGS #################################### .\" .SH "REPORTING BUGS" -Report bugs to <scala@lists.epfl.ch>. +Report bugs to <scala@listes.epfl.ch>. .\" .\" ############################# COPYRIGHT ################################## .\" @@ -126,7 +126,7 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. .SH "SEE ALSO" .BR scalac(1) .\" .BR scaladoc(1), -.\" .BR scalai(1) +.\" .BR scalaint(1) .\" .\" ########################################################################## .\" $Id$ diff --git a/docs/man/man1/scalac.1 b/docs/man/man1/scalac.1 index 209924e3af..cd833d4876 100644 --- a/docs/man/man1/scalac.1 +++ b/docs/man/man1/scalac.1 @@ -277,7 +277,7 @@ Written by Stephane Micheloud. .\" ################################ BUGS #################################### .\" .SH "REPORTING BUGS" -Report bugs to <scala@lists.epfl.ch>. +Report bugs to <scala@listes.epfl.ch>. .\" .\" ############################# COPYRIGHT ################################## .\" @@ -293,7 +293,7 @@ NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. .BR scala(1) .\" , .\" .BR scaladoc(1), -.\" .BR scalai(1) +.\" .BR scalaint(1) .\" .\" ########################################################################## .\" $Id$ diff --git a/docs/man/man1/scaladoc.1 b/docs/man/man1/scaladoc.1 new file mode 100644 index 0000000000..8630d10207 --- /dev/null +++ b/docs/man/man1/scaladoc.1 @@ -0,0 +1,112 @@ +.\" ########################################################################## +.\" # __ # +.\" # ________ ___ / / ___ Scala 2 On-line Manual Pages # +.\" # / __/ __// _ | / / / _ | (c) 2002-2006, 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 \- Doc Generator for the Scala 2 language +.\" +.\" ############################### SYNOPSIS ################################# +.\" +.SH SYNOPSIS +\fBscaladoc\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 \fBscaladoc\fR tool reads class and object definitions, written in the +Scala programming language, and generates their API as HTML files. +.PP +By default, the generator puts each HTML 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 generator has a set of standard options that are supported on the current +development environment and will be supported in future releases. +.SS Standard Options +.TP +\fB\-d\fR <\fIdirectory\fR> +Specify where to place generated class files. +.TP +\fB\-version\fR +Print product version and exit. +.TP +\fB\-? -help\fR +Print a synopsis of standard options. + +.\" +.\" ############################### EXAMPLES ################################# +.\" +.SH EXAMPLES +.TP +Generate documentation for a Scala program +.BR +\fBscaladoc\fR HelloWorld.scala +.TP +Generation documentation for a Scala program to the destination directory +\fBclasses\fR +.BR +\fBscaladoc\fR \-d api HelloWorld.scala +.TP +Generate documentation for all Scala files found in the source directory +\fBsrc\fR to the destination directory \fBapi\fR +.BR +\fBscaladoc\fR \-d api src/*.scala +.\" +.\" ############################# EXIT STATUS ################################ +.\" +.SH "EXIT STATUS" +\fBscaladoc\fR returns a zero exist status if it succeeds to process 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@listes.epfl.ch>. +.\" +.\" ############################# COPYRIGHT ################################## +.\" +.SH COPYRIGHT +Copyright \(co 2002-2006 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) +.\" +.\" ########################################################################## +.\" $Id: $ diff --git a/docs/man/man1/scalaint.1 b/docs/man/man1/scalaint.1 new file mode 100644 index 0000000000..7ab8a948d8 --- /dev/null +++ b/docs/man/man1/scalaint.1 @@ -0,0 +1,74 @@ +.\" ########################################################################## +.\" # __ # +.\" # ________ ___ / / ___ Scala 2 On-line Manual Pages # +.\" # / __/ __// _ | / / / _ | (c) 2002-2006, 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 \- Interpreter for the Scala 2 language +.\" +.\" ############################### SYNOPSIS ################################# +.\" +.SH SYNOPSIS +\fBscalaint\fR [ <\fIsource file\fR> ] +.\" +.\" ############################### PARAMETERS ############################### +.\" +.SH PARAMETERS +.TP +<\fIsource file\fR> +One source file to be interpreted (such as MyClass.scala). +.\" +.\" ############################## DESCRIPTION ############################### +.\" +.SH DESCRIPTION +The \fBscalaint\fR tool reads class and object definitions, written in the +Scala programming language, and interprets them in an interactive shell +environment. + +.\" +.\" ############################### EXAMPLES ################################# +.\" +.SH EXAMPLES +.TP +Interpret a Scala program +.BR +\fBscalaint\fR HelloWorld +.\" +.\" ############################## AUTHOR(S) ################################# +.\" +.SH AUTHOR +Written by Stephane Micheloud. +.\" +.\" ################################ BUGS #################################### +.\" +.SH "REPORTING BUGS" +Report bugs to <scala@listes.epfl.ch>. +.\" +.\" ############################# COPYRIGHT ################################## +.\" +.SH COPYRIGHT +Copyright \(co 2002-2006 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) +.\" +.\" ########################################################################## +.\" $Id: $ |