Sophie

Sophie

distrib > Fedora > 14 > i386 > by-pkgid > 75797b29a03e71d63c5c2fd46422a606 > files > 25

ghc-hslogger-devel-1.1.0-3.fc14.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>System.Log.Formatter</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_System-Log-Formatter.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>hslogger-1.1.0: Versatile logging framework</TD
><TD CLASS="topbut"
><A HREF="src/System-Log-Formatter.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>System.Log.Formatter</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
>Definition of log formatter support
</P
><P
>A few basic, and extendable formatters are defined.
</P
><P
>Please see <A HREF="System-Log-Logger.html"
>System.Log.Logger</A
> for extensive documentation on the
logging system.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A HREF="#t%3ALogFormatter"
>LogFormatter</A
> a = a -&gt; <A HREF="System-Log.html#t%3ALogRecord"
>LogRecord</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AnullFormatter"
>nullFormatter</A
> ::  <A HREF="System-Log-Formatter.html#t%3ALogFormatter"
>LogFormatter</A
> a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsimpleLogFormatter"
>simpleLogFormatter</A
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="System-Log-Formatter.html#t%3ALogFormatter"
>LogFormatter</A
> a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtfLogFormatter"
>tfLogFormatter</A
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="System-Log-Formatter.html#t%3ALogFormatter"
>LogFormatter</A
> a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AvarFormatter"
>varFormatter</A
> ::  [(<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>)] -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="System-Log-Formatter.html#t%3ALogFormatter"
>LogFormatter</A
> a</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>type</SPAN
> <A NAME="t:LogFormatter"
><A NAME="t%3ALogFormatter"
></A
></A
><B
>LogFormatter</B
> a</TD
><TD CLASS="declbut"
><A HREF="src/System-Log-Formatter.html#LogFormatter"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>&nbsp;= a</TD
><TD CLASS="rdoc"
>The LogHandler that the passed message came from 
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="System-Log.html#t%3ALogRecord"
>LogRecord</A
></TD
><TD CLASS="rdoc"
>The log message and priority
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>The logger name
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>The formatted log message
</TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>A LogFormatter is used to format log messages.  Note that it is paramterized on the
 Handler to allow the formatter to use information specific to the handler
 (an example of can be seen in the formatter used in System.Log.Handler.Syslog)
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:nullFormatter"
><A NAME="v%3AnullFormatter"
></A
></A
><B
>nullFormatter</B
> ::  <A HREF="System-Log-Formatter.html#t%3ALogFormatter"
>LogFormatter</A
> a</TD
><TD CLASS="declbut"
><A HREF="src/System-Log-Formatter.html#nullFormatter"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Returns the passed message as is, ie. no formatting is done.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:simpleLogFormatter"
><A NAME="v%3AsimpleLogFormatter"
></A
></A
><B
>simpleLogFormatter</B
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="System-Log-Formatter.html#t%3ALogFormatter"
>LogFormatter</A
> a</TD
><TD CLASS="declbut"
><A HREF="src/System-Log-Formatter.html#simpleLogFormatter"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Takes a format string, and returns a formatter that may be used to
   format log messages.  The format string may contain variables prefixed with
   a $-sign which will be replaced at runtime with corresponding values.  The 
   currently supported variables are:
</P
><UL
><LI
> <TT
>$msg</TT
> - The actual log message
</LI
><LI
> <TT
>$loggername</TT
> - The name of the logger
</LI
><LI
> <TT
>$prio</TT
> - The priority level of the message
</LI
><LI
> <TT
>$tid</TT
>  - The thread ID
</LI
><LI
> <TT
>$pid</TT
>  - Process ID  (Not available on windows)
</LI
><LI
> <TT
>$time</TT
> - The current time 
</LI
><LI
> <TT
>$utcTime</TT
> - The current time in UTC Time
</LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:tfLogFormatter"
><A NAME="v%3AtfLogFormatter"
></A
></A
><B
>tfLogFormatter</B
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="System-Log-Formatter.html#t%3ALogFormatter"
>LogFormatter</A
> a</TD
><TD CLASS="declbut"
><A HREF="src/System-Log-Formatter.html#tfLogFormatter"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Like <TT
><A HREF="System-Log-Formatter.html#v%3AsimpleLogFormatter"
>simpleLogFormatter</A
></TT
> but allow the time format to be specified in the first
 parameter (this is passed to Date.Time.Format.formatTime)
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:varFormatter"
><A NAME="v%3AvarFormatter"
></A
></A
><B
>varFormatter</B
> ::  [(<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>, <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>)] -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="System-Log-Formatter.html#t%3ALogFormatter"
>LogFormatter</A
> a</TD
><TD CLASS="declbut"
><A HREF="src/System-Log-Formatter.html#varFormatter"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>An extensible formatter that allows new substition <EM
>variables</EM
> to be defined.
 Each variable has an associated IO action that is used to produce the
 string to substitute for the variable name.  The predefined variables are the same
 as for <TT
><A HREF="System-Log-Formatter.html#v%3AsimpleLogFormatter"
>simpleLogFormatter</A
></TT
> <EM
>excluding</EM
> <TT
>$time</TT
> and <TT
>$utcTime</TT
>.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.1</TD
></TR
></TABLE
></BODY
></HTML
>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional