README file for the sample plugin that tells the user how to build,

install and enable it.

diff --git a/MANIFEST b/MANIFEST
index 1e82b5130897c3c37fc063e1cf0997f1dd3039b1..1f91f156d07ee2d9a7aa07c744b99f9ed7972a35 100644 (file)
--- a/MANIFEST
+++ b/MANIFEST
@@ -224,6 +224,7 @@ plugins/group_file/group_file.c
 plugins/group_file/group_file.exp
 plugins/group_file/plugin_test.c
 plugins/sample/Makefile.in
+plugins/sample/README
 plugins/sample/sample_plugin.c
 plugins/sample/sample_plugin.exp
 plugins/sudoers/Makefile.in

diff --git a/plugins/sample/README b/plugins/sample/README
new file mode 100644 (file)
index 0000000..45c2b78
--- /dev/null
+++ b/plugins/sample/README
@@ -0,0 +1,23 @@
+This is a sample sudo policy plugin.  See the sudo_plugin manual for
+information on writing your own plugin.
+
+The sample policy plugin is not built or installed by default.  To
+build and install the plugin, change to the plugins/sample directory
+and run "make".  It can be installed by running "make install" as
+the superuser from the same directory.
+
+To actually use the sample plugin, you'll need to modify the
+/etc/sudo.conf file.  Caution: you should not make changes to
+/etc/sudo.conf without also having a root shell open repair things
+in case of an error.  To enable the plugin, first comment out any
+existing policy Plugin line in /etc/sudo.conf, for example:
+
+    Plugin sudoers_policy sudoers.so
+
+Then add a line for the sample plugin:
+
+    Plugin sample_policy sample_plugin.so
+
+You may need to create /etc/sudo.conf if it does not already exist.
+
+Note that you may only have a single policy plugin defined.