File: syslog.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (189 lines) | stat: -rw-r--r-- 5,221 bytes parent folder | download | duplicates (2)
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.syslog" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>syslog</refname>
  <refpurpose>Generate a system log message</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>syslog</methodname>
   <methodparam><type>int</type><parameter>priority</parameter></methodparam>
   <methodparam><type>string</type><parameter>message</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>syslog</function> generates a log message that will be
   distributed by the system logger.
  </para>
  <para>
   For information on setting up a user defined log handler, see the
   <citerefentry><refentrytitle>syslog.conf</refentrytitle>
   <manvolnum>5</manvolnum></citerefentry> Unix manual page.  More
   information on the syslog facilities and option can be found in the man
   pages for <citerefentry><refentrytitle>syslog</refentrytitle>
   <manvolnum>3</manvolnum></citerefentry> on Unix machines.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>priority</parameter></term>
     <listitem>
      <para>
       <parameter>priority</parameter> is a combination of the facility and
       the level. Possible values are:
       <table>
        <title><function>syslog</function> Priorities (in descending order)</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Constant</entry>
           <entry>Description</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>LOG_EMERG</constant></entry>
           <entry>system is unusable</entry>
          </row>
          <row>
           <entry><constant>LOG_ALERT</constant></entry>
           <entry>action must be taken immediately</entry>
          </row>
          <row>
           <entry><constant>LOG_CRIT</constant></entry>
           <entry>critical conditions</entry>
          </row>
          <row>
           <entry><constant>LOG_ERR</constant></entry>
           <entry>error conditions</entry>
          </row>
          <row>
           <entry><constant>LOG_WARNING</constant></entry>
           <entry>warning conditions</entry>
          </row>
          <row>
           <entry><constant>LOG_NOTICE</constant></entry>
           <entry>normal, but significant, condition</entry>
          </row>
          <row>
           <entry><constant>LOG_INFO</constant></entry>
           <entry>informational message</entry>
          </row>
          <row>
           <entry><constant>LOG_DEBUG</constant></entry>
           <entry>debug-level message</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>message</parameter></term>
     <listitem>
      <para>
       The message to send, except that the two characters
       <literal>%m</literal> will be replaced by the error message string
       (strerror) corresponding to the present value of
       <errortype>errno</errortype>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Using <function>syslog</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// open syslog, include the process ID and also send
// the log to standard error, and use a user defined
// logging mechanism
openlog("myScriptLog", LOG_PID | LOG_PERROR, LOG_LOCAL0);

// some code

if (authorized_client()) {
    // do something
} else {
    // unauthorized client!
    // log the attempt
    $access = date("Y/m/d H:i:s");
    syslog(LOG_WARNING, "Unauthorized client: $access {$_SERVER['REMOTE_ADDR']} ({$_SERVER['HTTP_USER_AGENT']})");
}

closelog();
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <para>
   On Windows NT, the syslog service is emulated using the Event
   Log.
  </para>
  <note>
   <para>
    Use of <literal>LOG_LOCAL0</literal> through
    <literal>LOG_LOCAL7</literal> for the <parameter>facility</parameter>
    parameter of <function>openlog</function> is not available
    in Windows.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>openlog</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
-->