LoggerLayoutPattern:
[logging-log4php.git] / INSTALL
1  Licensed to the Apache Software Foundation (ASF) under one or more
2  contributor license agreements.  See the NOTICE file distributed with
3  this work for additional information regarding copyright ownership.
4  The ASF licenses this file to You under the Apache License, Version 2.0
5  (the "License"); you may not use this file except in compliance with
6  the License.  You may obtain a copy of the License at
7
8       http://www.apache.org/licenses/LICENSE-2.0
9
10  Unless required by applicable law or agreed to in writing, software
11  distributed under the License is distributed on an "AS IS" BASIS,
12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  See the License for the specific language governing permissions and
14  limitations under the License.
15
16 ------------------------------------------------------------------------------
17  INSTALLATION
18 ------------------------------------------------------------------------------ 
19
20 1. Before starting installing this package check if the following external
21    programs are installed:
22    
23    a. PHP (version 5.2.x or above). 
24    
25 2. Extract the tarball / zipfile to a dir (ex: {YOUR_PATH}).
26
27    If you want to include log4php under an include_path dir 
28    consider step (a).
29
30    If you want to include log4php wherever you want consider 
31    step (b).
32
33    a. Create a log4php dir under an include_path.
34       Copy '{YOUR_PATH}/src/main/php' under an '{an_include_path}/log4php'. 
35
36       Include the Logger class:
37    
38          require_once('log4php/Logger.php');
39
40    b. Copy '{YOUR_PATH}/src/main/php' to the dir where you want log4php to  
41       reside (ex: {MY_LOG4PHP_PATH}).
42       
43       Include the Logger class:
44
45          require_once( '{MY_LOG4PHP_PATH}/Logger.php' );
46
47 3. That's all! For more details on using Apache log4php please see the HTML docs in the site folder.
48
49 ------------------------------------------------------------------------------
50  $Revision$
51 ------------------------------------------------------------------------------
52