File: mod_macro.html

package info (click to toggle)
libapache2-mod-macro 1.1.4-3.1
links: PTS
area: main
in suites: etch, etch-m68k, lenny
size: 92 kB
ctags: 62
sloc: ansic: 589; makefile: 35
file content (238 lines) | stat: -rw-r--r-- 7,660 bytes
parent folder | download | duplicates (3)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!-- Copyright (c) 1998-2002 Fabien Coelho. All rights reserved. -->
<!-- $Id: mod_macro.src.html,v 1.37 2002/06/01 21:46:44 coelho Exp $ -->
<HTML>
<HEAD>
<TITLE>Apache module mod_macro</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000"
 LINK="#0000FF" VLINK="#000080" ALINK="#FF0000">
<DIV ALIGN="CENTER">
<IMG SRC="../images/sub.gif" ALT="[APACHE DOCUMENTATION]">
<H3>Apache HTTP Server Version 2.0</H3>
</DIV>

<H1 ALIGN="CENTER">Module mod_macro 1.1.4</H1>
<P>
This module is contained in the <CODE>mod_macro.c</CODE> file, and
is not compiled in by default. It provides for using macros within apache
runtime configuration files. These macros can be given arguments.
They are expanded when used (arguments are substituted by their values),
and the result is processed normally.
</P>
<P>
This documentation describes version 1.1.4 of mod_macro.
For the latest version see:
</p>
<p>
<center>
<a href="http://www.coelho.net/mod_macro/">
<code>http://www.coelho.net/mod_macro/</code></a>
</center>
</p>

<HR>
<H2>Features</H2>

Definition of a macro:
<UL>
<LI> macro definition within a &lt;Macro&gt; section, in the apache style.
<LI> user defined names for the macro and its arguments.
<LI> macro names are case-insensitive.
<LI> macro argument names are case sensitive.
<LI> arguments of a macro must have distinct names.
<LI> error on empty argument names.
<LI> redefining a macro generates a warning.
<LI> macro definitions can be nested... (but what for?)
<LI> warn about unused macro arguments.
<LI> warn about macro arguments which prefix one another.
<LI> warn if arguments are not prefixed by any of '<code>$%&@#</code>'
     (good practice).
<LI> warn about empty macro contents.
<LI> warns if sections are not properly nested within a macro.
     (if it is detected so).
<LI> arbitrary contents in macros.

     <p>It means you can put perl sections or
     whatever you like in a macro. No assumption is made about
     the lexical structure (quotes, spaces or whatever)
     within the macro contents but to expect a set of
     backslash-continued independent lines.</p>
</UL>

Use of a macro:
<UL>
<LI> number of arguments must match the definition.
<LI> all occurences of macro arguments are substituted by their values.
<LI> in case of conflicts, the longest argument name is chosen.
<LI> macro expansion recursion is detected and stopped (error).
<LI> warn about empty arguments when used.
<LI> on errors, try to describe precisely where the error occured.
</UL>

Misc:
<UL>
<LI> Error directive to stop processing a configuration file.
<LI> Warning directive to issue warnings from a configuration file.
</UL>

<HR>
<H2>Directives</H2>
<UL>
<LI><A HREF="#error">Error</A>
<LI><A HREF="#macro">&lt;Macro&gt;</A>
<LI><A HREF="#use">Use</A>
<LI><A HREF="#warning">Warning</A>
</UL>

<HR>
<H2><A NAME="error">Error directive</A></H2>
<A HREF="directive-dict.html#Syntax" REL="Help">
<STRONG>Syntax:</STRONG></A> Error <EM>message</EM><BR>
<A HREF="directive-dict.html#Context" REL="Help">
<STRONG>Context:</STRONG></A> server config, virtual host, directory<BR>
<A HREF="directive-dict.html#Override" REL="Help">
<STRONG>Override:</STRONG></A> <BR>
<A HREF="directive-dict.html#Status" REL="Help">
<STRONG>Status:</STRONG></A> Extra<BR>
<A HREF="directive-dict.html#Module" REL="Help">
<STRONG>Module:</STRONG></A> mod_macro<BR>
<A HREF="directive-dict.html#Compatibility" REL="Help">
<STRONG>Compatibility:</STRONG></A> Apache 1.3 <BR>

<P>
This directive issues an error from the configuration file and stop
processing it.
</P>

<PRE>
&lt;IfModule !mod_perl.c&gt;
Error Hey, you forgot to install mod_perl! I need it!
&lt;/IfModule&gt;
</PRE>

<HR>
<H2><A NAME="macro">&lt;Macro&gt; directive</A></H2>
<A HREF="directive-dict.html#Syntax" REL="Help">
<STRONG>Syntax:</STRONG></A>&lt;Macro <EM>name</EM> <EM>args...</EM>&gt;<BR>
<A HREF="directive-dict.html#Context" REL="Help">
<STRONG>Context:</STRONG></A> server config, virtual host, directory <BR>
<A HREF="directive-dict.html#Override" REL="Help">
<STRONG>Override:</STRONG></A> <BR>
<A HREF="directive-dict.html#Status" REL="Help">
<STRONG>Status:</STRONG></A> Extra<BR>
<A HREF="directive-dict.html#Module" REL="Help">
<STRONG>Module:</STRONG></A> mod_macro<BR>
<A HREF="directive-dict.html#Compatibility" REL="Help">
<STRONG>Compatibility:</STRONG></A> Apache 1.3 <BR>

<P>
This directive controls the definition of a macro within the server
runtime configuration files. The first argument is the name of the macro.
Others are arguments to the macro. It is good practice to prefix
argument names with any of '$%&@#', and not macro names with such characters.
</P>
<P>
Notes: If you're using <code>mod_macro</code> along with
<code>mod_define</code>, do not use the '$' character as a prefix to macro
arguments (because this character is reserved for defined variables). Also
<code>mod_define</code> variable substitution is performed <b>after</b>
macro expansion.
</P>

<PRE>
   &lt;Macro LocalAccessPolicy&gt;
   order deny,allow
   deny from all
   allow from 10.2.16.0/24
   &lt;/Macro&gt;

   &lt;Macro RestrictedAccessPolicy $ipnumbers&gt;
   order deny,allow
   deny from all
   allow from $ipnumbers
   &lt;/Macro&gt;
</PRE>

<HR>

<H2><A NAME="use">Use directive</A></H2>
<A HREF="directive-dict.html#Syntax" REL="Help">
<STRONG>Syntax:</STRONG></A> Use <EM>name</EM> <EM>values...</EM><BR>
<A HREF="directive-dict.html#Context" REL="Help">
<STRONG>Context:</STRONG></A> server config, virtual host, directory<BR>
<A HREF="directive-dict.html#Override" REL="Help">
<STRONG>Override:</STRONG></A> <BR>
<A HREF="directive-dict.html#Status" REL="Help">
<STRONG>Status:</STRONG></A> Extra<BR>
<A HREF="directive-dict.html#Module" REL="Help">
<STRONG>Module:</STRONG></A> mod_macro<BR>
<A HREF="directive-dict.html#Compatibility" REL="Help">
<STRONG>Compatibility:</STRONG></A> Apache 1.3 <BR>

<P>
This directive controls the use of a macro. The specified macro is
expanded. It must be given the same number of arguments than in the
macro definition. The provided values are associated to their corresponding
initial argument and are substituted before processing.
</P>

<PRE>
   Use LocalAccessPolicy

   ...

   Use RestrictedAccessPolicy "192.54.172.0/24 192.54.148.0/24"
</PRE>

is equivalent, with the macros defined above, to:<br>

<PRE>
   order deny,allow
   deny from all
   allow from 10.2.16.0/24

   ...

   order deny,allow
   deny from all
   allow from 192.54.172.0/24 192.54.148.0/24
</PRE>

<HR>
<H2><A NAME="warning">Warning directive</A></H2>
<A HREF="directive-dict.html#Syntax" REL="Help">
<STRONG>Syntax:</STRONG></A> Warning <EM>message</EM><BR>
<A HREF="directive-dict.html#Context" REL="Help">
<STRONG>Context:</STRONG></A> server config, virtual host, directory<BR>
<A HREF="directive-dict.html#Override" REL="Help">
<STRONG>Override:</STRONG></A> <BR>
<A HREF="directive-dict.html#Status" REL="Help">
<STRONG>Status:</STRONG></A> Extra<BR>
<A HREF="directive-dict.html#Module" REL="Help">
<STRONG>Module:</STRONG></A> mod_macro<BR>
<A HREF="directive-dict.html#Compatibility" REL="Help">
<STRONG>Compatibility:</STRONG></A> Apache 1.3 <BR>

<P>
This directive issues a warning from the configuration file.
Processing goes on.
</P>

<PRE>
&lt;IfDefine !RunProxy&gt;
Warning The PROXY will not run!
&lt;/IfDefine&gt;

&lt;IfDefine RunProxy&gt;
# proxy configuration
...
&lt;/IfDefine&gt;
</PRE>

<HR>
<H3 ALIGN="CENTER">Apache HTTP Server Version 1.3</H3>
<A HREF="./"><IMG SRC="../images/index.gif" ALT="Index"></A>
<A HREF="../"><IMG SRC="../images/home.gif" ALT="Home"></A>
</BODY>
</HTML>