323 lines
12 KiB
HTML
323 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<!--
|
|
| Generated by Apache Maven Doxia at 2017-07-31
|
|
| Rendered using Apache Maven Fluido Skin 1.4
|
|
-->
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="Date-Revision-yyyymmdd" content="20170731" />
|
|
<meta http-equiv="Content-Language" content="en" />
|
|
<title>SLF4Bukkit – SLF4Bukkit</title>
|
|
<link rel="stylesheet" href="./css/apache-maven-fluido-1.4.min.css" />
|
|
<link rel="stylesheet" href="./css/site.css" />
|
|
<link rel="stylesheet" href="./css/print.css" media="print" />
|
|
|
|
|
|
|
|
<style type="text/css">body{background-image: url('./images/profiles/pre-release.png');}</style>
|
|
|
|
|
|
<script type="text/javascript" src="./js/apache-maven-fluido-1.4.min.js"></script>
|
|
|
|
|
|
</head>
|
|
<body class="topBarEnabled">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/rjenkinsjr/slf4bukkit">
|
|
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
|
|
src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"
|
|
alt="Fork me on GitHub">
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
<div id="topbar" class="navbar navbar-fixed-top ">
|
|
<div class="navbar-inner">
|
|
<div class="container-fluid">
|
|
<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</a>
|
|
|
|
<ul class="nav">
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
|
|
<li> <a href="index.html" title="For Server Administrators">For Server Administrators</a>
|
|
</li>
|
|
|
|
<li> <a href="devs.html" title="For Plugin Developers">For Plugin Developers</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
|
|
<li class="dropdown-submenu">
|
|
<a href="project-info.html" title="Project Information">Project Information</a>
|
|
<ul class="dropdown-menu">
|
|
<li> <a href="dependencies.html" title="Dependencies">Dependencies</a>
|
|
</li>
|
|
<li> <a href="dependency-convergence.html" title="Dependency Convergence">Dependency Convergence</a>
|
|
</li>
|
|
<li> <a href="plugins.html" title="Project Plugins">Project Plugins</a>
|
|
</li>
|
|
<li> <a href="source-repository.html" title="Source Repository">Source Repository</a>
|
|
</li>
|
|
<li> <a href="project-summary.html" title="Project Summary">Project Summary</a>
|
|
</li>
|
|
<li> <a href="license.html" title="Project License">Project License</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="dropdown-submenu">
|
|
<a href="project-reports.html" title="Project Reports">Project Reports</a>
|
|
<ul class="dropdown-menu">
|
|
<li> <a href="apidocs/index.html" title="JavaDocs">JavaDocs</a>
|
|
</li>
|
|
<li> <a href="xref/index.html" title="Source Xref">Source Xref</a>
|
|
</li>
|
|
<li> <a href="taglist.html" title="Tag List">Tag List</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="container-fluid">
|
|
<div id="banner">
|
|
<div class="pull-left">
|
|
<div id="bannerLeft">
|
|
<h2>SLF4Bukkit</h2>
|
|
</div>
|
|
</div>
|
|
<div class="pull-right"> </div>
|
|
<div class="clear"><hr/></div>
|
|
</div>
|
|
|
|
<div id="breadcrumbs">
|
|
<ul class="breadcrumb">
|
|
|
|
|
|
<li id="publishDate">Last Published: 2017-07-31
|
|
<span class="divider">|</span>
|
|
</li>
|
|
<li id="projectVersion">Version: 0.1.6
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<div class="row-fluid">
|
|
<div id="leftColumn" class="span2">
|
|
<div class="well sidebar-nav">
|
|
|
|
|
|
<ul class="nav nav-list">
|
|
<li class="nav-header">User Guide</li>
|
|
|
|
<li class="active">
|
|
|
|
<a href="#"><span class="none"></span>For Server Administrators</a>
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a href="devs.html" title="For Plugin Developers">
|
|
<span class="none"></span>
|
|
For Plugin Developers</a>
|
|
</li>
|
|
<li class="nav-header">Project Documentation</li>
|
|
|
|
<li>
|
|
|
|
<a href="project-info.html" title="Project Information">
|
|
<span class="icon-chevron-right"></span>
|
|
Project Information</a>
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a href="project-reports.html" title="Project Reports">
|
|
<span class="icon-chevron-right"></span>
|
|
Project Reports</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<div id="poweredBy">
|
|
<div class="clear"></div>
|
|
<div class="clear"></div>
|
|
<div class="clear"></div>
|
|
<div class="clear"></div>
|
|
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
|
|
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div id="bodyColumn" class="span10" >
|
|
|
|
<h1>SLF4Bukkit</h1>
|
|
<p>SLF4Bukkit is an SLF4J binding that uses Bukkit’s plugin logging system.</p>
|
|
<div class="section">
|
|
<h2><a name="For_Server_Administrators"></a>For Server Administrators</h2>
|
|
<p>If you were linked here by documentation for a plugin that you’re using on your Bukkit/Spigot server, you can control the logging behavior of the plugin using its <tt>config.yml</tt> file.</p>
|
|
<p>Basic documentation of all available options is shown below. Your plugin likely has additional information regarding what portions of the plugin’s logging facilities are configurable.</p>
|
|
|
|
<div class="source">
|
|
<div class="source"><pre class="prettyprint linenums"># This is the section within which all SLF4Bukkit configuration options are
|
|
# contained. Its name is the same regardless of what the plugin's name is.
|
|
slf4j:
|
|
|
|
# Default log level for all plugin logging activity. Possible values are
|
|
# "trace", "debug", "info", "warn", or "error" (case-insensitive).
|
|
#
|
|
# If the plugin logs any "trace" or "debug" messages, they will be logged by
|
|
# the plugin as "info" severity, but you'll see the actual severity in the
|
|
# log message. This is due to a Bukkit logging limitation.
|
|
#
|
|
# If not specified or given an invalid value, defaults to "info".
|
|
defaultLogLevel: info
|
|
|
|
# Shows an "[SLF4J]" header for every message logged through SLF4Bukkit.
|
|
#
|
|
# If not specified or given an invalid value, defaults to "false".
|
|
showHeader: false
|
|
|
|
# Shows the full logger name (e.g. "info.ronjenkins.bukkit.MyPlugin"),
|
|
# wrapped in curly braces.
|
|
#
|
|
# If not specified or given an invalid value, defaults to "false". If true,
|
|
# this overrides "slf4j.showShortLogName".
|
|
showLogName: false
|
|
|
|
# Shows the short logger name, wrapped in curly braces. The short logger name
|
|
# is the short Java package name format (e.g. a logger named
|
|
# "info.ronjenkins.bukkit.MyPlugin" would have a short name of
|
|
# "i.r.b.MyPlugin").
|
|
#
|
|
# If not specified or given an invalid value, defaults to "true". If
|
|
# "slf4j.showLogName" is true, this option is ignored.
|
|
showShortLogName: true
|
|
|
|
# Shows the name of the logging thread, wrapped in brackets. You probably
|
|
# don't want this information unless you're helping troubleshoot a plugin.
|
|
#
|
|
# If not specified or given an invalid value, defaults to "false".
|
|
showThreadName: false
|
|
|
|
# This section controls default colors for logging levels. Each entry in this
|
|
# section maps one of SLF4J's logging levels to one of SLF4Bukkit's
|
|
# ColorMarker values. The possible keys (levels) in this section are the
|
|
# possible values for the "slf4j.defaultLogLevel" property.
|
|
#
|
|
# If either the key (level) name or the value (ColorMarker) name does not
|
|
# match one of the possible values, that config entry is ignored. Keys and
|
|
# values are compared in a case-insensitive fashion.
|
|
#
|
|
# The values in the plugin config are applied on top of the following
|
|
# hardcoded default values:
|
|
# error: RED
|
|
# warn: YELLOW
|
|
# info: NONE
|
|
# debug: NONE
|
|
# trace: NONE
|
|
#
|
|
# The ColorMarker values are:
|
|
# BLACK
|
|
# DARK_BLUE
|
|
# DARK_GREEN
|
|
# DARK_AQUA
|
|
# DARK_RED
|
|
# DARK_PURPLE
|
|
# GOLD
|
|
# GRAY
|
|
# DARK_GRAY
|
|
# BLUE
|
|
# GREEN
|
|
# AQUA
|
|
# RED
|
|
# LIGHT_PURPLE
|
|
# YELLOW
|
|
# WHITE
|
|
# NONE (default console color)
|
|
colors:
|
|
error: RED
|
|
warn: YELLOW
|
|
info: NONE
|
|
debug: NONE
|
|
trace: NONE
|
|
|
|
# This section controls logging levels for individual loggers.
|
|
log:
|
|
|
|
# For each element in this section, the key is the full logger name and the
|
|
# value is the logging level for that logger. Possible logging levels are
|
|
# the same as what's available for the "slf4j.defaultLogLevel" property
|
|
# (case-insensitive).
|
|
#
|
|
# The documentation for your plugin should elaborate on what logger names
|
|
# are available. As a general rule, you won't need to specify levels for
|
|
# specific loggers.
|
|
#
|
|
# For any logger, if the level specified here is invalid, or if the level is
|
|
# not specified at all, the level of the closest parent logger is used. If
|
|
# none of the logger's ancestors have a valid level defined, the
|
|
# value of "slf4j.defaultLogLevel" is used.
|
|
info.ronjenkins.bukkit.MyPlugin: debug
|
|
info.ronjenkins.SomeOtherLogger: warn
|
|
</pre></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<footer>
|
|
<div class="container-fluid">
|
|
<div class="row-fluid">
|
|
<p class="pull-right">Copyright © 2017.
|
|
All rights reserved.
|
|
|
|
</p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|