summaryrefslogtreecommitdiff
path: root/doc/man/man1/scalarun.1
blob: 139829b3700ca8bed7f82e6d6301bfa02fd307f9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
.\" ##########################################################################
.\" #                      __                                                #
.\" #      ________ ___   / /  ___     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 scaladoc(1),
.BR scalaint(1)
.\"
.\" ##########################################################################
.\" $Id$