[rhino] 04/09: Updated the man pages (Closes: #792243)
Emmanuel Bourg
ebourg-guest at moszumanska.debian.org
Fri Jan 20 10:09:25 UTC 2017
This is an automated email from the git hooks/post-receive script.
ebourg-guest pushed a commit to branch master
in repository rhino.
commit 0470ad7469cc922eaf6aadbd7059a4bd99413598
Author: Emmanuel Bourg <ebourg at apache.org>
Date: Fri Jan 20 00:25:40 2017 +0100
Updated the man pages (Closes: #792243)
---
debian/changelog | 1 +
debian/rhino-debugger.1 | 44 +++++++++++++++++++++++++++++++++-----------
debian/rhino-jsc.1 | 43 ++++++++++++++++++++++++++++---------------
debian/rhino.1 | 41 ++++++++++++++++++++++++++++++-----------
4 files changed, 92 insertions(+), 37 deletions(-)
diff --git a/debian/changelog b/debian/changelog
index a555abb..04069f4 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -9,6 +9,7 @@ rhino (1.7.7.1-1) UNRELEASED; urgency=medium
- Use the pom from the upstream sources to install the Maven artifacts,
and relocate the old coordinates rhino:js to org.mozilla:rhino
* Removed the transitional package rhino-doc
+ * Updated the man pages (Closes: #792243)
* Build with the DH sequencer instead of CDBS
* Simplified the usage syntax displayed with the --help option
* Removed the out of tree debugger classes (merged upstream)
diff --git a/debian/rhino-debugger.1 b/debian/rhino-debugger.1
index 24cbbab..9e2f843 100644
--- a/debian/rhino-debugger.1
+++ b/debian/rhino-debugger.1
@@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
-.TH RHINO-DEBUGGER 1 "Friday 17, 2009"
+.TH RHINO-DEBUGGER 1
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@@ -16,6 +16,7 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
+
rhino-debugger \- invokes the rhino JavaScript debugger GUI
.SH SYNOPSIS
@@ -25,36 +26,57 @@ rhino-debugger \- invokes the rhino JavaScript debugger GUI
.I [script_arguments]
.SH DESCRIPTION
+
This manual page documents briefly the
.B rhino-debugger
command.
-This manual page was written for the Debian distribution because the original
+This manual page was written for the Debian distribution because the original
program does not have a manual page. It is written according to the html documentation.
.PP
-\fBrhino-debugger\fP is a start script for the rhino JavaScript debugger. The Rhino JavaScript debugger is a GUI that allows debugging of interpreted JavaScript scripts run in Rhino. Note that this debugger will not work with JavaScript scripts run in the mozilla browser since Rhino is not the engine used in such environments.
+\fBrhino-debugger\fP is a start script for the rhino JavaScript debugger.
+The Rhino JavaScript debugger is a GUI that allows debugging of interpreted
+JavaScript scripts run in Rhino. Note that this debugger will not work with
+JavaScript scripts run in the mozilla browser since Rhino is not the engine
+used in such environments.
.SH OPTIONS
-.IP -e\ \fIscript_source\fP
-Executes script_source as a JavaScript script.
+.IP -w
+Enable warnings.
+.IP -version\ \fIversionNumber\fP
+Specifies the language version to compile with. The string versionNumber must be one of 100, 110, 120, 130, 140, 150, 160, 170, 180 or 200. See JavaScript Language Versions for more information on language$
+.IP -opt,\ -O\ \fIoptLevel\fP
+Optimizes at level optLevel, which must be an integer between -1 and 9. -1 means Interpretive mode is always used. 0 means no optimizations whereas 9 means all optimizations are performed.
.IP -f\ \fIscript_filename_or_url\fP
Reads script_filename_or_url content and execute it as a JavaScript script.
-.IP -opt,\ -O\ \fIoptLevel\fP
-Optimizes at level optLevel, which must be an integer between 0 and 9.
-.IP -version\ \fIversionNumber\fP
-Specifies the language version to compile with. The string versionNumber must be one of 100, 110, 120, 130, or 140. See JavaScript Language Versions for more information on language versions.
+.IP -e\ \fIscript_source\fP
+Executes script_source as a JavaScript script.
+.IP -modules\ \fIuri\fP
+Add a single path or URL element to the CommonJS module search path. (implies -require)
+.IP -require
+Enable CommonJS module support.
+.IP -sandbox
+Enable CommonJS sandbox mode. (implies -require)
+.IP -debug
+Generate debug code.
.IP -strict
Enable strict mode.
+.IP -fatal-warnings
+Treat warnings as errors.
+.IP -encoding\ \fIcharset\fP
+Use specified character encoding as default when reading scripts.
.SH EXAMPLE
Example debugging the NervousText.js applet written in JavaScript. The example is provided in the librhino-java-doc package.
-$ rhino-debugger NervousText.js
+$ rhino-debugger NervousText.js
.SH SEE ALSO
-The online documentation under http://www.mozilla.org/rhino/debugger.html
+
+The online documentation under https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino/Debugger
.SH AUTHOR
+
This manual page was written by Damien Raude-Morvan <drazzib at debian.org>,
for the Debian project (but may be used by others).
diff --git a/debian/rhino-jsc.1 b/debian/rhino-jsc.1
index 6b9face..c8c8bcb 100644
--- a/debian/rhino-jsc.1
+++ b/debian/rhino-jsc.1
@@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
-.TH RHINO-JSC 1 "February 12, 2005"
+.TH RHINO-JSC 1
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@@ -16,52 +16,65 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
+
rhino-jsc \- invokes the rhino JavaScript compiler
.SH SYNOPSIS
+
.B rhino-jsc
.I [options]
.I file1.js
.I [file2.js\&.\&.\&.]
.SH DESCRIPTION
+
This manual page documents briefly the
.B rhino-jsc
command.
-This manual page was written for the Debian distribution because the original
+This manual page was written for the Debian distribution because the original
program does not have a manual page. It is written according to the html documentation.
.PP
\fBrhino-jsc\fP is a start script for the rhino JavaScript compiler. The JavaScript compiler translates JavaScript source into Java class files. The resulting Java class files can then be loaded and executed at another time, providing a convenient method for transferring JavaScript, and for avoiding translation cost.
-Note that the top-level functions available to the shell (such as print) are not available to compiled scripts when they are run outside the shell.
+Note that the top-level functions available to the shell (such as print) are not available to compiled scripts when they are run outside the shell.
.SH OPTIONS
-.IP -extends\ \fIjava_class_name\fP
-Specifies that a java class extending the Java class java_class_name should be generated from the incoming JavaScript source file. Each global function in the source file is made a method of the generated class, overriding any methods in the base class by the same name.
-.IP -implements\ \fIjava_intf_name\fP
-Specifies that a java class implementing the Java interface java_intf_name should be generated from the incoming JavaScript source file. Each global function in the source file is made a method of the generated class, implementing any methods in the interface by the same name.
-.IP -debug,\ -g
+.IP -version\ \fIversionNumber\fP
+Specifies the language version to compile with. The string versionNumber must be one of 100, 110, 120, 130, 140, 150, 160 or 170. See JavaScript Language Versions for more information on language versions.
+.IP -opt,\ -O\ \fIoptLevel\fP
+Optimizes at level optLevel, which must be an integer between 0 and 9.
+.IP -debug,\ -g
Specifies that debug information should be generated. May not be combined with optimization at an optLevel greater than zero.
-.IP -nosource
+.IP -nosource
Does not save the source in the class file. Functions and scripts compiled this way cannot be decompiled. This option can be used to avoid distributing source or simply to save space in the resulting class file.
.IP -o\ \fIoutputFile\fP
Writes the class file to the given file (which should end in .class). The string outputFile must be a writable filename.
-.IP -opt,\ -O\ \fIoptLevel\fP
-Optimizes at level optLevel, which must be an integer between 0 and 9.
.IP -package\ \fIpackageName\fP
Specifies the package to generate the class into. The string packageName must be composed of valid identifier characters optionally separated by periods.
-.IP -version\ \fIversionNumber\fP
-Specifies the language version to compile with. The string versionNumber must be one of 100, 110, 120, 130, or 140. See JavaScript Language Versions for more information on language versions.
+.IP -d\ \fIoutputDirectory\fP
+Uses outputDirectory as destination directory for generated classes. If omitted, it defaults to parent directory of the source file.
+.IP -encoding\ \fIcharset\fP
+Sets the character encoding of the source files.
+.IP -extends\ \fIjava_class_name\fP
+Specifies that a java class extending the Java class java_class_name should be generated from the incoming JavaScript source file. Each global function in the source file is made a method of the generated class, overriding any methods in the base class by the same name.
+.IP -implements\ \fIjava_intf_name\fP
+Specifies that a java class implementing the Java interface java_intf_name should be generated from the incoming JavaScript source file. Each global function in the source file is made a method of the generated class, implementing any methods in the interface by the same name.
+.IP -main-method-class\ \fIclassName\fP
+Specifies the class name used for main method implementation. The class must have a method matching public static void main(Script sc, String[] args).
+.IP -observe-instruction-count
+Generates code that contains callbacks to accumulate counts of executed instructions. Code compiled with this flag can be monitored using Context.setInstructionObserverThreshold.
.SH EXAMPLE
Example compiling the NervousText.js applet written in JavaScript. The example is provided in the librhino-java-doc package.
-$ rhino-jsc \-extends java.applet.Applet \-implements java.lang.Runnable NervousText.js
+$ rhino-jsc \-extends java.applet.Applet \-implements java.lang.Runnable NervousText.js
.SH SEE ALSO
-The online documentation under http://www.mozilla.org/rhino/jsc.html
+
+The online documentation under https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino/JavaScript_Compiler
.SH AUTHOR
+
This manual page was written by Wolfgang Baer <WBaer at gmx.de>,
for the Debian project (but may be used by others).
diff --git a/debian/rhino.1 b/debian/rhino.1
index 99fdb05..610022c 100644
--- a/debian/rhino.1
+++ b/debian/rhino.1
@@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
-.TH RHINO 1 "February 12, 2005"
+.TH RHINO 1
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@@ -16,39 +16,56 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
+
rhino \- invokes the JavaScript shell for running scripts in batch mode or interactive
.SH SYNOPSIS
+
.B rhino
.I [options]
.I script_filename_or_url
.I [script_arguments]
.SH DESCRIPTION
+
This manual page documents briefly the
.B rhino
command.
-This manual page was written for the Debian distribution because the original
+This manual page was written for the Debian distribution because the original
program does not have a manual page. It is written according to the html documentation.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
-.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
-\fBrhino\fP is a start script for the rhino JavaScript shell which provides a simple way
+\fBrhino\fP is a start script for the rhino JavaScript shell which provides a simple way
to run scripts in batch mode or an interactive environment for exploratory programming.
.SH OPTIONS
-.IP -e\ \fIscript_source\fP
-Executes script_source as a JavaScript script.
-.IP -f\ \fIscript_filename_or_url\fP
-Reads script_filename_or_url content and execute it as a JavaScript script.
+.IP -w
+Enable warnings.
+.IP -version\ \fIversionNumber\fP
+Specifies the language version to compile with. The string versionNumber must be one of 100, 110, 120, 130, 140, 150, 160, 170, 180 or 200. See JavaScript Language Versions for more information on language versions.
.IP -opt,\ -O\ \fIoptLevel\fP
Optimizes at level optLevel, which must be an integer between -1 and 9. -1 means Interpretive mode is always used. 0 means no optimizations whereas 9 means all optimizations are performed.
-.IP -version\ \fIversionNumber\fP
-Specifies the language version to compile with. The string versionNumber must be one of 100, 110, 120, 130, or 140. See JavaScript Language Versions for more information on language versions.
+.IP -f\ \fIscript_filename_or_url\fP
+Reads script_filename_or_url content and execute it as a JavaScript script.
+.IP -e\ \fIscript_source\fP
+Executes script_source as a JavaScript script.
+.IP -modules\ \fIuri\fP
+Add a single path or URL element to the CommonJS module search path. (implies -require)
+.IP -require
+Enable CommonJS module support.
+.IP -sandbox
+Enable CommonJS sandbox mode. (implies -require)
+.IP -debug
+Generate debug code.
.IP -strict
Enable strict mode.
+.IP -fatal-warnings
+Treat warnings as errors.
+.IP -encoding\ \fIcharset\fP
+Use specified character encoding as default when reading scripts.
.SH PREDEFINED PROPERTIES
@@ -86,8 +103,10 @@ Quit shell. The shell will also quit in interactive mode if an end-of-file chara
Get or set JavaScript version number. If no argument is supplied, the current version number is returned. If an argument is supplied, it is expected to be one of 100, 110, 120, 130, or 140 to indicate JavaScript version 1.0, 1.1, 1.2, 1.3, or 1.4 respectively.
.SH SEE ALSO
-The online documentation under http://www.mozilla.org/rhino/shell.html
+
+The online documentation under https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino/Shell
.SH AUTHOR
+
This manual page was written by Wolfgang Baer <WBaer at gmx.de>,
for the Debian project (but may be used by others).
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/rhino.git
More information about the pkg-java-commits
mailing list