summaryrefslogtreecommitdiff
path: root/docs/man/src/man/man1/scalaint.scala
blob: bc3e18866f634418045b233ee8d5ae910e466e37 (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
/* NSC -- new Scala compiler
 * Copyright 2005-2006 LAMP/EPFL
 * @author Stephane Micheloud
 */
//$Id$

package man.man1

object scalaint extends Command {
  import ManPage._

  protected val cn = new Error().getStackTrace()(0).getClassName()

  val name = Section("NAME",

    MBold(command) & " " & NDash & " Interpreter for the " &
    Link("Scala 2", "http://scala.epfl.ch/") & " language")

  val synopsis = Section("SYNOPSIS",

    CmdLine(" [ " & Argument("source file") & " ]"))

  val parameters = Section("PARAMETERS",

    DefinitionList(
      Definition(
        Mono(Argument("source file")),
        "One source file to be interpreted (such as " &
        Mono("MyClass.scala") & ").")))

  val description = Section("DESCRIPTION",

    "The " & MBold(command) & " tool reads class and object definitions, " &
    "written in the Scala programming language, and interprets them in an " &
    "interactive shell environment.",

    "The shell environment provides the following internal commands:",

    CodeSample("This is an interpreter for Scala.\n" +
      "Type in expressions to have them evaluated.\n" +
      "Type :quit to exit the interpreter.\n" +
      "Type :compile followed by a filename to compile a complete Scala file.\n" +
      "Type :load followed by a filename to load a sequence of interpreter commands.\n" +
      "Type :replay to reset execution and replay all previous commands.\n" +
      "Type :help to repeat this message later.\n\n" +
      "scala>"))

  val examples = Section("EXAMPLES",

    DefinitionList(
      Definition(
        "Interpret a Scala program",
        CmdLine("HelloWorld"))))

  val seeAlso = Section("SEE ALSO",

    Link(Bold("sbaz") & "(1)", "sbaz.html") & ", " &
    Link(Bold("scala") & "(1)", "scala.html") & ", " &
    Link(Bold("scalac") & "(1)", "scalac.html") & ", " &
    Link(Bold("scaladoc") & "(1)", "scaladoc.html") & ", " &
    Link(Bold("scalap") & "(1)", "scalap.html") & ", " &
    Link(Bold("scalascript") & "(1)", "scalascript.html"))

  def manpage = new Document {
    title = command
    date = "June 8, 2006"
    author = "Stephane Micheloud"
    version = "0.2"
    sections = List(
      name,
      synopsis,
      parameters,
      description,
      examples,
      authors,
      bugs,
      copyright,
      seeAlso)
  }
}