Changes

From SME Server
Jump to navigationJump to search
Splitting the SME Server Developers Guide (and relocating)
<div class="PART"><div class="TITLEPAGE">

=V. Documentation and resources=

<div class="TOC">

; '''Table of Contents'''
; 16. [http://wiki.contribs.org/The_SME_Server_Developer%27s_Guide#DOCUMENTATION Perl modules]

</div></div><div class="CHAPTER">
----

=Chapter 16. Perl modules=

If you are not already familiar with the Perl programming language, you will need to read up on at least the basics. One online course is available from http://sourceforge.net/projects/spork.

The SME Server has a wealth of Perl libraries to perform common functions including manipulating the configuration database, performing common CGI tasks, etc. The modules available include:

* <code class="CLASSNAME">esmith::ConfigDB</code>
* <code class="CLASSNAME">esmith::AccountsDB</code>
* <code class="CLASSNAME">esmith::NetworksDB</code>
* <code class="CLASSNAME">esmith::HostsDB</code>
* <code class="CLASSNAME">esmith::NetworkServicesDB</code>
* <code class="CLASSNAME">esmith::DB</code>
* <code class="CLASSNAME">esmith::FormMagick</code>
* <code class="CLASSNAME">CGI::FormMagick</code>
* <code class="CLASSNAME">Text::Template</code>

The following libraries are also installed for compatibility with older code, but they should no longer be used. <span class="emphasis">''These libraries may be removed in future releases.''</span>

* <code class="CLASSNAME">esmith::util</code> (deprecated)
* <code class="CLASSNAME">esmith::db</code> (deprecated)
* <code class="CLASSNAME">esmith::cgi</code> (deprecated)

The documentation can be accessed from the Linux command line on your SME Server by typing '''perldoc esmith::ConfigDB''' (or whatever module name you're interested in).

More information about building RPMs can be found at http://www.rpm.org/RPM-HOWTO/build.html. This is especially recommended if you wish to use anything more than the extremely simple outline given above. For instance, you may wish to to build RPMs using original source and patches or include more detail and functionality in your spec file.

</div></div>

Navigation menu