[icedtea-web] RFC: man page for itweb-settings

Omair Majid omajid at redhat.com
Sat Mar 8 00:28:09 UTC 2014


Hi,

This is a very simple man page for itweb-settings. Okay to push?

Thanks,
Omair

-- 
PGP Key: 66484681 (http://pgp.mit.edu/)
Fingerprint = F072 555B 0A17 3957 4E95  0056 F286 F14F 6648 4681
-------------- next part --------------
diff --git a/ChangeLog b/ChangeLog
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2014-03-07  Omair Majid <omajid at redhat.com>
+
+	* Makefile.am (install-data-local): Install itweb-settings.1.
+	* netx/itweb-settings.1: New file.
+
 2014-03-06  Andrew Azores  <aazores at redhat.com>
 
 	* NEWS: added -version flag entry
diff --git a/Makefile.am b/Makefile.am
--- a/Makefile.am
+++ b/Makefile.am
@@ -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; \
diff --git a/netx/itweb-settings.1 b/netx/itweb-settings.1
new file mode 100644
--- /dev/null
+++ b/netx/itweb-settings.1
@@ -0,0 +1,79 @@
+.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
+[options] 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 OPTIONS
+
+.TP 12
+--help
+Shows some helpful information about the program
+
+.SH COMMANDS
+
+.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
+.B itweb-settings
+
+Show the GUI editor
+
+.SH FILES
+~/$XDG_CONFIG_DIR/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


More information about the distro-pkg-dev mailing list