[patch] add a man page for javaws

Dr Andrew John Hughes ahughes at redhat.com
Thu Sep 9 14:10:03 PDT 2010 

On 14:37 Thu 09 Sep     , Omair Majid wrote:
> Hi,
> 
> OpenJDK6 contains a man page for javaws, but it has two problems:
>   - it not applicable to netx which has different quirks and options
>   - openjdk's javaws man page is only "built" on a 32 bit arch.
> 
> The attached patch adds a man page for javaws, which overwrites the one 
> from openjdk. This man page should be much more relevant to anyone using 
> IcedTea. Any comments or concerns?
> 

Looks good.  I'm surprised this hasn't been picked up before!

Approved for HEAD and all three branches (1.7, 1.8 and 1.9)

> 2010-09-09  Omair Majid  <omajid at redhat.com>
> 
>      Add a new man page for netx's javaws.
>      * Makefile.am
>      (stamps/add-netx.stamp): Copy over the javaws man page into the
>      build.
>      (clean-add-netx): Remove the javaws man pages on clean.
>      (stamps/add-netx-debug.stamp): Copy over the javaws man page.
>      (clean-add-netx-debug): Remove the javaws man page.
>      * netx/javaws.1: New man page for netx's javaws.
> 
> Cheers,
> Omair

> diff -r e8452eabe369 Makefile.am
> --- a/Makefile.am	Wed Sep 08 13:16:22 2010 +0100
> +++ b/Makefile.am	Thu Sep 09 14:15:03 2010 -0400
> @@ -1422,6 +1422,10 @@
>  	  $(BUILD_OUTPUT_DIR)/j2sdk-image/jre/lib
>  	cp $(NETX_RESOURCE_DIR)/about.jnlp extra-lib/about.jar \
>  	  $(BUILD_OUTPUT_DIR)/j2re-image/lib
> +	cp $(NETX_SRCDIR)/javaws.1 \
> +	  $(BUILD_OUTPUT_DIR)/j2sdk-image/man/man1
> +	cp $(NETX_SRCDIR)/javaws.1 \
> +	  $(BUILD_OUTPUT_DIR)/j2re-image/man/man1
>  	touch stamps/add-netx.stamp
>  
>  clean-add-netx:
> @@ -1431,6 +1435,8 @@
>  	rm -f $(BUILD_OUTPUT_DIR)/j2sdk-image/jre/lib/about.jar
>  	rm -f $(BUILD_OUTPUT_DIR)/j2re-image/lib/about.jnlp
>  	rm -f $(BUILD_OUTPUT_DIR)/j2re-image/lib/about.jar
> +	rm -f $(BUILD_OUTPUT_DIR)/j2sdk-image/man/man1/javaws.1
> +	rm -f $(BUILD_OUTPUT_DIR)/j2re-image/man/man1/javaws.1
>  	rm -f stamps/add-netx.stamp
>  
>  stamps/add-netx-debug.stamp: stamps/netx-dist.stamp extra-lib/about.jar
> @@ -1442,6 +1448,10 @@
>  	  $(DEBUG_BUILD_OUTPUT_DIR)/j2sdk-image/jre/lib
>  	cp $(NETX_RESOURCE_DIR)/about.jnlp extra-lib/about.jar \
>  	  $(DEBUG_BUILD_OUTPUT_DIR)/j2re-image/lib
> +	cp $(NETX_SRCDIR)/javaws.1 \
> +	  $(DEBUG_BUILD_OUTPUT_DIR)/j2sdk-image/man/man1
> +	cp $(NETX_SRCDIR)/javaws.1 \
> +	  $(BUILD_OUTPUT_DIR)/j2re-image/man/man1
>  	touch stamps/add-netx-debug.stamp
>  
>  clean-add-netx-debug:
> @@ -1451,6 +1461,8 @@
>  	rm -f $(DEBUG_BUILD_OUTPUT_DIR)/j2sdk-image/jre/lib/about.jar
>  	rm -f $(DEBUG_BUILD_OUTPUT_DIR)/j2re-image/lib/about.jnlp
>  	rm -f $(DEBUG_BUILD_OUTPUT_DIR)/j2re-image/lib/about.jar
> +	rm -f $(DEBUG_BUILD_OUTPUT_DIR)/j2sdk-image/man/man1/javaws.1
> +	rm -f $(DEBUG_BUILD_OUTPUT_DIR)/j2re-image/man/man1/javaws.1
>  	rm -f stamps/add-netx-debug.stamp
>  
>  # OpenJDK ecj Targets
> @@ -2166,6 +2178,10 @@
>  
>  netx-dist: stamps/netx-dist.stamp
>  
> +add-netx: stamps/add-netx.stamp
> +
> +add-netx-debug: stamps/add-netx-debug.stamp
> +
>  overlay: stamps/overlay.stamp
>  
>  patch: stamps/patch.stamp
> diff -r e8452eabe369 netx/javaws.1
> --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
> +++ b/netx/javaws.1	Thu Sep 09 14:15:03 2010 -0400
> @@ -0,0 +1,123 @@
> +.TH javaws 1 "9 Sep 2010"
> +.SH NAME
> +javaws - a Java Web Start client
> +.SH SYNOPSYS
> +.B javaws
> +[-run-options] jnlp-file
> +.br
> +.B javaws
> +[-control-option]
> +.SH DESCRIPTION
> +.B javaws
> +is an implementation of a JNLP  client. It uses a JNLP (Java Network
> +Launch Protocol) file to securely run a remote Java application or
> +a Java applet.  This implementation of
> +.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
> +remote Java application or a Java applet.
> +
> +.SH OPTIONS
> +When specifying options, the name of the jnlp file must be the last
> +argument to
> +.B javaws
> +- all the options must preceede it.
> +.PP
> +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
> +options can be used to change this behaviour.
> +.TP 12
> +\-about
> +Shows a sample application that can be used to test the basic functionality
> +of this implementation.
> +.TP
> +\-viewer
> +Shows the trusted certificate viewer. This allows a user to list, examine, remove
> +or export trusted certificates. Note that this only reflects the certificates
> +trusted by
> +.B javaws
> +and not any other certificates or programs.
> +
> +.PP
> +.B Run Options
> +.PP
> +In the default mode, the following run-options can be used:
> +.TP 12
> +\-basedir dir
> +Directory where the cache and certificates to be used are stored.
> +.TP
> +\-arg arg
> +Adds an application argument before launching.
> +.TP
> +\-param name=value
> +Adds an applet parameter before launching.
> +.TP
> +\-property name=value
> +Sets a system property before launching.
> +.TP
> +\-update seconds
> +Update check if seconds since last checked.
> +.TP
> +\-license
> +Display the GPL license and exit.
> +.TP
> +\-verbose
> +Enable verbose output. Very useful in debugging.
> +.TP
> +\-nosecurity
> +Disables the secure runtime environment.
> +.TP
> +\-noupdate
> +Disables checking for updates.
> +.TP
> +\-headless
> +Disables download window, other UIs.
> +.TP
> +\-strict
> +Enables strict checking of JNLP file format. Any deviations from
> +the JNLP DTD will cause
> +.B javaws
> +to abort.
> +.TP
> +\-umask=value
> +Sets the umask for files created by an application.
> +.TP
> +\-Xnofork
> +Do not create another JVM, even if the JNLP file asks for running in
> +a separate JVM. This is useful for debugging.
> +.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
> +of 80m, use -J-Xmx80m.
> +.TP
> +\-help
> +Print a help message and exit.
> +
> +.SH FILES
> +~/.netxrc specifies the location of the base directory
> +
> +.SH BUGS
> +There arent any known bugs. If you come across one, please file it at
> +    http://icedtea.classpath.org/bugzilla/
> +.br
> +Please run javaws in verbose mode and include that output along
> +with the jnlp file when filing out the bug report.
> +
> +.SH AUTHOR
> +Originally written by Jon. A. Maxwell.
> +.br
> +Currently maintained by the IcedTea contributors.
> +
> +.SH SEE ALSO
> +.BR java (1)
> +.br
> +http://icedtea.classpath.org/
> +.br
> +http://jnlp.sourceforge.net/netx/


-- 
Andrew :)

Free Java Software Engineer
Red Hat, Inc. (http://www.redhat.com)

Support Free Java!
Contribute to GNU Classpath and the OpenJDK
http://www.gnu.org/software/classpath
http://openjdk.java.net
PGP Key: 94EFD9D8 (http://subkeys.pgp.net)
Fingerprint = F8EF F1EA 401E 2E60 15FA  7927 142C 2591 94EF D9D8

More information about the distro-pkg-dev mailing list