summaryrefslogblamecommitdiff
path: root/docs/man/scalap.1
blob: a1e5fcc2981b32f6585d9a1d7fc206bc67f4cab3 (plain) (tree)










































































































                                                                                                                                                                                                                                       
.\" ##########################################################################
.\" #                      __                                                #
.\" #      ________ ___   / /  ___     Scala 2 On-line Manual Pages          #
.\" #     / __/ __// _ | / /  / _ |    (c) 2002-2007, LAMP/EPFL              #
.\" #   __\ \/ /__/ __ |/ /__/ __ |                                          #
.\" #  /____/\___/_/ |_/____/_/ | |    http://scala-lang.org/                #
.\" #                           |/                                           #
.\" ##########################################################################
.\"
.\" Process this file with nroff -man scala.1
.\"
.TH scalap 1  "June 8, 2006" "version 0.2" "USER COMMANDS"
.\"
.\" ############################## NAME ###############################
.\"
.SH NAME
.PP
\fBscalap\fR \- Scala class file decoder for the Scala 2 language
.\"
.\" ############################## SYNOPSIS ###############################
.\"
.SH SYNOPSIS
.PP
\fBscalap\fR  [ <\fIoptions\fR> ] <\fIsource file\fR>
.\"
.\" ############################## PARAMETERS ###############################
.\"
.SH PARAMETERS
.PP
.TP
<\fIoptions\fR>
Command line options. See \fBOPTIONS\fR below.
.TP
<\fIsource file\fR>
One class file to be decoded (such as hello.HelloWorld).
.\"
.\" ############################## DESCRIPTION ###############################
.\"
.SH DESCRIPTION
.PP
The \fBscalap\fR tool reads a class file generated by theScala compiler, and displays object and class definitions.
.PP
By default, \fBscalap\fR looks for the given class file in the current directory. You can specify a separate classpath with \fB\-classpath\fR (see \fBOPTIONS\fR, below).
.\"
.\" ############################## OPTIONS ###############################
.\"
.SH OPTIONS
.PP
The decoder has a set of standard options that are supported on the current development environment and will be supported in future releases.
.\"
.\" ############################## Standard Options ###############################
.\"
.SS "Standard Options"
.PP
.TP
\fB\-help\fR 
Display this usage message.
.TP
\fB\-private\fR 
Print private definitions.
.TP
\fB\-verbose\fR 
Print out additional information.
.TP
\fB\-version\fR 
Print product version and exit.
.TP
\fB\-cp\fR | \fB\-classpath\fR 
Specify where to find user class files.
.\"
.\" ############################## EXAMPLES ###############################
.\"
.SH EXAMPLES
.PP
.TP
Display definitions for a generated class file
\fBscalap\fR hello.HelloWorld
.\"
.\" ############################## EXIT STATUS ###############################
.\"
.SH "EXIT STATUS"
.PP
\fBscalap\fR returns a zero exist status if it succeeds to process the specified input files. Non zero is returned in case of failure.
.\"
.\" ############################## AUTHOR ###############################
.\"
.SH AUTHOR
.PP
Written by Matthias Zenger.
.\"
.\" ############################## REPORTING BUGS ###############################
.\"
.SH "REPORTING BUGS"
.PP
Report bugs to <scala@listes.epfl.ch>.
.\"
.\" ############################## COPYRIGHT ###############################
.\"
.SH COPYRIGHT
.PP
This is open-source software, available to you under a BSD-like license. See accomponying "copyright" or "LICENSE" file for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\" ############################## SEE ALSO ###############################
.\"
.SH "SEE ALSO"
.PP
\fBfsc\fR(1), \fBsbaz\fR(1), \fBscala\fR(1), \fBscalac\fR(1), \fBscaladoc\fR(1)