mirror of
https://github.com/php/doc-en.git
synced 2026-04-24 07:48:16 +02:00
Gina Peter Banyard
35ca7f1087
Remove duplication of information Use standard markup Remove personalization --------- Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
152 lines
4.3 KiB
XML
152 lines
4.3 KiB
XML
<?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
|
|
-->
|