changeset 920:f58e426ca958

Add man page for PolicyEditor * Makefile.am: (install-data-local, uninstall-local): added policyeditor.1 man page * netx/policyeditor.1: new man page for PolicyEditor
author Andrew Azores <aazores@redhat.com>
date Mon, 10 Mar 2014 16:30:44 -0400
parents bd7ce0fce548
children 7487d725b294
files Makefile.am netx/policyeditor.1
diffstat 2 files changed, 72 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/Makefile.am	Mon Mar 10 15:44:51 2014 -0400
+++ b/Makefile.am	Mon Mar 10 16:30:44 2014 -0400
@@ -257,6 +257,7 @@
 	${mkinstalldirs} -d $(DESTDIR)$(mandir)/man1
 	${INSTALL_DATA} $(NETX_SRCDIR)/javaws.1 $(DESTDIR)$(mandir)/man1
 	${INSTALL_DATA} $(NETX_SRCDIR)/itweb-settings.1 $(DESTDIR)$(mandir)/man1
+	${INSTALL_DATA} $(NETX_SRCDIR)/policyeditor.1 $(DESTDIR)$(mandir)/man1
 if ENABLE_DOCS
 	${mkinstalldirs} $(DESTDIR)$(htmldir)
 	(cd ${abs_top_builddir}/docs/netx; \
@@ -278,6 +279,8 @@
 	rm -f $(DESTDIR)$(datadir)/$(PACKAGE_NAME)/plugin.jar
 	rm -f $(DESTDIR)$(datadir)/$(PACKAGE_NAME)/netx.jar
 	rm -f $(DESTDIR)$(mandir)/man1/javaws.1
+	rm -f $(DESTDIR)$(mandir)/man1/itweb-settings.1
+	rm -f $(DESTDIR)$(mandir)/man1/policyeditor.1
 	rm -f $(DESTDIR)$(bindir)/$(javaws)
 	rm -f $(DESTDIR)$(bindir)/$(itweb_settings)
 	rm -f $(DESTDIR)$(bindir)/$(policyeditor)
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/netx/policyeditor.1	Mon Mar 10 16:30:44 2014 -0400
@@ -0,0 +1,69 @@
+.TH policyeditor 1 "10 Mar 2014"
+
+.SH NAME
+
+policyeditor - view and modify security policy settings for
+.B javaws
+and the browser plugin
+
+.SH SYNOPSIS
+
+.B policyeditor
+.br
+.B policyeditor [-file]
+policy_file
+.SH DESCRIPTION
+.B policyeditor
+is a command line program to view and edit applet security policy settings
+used by the icedtea-web implementation of
+.B javaws
+and the browser plugin. It is intended as a simpler, easier to use, and more
+accessible alternative to the standard JDK Policy Tool. Administrators and
+power users who need fine grained control over policy files should probably
+use Policy Tool instead of PolicyEditor.
+
+If executed without any arguments, no file is opened, and saving the file will
+result in a prompt on where to save it. Otherwise, if a file path is given as
+a command line argument, then that file path will be opened and parsed as a
+policy file.
+
+
+.SH OPTIONS
+
+.TP
+-file
+Specifies a policy file path to open. If this is not given as an argument, the
+first argument given is interpreted as a file path to open anyway. This switch
+exists mostly for compatibility with Policy Tool.
+
+.SH EXAMPLES
+
+.TP
+policyeditor
+Show the GUI editor
+
+.TP
+policyeditor -file $HOME/.config/icedtea-web/security/java.policy
+Opens the default user-level policy file location
+
+
+.SH FILES
+
+$HOME/.config/icedtea-web/security/java.policy the default user-level policy file location
+
+.SH BUGS
+
+There aren't 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 policytool (1),
+.BR javaws (1),
+.BR java (1)
+.br
+http://icedtea.classpath.org/wiki/IcedTea-Web