changeset 915:2157f0e06002

Add man page for itweb-settings 2014-03-10 Omair Majid <omajid@redhat.com> * Makefile.am (install-data-local): Install itweb-settings.1. * netx/itweb-settings.1: New file.
author Omair Majid <omajid@redhat.com>
date Mon, 10 Mar 2014 11:57:12 -0400
parents bc97499d95f4
children 17c6e5a59602
files ChangeLog Makefile.am netx/itweb-settings.1
diffstat 3 files changed, 96 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Mon Mar 10 16:02:39 2014 +0100
+++ b/ChangeLog	Mon Mar 10 11:57:12 2014 -0400
@@ -1,3 +1,8 @@
+2014-03-10  Omair Majid  <omajid@redhat.com>
+
+	* Makefile.am (install-data-local): Install itweb-settings.1.
+	* netx/itweb-settings.1: New file.
+
 2014-03-10  Jiri Vanek  <jvanek@redhat.com>
 
 	Added getter for java-abrt-connector on demand whitelist of fields.
--- a/Makefile.am	Mon Mar 10 16:02:39 2014 +0100
+++ b/Makefile.am	Mon Mar 10 11:57:12 2014 -0400
@@ -256,6 +256,7 @@
 install-data-local:
 	${mkinstalldirs} -d $(DESTDIR)$(mandir)/man1
 	${INSTALL_DATA} $(NETX_SRCDIR)/javaws.1 $(DESTDIR)$(mandir)/man1
+	${INSTALL_DATA} $(NETX_SRCDIR)/itweb-settings.1 $(DESTDIR)$(mandir)/man1
 if ENABLE_DOCS
 	${mkinstalldirs} $(DESTDIR)$(htmldir)
 	(cd ${abs_top_builddir}/docs/netx; \
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/netx/itweb-settings.1	Mon Mar 10 11:57:12 2014 -0400
@@ -0,0 +1,90 @@
+.TH itweb-settings 1 "07 Mar 2014"
+
+.SH NAME
+
+itweb-settings - view and modify settings for
+.B
+javaws
+and the browser plugin
+
+.SH SYNOPSYS
+
+.B itweb-settings
+.br
+.B itweb-settings
+command arguments
+.SH DESCRIPTION
+.B itweb-settings
+is a command line and a GUI program to modify and edit settings used by the
+icedtea-web implementation of
+.B javaws
+and the browser plugin.
+
+If executed without any arguments, it starts up a GUI. Otherwise, it tries to
+do what is specified in the argument.
+
+The command-line allows quickly searching, making a copy of and modifying
+specific settings without having to hunt through a UI.
+
+
+.SH COMMANDS
+
+.TP
+help
+Prints out information about supported command, descriptions and basic usage.
+.TP 12
+list
+Shows a list of all settings.
+.TP
+get <name>
+Shows the value of the named setting.
+.TP
+info <name>
+Shows additional information about the named setting. Includes a description,
+the current value, the possible values, and the source of the setting.
+.TP
+set <name> <value>
+Sets the setting to the new value, after checking that it is an appropriate
+value.
+.TP
+reset all
+Resets all settings to their original values.
+.TP
+reset <name>
+Resets the named setting to its original value.
+.TP
+check <name>
+Checks that the current value of the setting is a valid value.
+
+.SH EXAMPLES
+
+.TP
+itweb-settings
+
+Show the GUI editor
+
+.TP
+itweb-settings reset deployment.proxy.type
+
+Resets the value of 'deployment.proxy.type' setting.
+
+
+.SH FILES
+
+$XDG_CONFIG_HOME/icedtea-web/deployment.properties specifies the settings used
+
+.SH BUGS
+
+There arent any known bugs. If you come across one, please file it at
+    http://icedtea.classpath.org/bugzilla/
+
+.SH AUTHOR
+
+Written and maintained by the IcedTea contributors.
+
+.SH SEE ALSO
+
+.BR javaws (1),
+.BR java (1)
+.br
+http://icedtea.classpath.org/wiki/IcedTea-Web