1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.openlog" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>openlog</refname>
<refpurpose>Open connection to system logger</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>true</type><methodname>openlog</methodname>
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
<methodparam><type>int</type><parameter>facility</parameter></methodparam>
</methodsynopsis>
<para>
<function>openlog</function> opens a connection to the system
logger for a program.
</para>
<para>
The use of <function>openlog</function> is optional. It
will automatically be called by <function>syslog</function> if
necessary, in which case <parameter>prefix</parameter> will default
to the empty string.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>prefix</parameter></term>
<listitem>
<para>
The string <parameter>prefix</parameter> is added to each message.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Bitmask of the following constants:
<simplelist>
<member><constant>LOG_CONS</constant></member>
<member><constant>LOG_NDELAY</constant></member>
<member><constant>LOG_ODELAY</constant></member>
<member><constant>LOG_NOWAIT</constant></member>
<member><constant>LOG_PERROR</constant></member>
<member><constant>LOG_PID</constant></member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>facility</parameter></term>
<listitem>
<para>
The <parameter>facility</parameter> argument is used to specify
what type of program is logging the message.
This lets the configuration file specify that messages from different
facilities will be handled differently.
Must be one of the following constants:
<simplelist>
<member><constant>LOG_AUTH</constant></member>
<member><constant>LOG_AUTHPRIV</constant></member>
<member><constant>LOG_CRON</constant></member>
<member><constant>LOG_DAEMON</constant></member>
<member><constant>LOG_KERN</constant></member>
<member><constant>LOG_LOCAL<replaceable>[0-7]</replaceable></constant></member>
<member><constant>LOG_LPR</constant></member>
<member><constant>LOG_MAIL</constant></member>
<member><constant>LOG_NEWS</constant></member>
<member><constant>LOG_SYSLOG</constant></member>
<member><constant>LOG_USER</constant></member>
<member><constant>LOG_UUCP</constant></member>
</simplelist>
</para>
<note>
<simpara>
This parameter is ignored on Windows.
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.true.always;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.2.0</entry>
<entry>
The function now always returns &true;. Previously it returned &false; on failure.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>syslog</function></member>
<member><function>closelog</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|