[yum-cvs] yum/docs yum.8,1.27,1.28 yum.conf.5,1.27,1.28

[Menno Smits]

Update of /home/groups/yum/cvs/yum/docs
In directory login:/tmp/cvs-serv30628

Modified Files:
	yum.8 yum.conf.5 
Log Message:
End user documentation for plugins.


Index: yum.8
===================================================================
RCS file: /home/groups/yum/cvs/yum/docs/yum.8,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- yum.8	13 Apr 2005 14:21:11 -0000	1.27
+++ yum.8	19 Apr 2005 04:23:57 -0000	1.28
@@ -252,10 +252,36 @@
 \fBepoch:name-ver-rel.arch\fP
 .IP
 For example: \fByum remove kernel-2.4.1-10.i686\fP.
+
+.PP 
+.SH "PLUGINS"
+Yum can be extended through the use of plugins. A plugin is a Python ".py" file
+which is installed in one of the directories specified by the \fBpluginpath\fP
+option in yum.conf. For a plugin to work, the following conditions must be met:
+.LP
+1. The plugin module file must be installed in the plugin path as just
+described.
+.LP
+2. The global \fBplugins\fP option in /etc/yum.conf must be set to `1'.
+.LP
+3. A configuration file for the plugin must exist in 
+/etc/yum/pluginconf.d/<plugin_name>.conf and the \fBenabled\fR setting in this
+file must set to `1'. The minimal content for such a configuration file is:
+.IP
+[main]
+.br
+enabled = 1
+.LP
+See the \fByum.conf(5)\fR man page for more information on plugin related
+configuration options.
+
 .PP
 .SH "FILES"
 .nf 
 /etc/yum.conf
+/etc/yum/repos.d/
+/etc/yum.repos.d/
+/etc/yum/pluginconf.d/
 /var/cache/yum/
 .fi 
 

Index: yum.conf.5
===================================================================
RCS file: /home/groups/yum/cvs/yum/docs/yum.conf.5,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- yum.conf.5	30 Mar 2005 11:00:06 -0000	1.27
+++ yum.conf.5	19 Apr 2005 04:23:57 -0000	1.28
@@ -189,7 +189,8 @@
 
 .IP \fBplugins \fR
 Either `0' or `1'. Global switch to enable or disable yum plugins. Default is
-`0' (plugins disabled).
+`0' (plugins disabled). See the \fBPLUGINS\fR section of the \fByum(8)\fR man
+for more information on installing yum plugins.
 
 .IP \fBpluginpath \fR
 A list of directories where yum should look for plugin modules. Default is
@@ -344,8 +345,12 @@
 
 
 .SH "FILES"
-.LP 
+.nf 
 /etc/yum.conf
+/etc/yum/repos.d/
+/etc/yum.repos.d/
+/etc/yum/pluginconf.d/
+
 .SH "SEE ALSO"
 .LP 
 yum(8)