You are here

function syslog_help in Drupal 6

Same name and namespace in other branches
  1. 8 core/modules/syslog/syslog.module \syslog_help()
  2. 7 modules/syslog/syslog.module \syslog_help()
  3. 9 core/modules/syslog/syslog.module \syslog_help()

Implementation of hook_help().

File

modules/syslog/syslog.module, line 18

Code

function syslog_help($path, $arg) {
  switch ($path) {
    case 'admin/help#syslog':
      $output = '<p>' . t("The syslog module enables Drupal to send messages to the operating system's logging facility.") . '</p>';
      $output .= '<p>' . t('Syslog is an operating system administrative logging tool, and provides valuable information for use in system management and security auditing. Most suited to medium and large sites, syslog provides filtering tools that allow messages to be routed by type and severity. On UNIX/Linux systems, the file /etc/syslog.conf defines this routing configuration; on Microsoft Windows, all messages are sent to the Event Log. For more information on syslog facilities, severity levels, and how to set up a syslog.conf file, see <a href="@syslog_conf">UNIX/Linux syslog.conf</a> and PHP\'s <a href="@php_openlog">openlog</a> and <a href="@php_syslog">syslog</a> functions.', array(
        '@syslog_conf' => url('http://www.rt.com/man/syslog.5.html'),
        '@php_openlog' => url('http://www.php.net/manual/en/function.openlog.php'),
        '@php_syslog' => url('http://www.php.net/manual/en/function.syslog.php'),
      )) . '</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@syslog">Syslog module</a>.', array(
        '@syslog' => 'http://drupal.org/handbook/modules/syslog',
      )) . '</p>';
      return $output;
  }
}