/hg/release/icedtea-web-1.5: Fix javaws.1 man page typos and for...

Sun Sep 21 14:44:22 UTC 2014

changeset e66c55de3d22 in /hg/release/icedtea-web-1.5
details: http://icedtea.classpath.org/hg/release/icedtea-web-1.5?cmd=changeset;node=e66c55de3d22
author: Andrew Azores <aazores at redhat.com>
date: Sun Sep 21 10:43:48 2014 -0400

	Fix javaws.1 man page typos and formatting

	2014-09-21  Andrew Azores  <aazores at redhat.com>

	    * netx/javaws.1: Fixed typos, made formatting more consistent, and added
	    missing documentation for -Xoffline switch.


diffstat:

 ChangeLog     |   5 ++++
 netx/javaws.1 |  72 +++++++++++++++++++++++++++++++++++++---------------------
 2 files changed, 51 insertions(+), 26 deletions(-)

diffs (166 lines):

diff -r 4f76df2f1438 -r e66c55de3d22 ChangeLog

--- a/ChangeLog	Fri Aug 15 09:49:16 2014 +0200
+++ b/ChangeLog	Sun Sep 21 10:43:48 2014 -0400
@@ -1,3 +1,8 @@
+2014-09-21  Andrew Azores  <aazores at redhat.com>
+
+	* netx/javaws.1: Fixed typos, made formatting more consistent, and added
+	missing documentation for -Xoffline switch.
+
 2014-08-15  Jiri Vanek  <jvanek at redhat.com>
 
 	Post 1.5 changes
diff -r 4f76df2f1438 -r e66c55de3d22 netx/javaws.1
--- a/netx/javaws.1	Fri Aug 15 09:49:16 2014 +0200
+++ b/netx/javaws.1	Sun Sep 21 10:43:48 2014 -0400
@@ -1,4 +1,4 @@
-.TH javaws 1 "9 Sep 2010"
+.TH javaws 1 "23 Aug 2014"
 .SH NAME
 javaws - a Java Web Start client
 .SH SYNOPSIS
@@ -15,22 +15,22 @@
 .B javaws
 is from the IcedTea project and is based on the NetX project.
 .PP
-A JNLP file is an xml file that describes how to securely run a
+A JNLP file is an XML file that describes how to securely run a
 remote Java application or a Java applet.
 
 .SH OPTIONS
-When specifying options, the name of the jnlp file must be the last
+When specifying options, the name of the JNLP file must be the last
 argument to
 .B javaws
-- all the options must preceede it.
+- all the options must precede it.
 .PP
-The jnlp-file can either be a url or a local path.
+The JNLP-file can either be a URL or a local path.
 .PP
 .B Control Options
 .PP
 By default
 .B javaws
-will launch the jnlp file specified on the command line. The control
+will launch the JNLP file specified on the command line. The control
 options can be used to change this behaviour.
 .TP 12
 \-about
@@ -61,7 +61,7 @@
 Sets a system property before launching.
 .TP
 \-update seconds
-Update check if seconds since last checked.
+Check for applet/application updates if "seconds" seconds have elapsed since the last check.
 .TP
 \-license
 Display the GPL license and exit.
@@ -76,7 +76,7 @@
 Disables checking for updates.
 .TP
 \-headless
-Disables download window, other UIs.
+Disables the download window and other extra UI elements.
 .TP
 \-strict
 Enables strict checking of JNLP file format. Any deviations from
@@ -85,11 +85,18 @@
 to abort.
 .TP
 \-xml
-The jnlp files will be checked more strictly for XML validity
+Enables stricter XML validity checking for JNLP files.
 .TP
 \-allowredirect
-Allow to follow 301, 302, 303, 307 and 308 redirections for javaws
-applications
+Enables following 301, 302, 303, 307 and 308 HTTP redirects for
+.B javaws
+applications.
+.TP
+\-Xoffline
+IcedTea-Web will not attempt to connect to the network to check for or download
+newer versions of the requested applet or application. Locally cached application
+files will be used instead, if available. The application itself may still
+establish its own network connections.
 .TP
 \-Xnofork
 Do not create another JVM, even if the JNLP file asks for running in
@@ -102,41 +109,53 @@
 Skip jar header verification.
 .TP
 \-Jjava-option
-This passes along java-option to the java binary that is running
-javaws. For example, to make javaws run with a max heap size
+This passes along java-option to the Java binary (JVM) which
+.B javaws
+will be executed within. For example, to make
+.B javaws
+run with a max heap size
 of 80m, use -J-Xmx80m.
 .TP
 \-help
-Print a help message and exit.
+Print the
+.B javaws
+help message and exit.
 
 .SH FILES
-$XDG_CONFIG_DIR/icedtea-web/deployment.properties specifies the settings used by javaws
+$XDG_CONFIG_DIR/icedtea-web/deployment.properties specifies the settings used by
+.B javaws
 
 $XDG_CONFIG_DIR/icedtea-web/log (may be set to different location by you) contains file log files (if enabled).
 itw-cplugin-date_time.log for native part of plugin, itw-javantx-date_time.log for everything else.
 
-$XDG_CONFIG_DIR/icedtea-web/security/java.policy contains granted permissions for selected unsigned apps
+$XDG_CONFIG_DIR/icedtea-web/security/java.policy contains the user's security policy, which may grant extra permissions to applets.
 
-$XDG_CONFIG_DIR/icedtea-web/security/trusted.*certs contains various stored certificates
+$XDG_CONFIG_DIR/icedtea-web/security/trusted.*certs contains various stored certificates.
 
-$XDG_CACHE_DIR/icedtea-web/cache contains cached runtime entries (amy be changed by you)
+$XDG_CACHE_DIR/icedtea-web/cache contains cached runtime entries (may be modified by the user).
 
-$XDG_CACHE_DIR/icedtea-web/pcache contains saved application data
+$XDG_CACHE_DIR/icedtea-web/pcache contains saved application data.
 
-$XDG_CACHE_DIR/icedtea-web/tmp contains temporary runtime files
+$XDG_CACHE_DIR/icedtea-web/tmp contains temporary runtime files.
 
 $XDG_RUNTIME_DIR/icedteaplugin-user-*/ contains in and out pipe for native<->java communication and
 (if enabled) debugging pipe
 
-Where $XDG_CONFIG_DIR, $XDG_CACHE_DIR and $XDG_RUNTIME_DIR are set as ~/.config, ~/.cache and /tmp or /var/tmp if not set.
+Where $XDG_CONFIG_DIR, $XDG_CACHE_DIR and $XDG_RUNTIME_DIR are defined as $HOME/.config, $HOME/.cache and either /tmp or /var/tmp by default.
+This is in accordance with the FreeDesktop Base Directory Specification:
+    http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
 
 .SH BUGS
-There arent any known bugs. If you come across one, please file it at
+There aren't any known bugs. If you come across one, please file it at
     http://icedtea.classpath.org/bugzilla/
 .br
-Please run javaws in debug (-verbose switch or itw-settings setting or ICEDTEAPLUGIN_DEBUG variable set to true)
-mode and include that output (best is from java console) with URL to jnlp or html file
-(ot the jnlp/html file or application itself)  when filing out the bug report.
+Please run
+.B javaws
+in debug (via -verbose switch, 
+.B itweb-settings
+configuration, or ICEDTEAPLUGIN_DEBUG environment variable set to true)
+mode and include that output (best is from java console) with URL to JNLP or HTML file
+(not the JNLP/HTML file or application itself) when filing out the bug report.
 
 .SH AUTHOR
 Originally written by Jon. A. Maxwell.
@@ -144,6 +163,7 @@
 Currently maintained by the IcedTea contributors. See javaws -about for more info
 
 .SH SEE ALSO
-.BR java (1)
+.BR java (1), 
+.BR itweb-settings (1)
 .br
 http://icedtea.classpath.org/wiki/IcedTea-Web
