[openbnc-cvs] openbnc/doc Steely.css,NONE,1.1 manual.html,NONE,1.1

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/openbnc/openbnc/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14449

Added Files:
	Steely.css manual.html 
Log Message:
Comitting manual and stylesheet.

--- NEW FILE: Steely.css ---
/* The W3C Core Styles Copyright (c) 1998 W3C (mit, inria, Keio), All Rights
Reserved. W3C liability, trademark, document use and software licensing rules
apply. See http://www.w3.org/Consortium/Legal/ipr-notice.html

This stylesheet has been served in a form to avoid known bugs in your user
agent's css implementation. Copying and serving this stylesheet to other
agents may lead to unexpected results. Please refer to its address rather than
copy it. */

/* WinNS4 */

/* WinNS4 */
h1, h2, h3, h4, h5, h6, th, dt	{ font-family:	Tahoma, Verdana, 'Myriad Web', Syntax, sans-serif; }

/* WinNS4 */
p, div, ul, dl, dt, dd, pre, ol, li, blockquote, address	{
	color: black;
	}
	/* begin affordances */	/* 1 - blue orange */

a, address, blockquote, body, cite, code, dd, del, dfn,		
div, dl, dt, em, form, h1, h2, h3, h4, h5, h6, iframe, img, kbd,		
li, object, ol, p, q, samp, small, span, strong, sub, sup, ul, var, 		
applet, big, center, dir, font, hr, menu, pre,		
abbr, acronym, bdo, button, fieldset, ins, label	{	
	word-spacing:	normal;
	letter-spacing:	normal;
	text-transform:	none;
	text-decoration:	none;
	border-color:	#036;
	border-style:	none;
	}	

body	{	
	color:	black;
	background:	white;
	}	

em	{	
	font-style:	normal;
	font-weight:	bold;
	color:	black;
	background:	white;
	}	

strong	{	
	font-style:	italic;
	background:	white;
	font-weight:	bold;
	color:	black;
	}	

em strong, strong em	{	
	text-transform:	uppercase;
	font-style:	normal;
	font-weight:	bolder;
	background:	white;
	color:	black;
	}	

b	{
	font-weight:	bold;
	}

i	{
	font-style:	italic;
	}

.warning	{	
	text-transform:	none;
	font-style:	normal;
	font-weight:	bolder;
	background:	yellow;
	color:	black;
	}	

del	{	
	text-decoration:	line-through;
	background:	#F66;
	}	

ins	{	
	text-decoration:	none;
	background:	yellow;
	}	

var, cite, dfn, .note	{	
	font-style:	italic;
	}	

address	{	
	font-style:	normal;
	letter-spacing:	.1em;
	}	

acronym	{	
	font-variant:	small-caps;
	letter-spacing:	0.1em;
	}	

h1, h2, h3, h4, h5, h6, dt, th, thead, tfoot	{	
	color:	#036;
	background:	white;
	}	

hr	{	
	color:	#036;
	}	

#colophon	{	
	display:	none;
	}	

col, colgroup, table, tbody, td, tr	{	
	color:	black;
	text-decoration:	none;
	border-color:	black;
	border-style:	none;
	background:	white;
	}	

a:link	{	
	text-decoration:	none;
	font-weight:	bold;
	color:	#F30;
	background:	white;
	}	

a:visited	{	
	text-decoration:	none;
	font-weight:	bold;
	color:	#996;
	background:	white;
	}	

a:active	{	
	text-decoration:	none;
	font-weight:	bold;
	color:	#F30;
	background:	#FF0;
	}	

a:hover	{	
	text-decoration:	none;
	color:	#F30;
	background:	white;
	}	

a.offsite	{	
	text-decoration:	none;
	font-weight:	normal;
	color:	#C30;
	background:	white;
	}	

	/* end affordances */	

/* WinNS4 */

/* WinNS4 */

/* WinNS4 */
	/* begin body box */	/* 1 - 'em-based symmetric a' */

body	{
	margin-top:	1.58em;
	margin-left:	1.58em;
	margin-right:	1ex;
	margin-bottom:	1.58em;
	padding-top:	0;
	padding-left:	0;
	padding-right:	0;
	padding-bottom:	0;
	border-top:	0;
	border-left:	0;
	border-bottom:	0;
	border-right:	0;
	width:	auto;
	}
	/* end body box */

--- NEW FILE: manual.html ---
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
	<title>OpenBNC Manual</title>
<!--    <link rel="stylesheet" href="http://www.w3.org/StyleSheets/Core/Steely" type="text/css"> -->
		<link href="Steely.css" rel="stylesheet" type="text/css">

</head>

<body>
<h2>OpenBNC Manual</h2>
<h5>A comprehensive manual for OpenBNC users.<br />
</h5>
<p>&nbsp; </p>
<dl>
  <dt>Authors: 
  <dd>Andre Reis (<a href="mailto:andrereis%20at%20users%20dot%20sourceforge%20dot%20net">andrereis 
    at users dot sourceforge dot net</a>) 
</dl>
<h3>&nbsp;</h3>
<h3><br />
  Table of Contents</h3>
<p><A HREF="#abstract">Abstract</A><BR>
  <A HREF="#state">State of this document</A><BR>
  <BR>
  <A HREF="#installation">1 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Installation</A><BR>
  <A HREF="#configure">1.1 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'./configure' 
  options </A><BR>
  <A HREF="#configscript">1.2 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The 
  'config.sh' script</A><BR>
  <A HREF="#make">1.3 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'make' and 
  'make install'</A><BR>
  <BR>
  <A HREF="#configuration">2 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Configuration</A><BR>
  <A HREF="#conffile">2.1 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The 
  'openbnc.conf' file<br>
  </A><A HREF="#migrating">2.1.1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Migrating 
  from an old psyBNC installation</A><BR>
  <A HREF="#cmdline">2.2 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Command-line 
  options </A><BR>
  <A HREF="#motd">2.3 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</A><A HREF="#motd">Displaying 
  a custom Message Of The Day (MOTD)</A><BR>
  <A HREF="#usage"><br>
  3 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Usage</A><BR>
  <A HREF="#quickstart">3.1 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Quick 
  start guide</A><BR>
  <A HREF="#commands">3.2 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Detailed 
  list of available commands</A><br>
  <BR>
  <A HREF="#troubleshooting">4 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Troubleshooting</A></p>
<h3>&nbsp;</h3>
<h3><a name="abstract" id="abstract"></a>Abstract</h3>
<p>This is a manual for the OpenBNC Advanced IRC Bouncer, available at <a href="http://openbnc.sourceforge.net" class="offsite">http://openbnc.sourceforge.net</a>. 
</p>
<h3><a name="state" id="state"></a>State of this document</h3>
<p>This manual is valid for OpenBNC version 1.1. It may be partially valid for 
  previous and future releases of OpenBNC, but it is not guaranteed to. </p>
<h3>&nbsp;</h3>
<h3><a name="installation"></a>1 - Installation</h3>
<p>OpenBNC follows the './configure &amp;&amp; make &amp;&amp; make install' scheme.</p>
<p><span class="note">By specifying ./configure without parameters, you will obtain 
  a binary with all modules compiled into it, and Blowfish as the default encryption 
  type.</span></p>
<h4><a name="configure"></a>1.1 - './configure' options</h4>
<p>The following parameters can be passed to './configure':</p>
<p><dl>
  <dt>--disable-enc</dt>
  <dd>Disables encryption features.</dd>
  <dt>--enc-type=[blowfish,idea]</dt>
  <dd>Specifies the encryption used. Choose only one.</dd>
  <dt>--disable-translation</dt>
  <dd>Disables the Translation module.</dd>
  <dt>--disable-intnet</dt>
  <dd>Rejects connections to the bouncer from local network IP addresses.</dd>
  <dt>--disable-logging</dt>
  <dd>Disables user traffic logging.</dd>
  <dt>--disable-links</dt>
  <dd>Disables Bouncer Linkage.</dd>
  <dt>--disable-dcc</dt>
  <dd>Disables DCC Transfers and DCC Chats.</dd>
  <dt>--disable-script</dt>
  <dd>Disables the scripting capabilities.</dd>
  <dt>--disable-oidentd (??)</dt>
  <dd>Disables the ident daemon. (??)</dd>
  <dt>--disable-multinet</dt>
  <dd>Restricts users to a single network at a time.</dd>
  <dt>--disable-proxy</dt>
  <dd>Disables proxy server support.</dd>
  <dt>--disable-persistent</dt>
  <dd>Act as a simple IRC proxy, not maintaining connections.</dd>
  <dt>--disable-ssl</dt>
  <dd>Disables SSL support to connect to SSL-enabled servers.</dd>
  <dt>--ssl-path=/path/to/ssl</dt>
  <dd>Allows you to manually specify the path to the SSL libraries.</dd>
  </dl>

<h4><a name="configscript"></a>1.2 - The 'config.sh' script</h4>
<h4><a name="make"></a>1.3 - 'make' and 'make install'</h4>
<p>Once you're done with configuring, run 'make' to compile your openbnc binary. 
  After that, run 'make install' to install the openbnc binary, documentation 
  and man pages in your system. The binary is installed to /usr/local/bin/, and 
  the documentation is placed in /usr/local/share/doc/openbnc/</p>
<p class="note">If you are a client of a shell provider, or you have but a restrictive 
  shell in a server, you should skip the 'make install' step. You will likely 
  not have permissions to install binaries on the server. In such a situation, 
  you can run openbnc by specifying the full path to openbnc binary, or by executing 
  './openbnc' inside OpenBNC's directory. </p>
<h4>&nbsp; </h4>
<h3><a name="configuration"></a>2 - Configuration</h3>
<h4><a name="conffile"></a>2.1 - The 'openbnc.conf' file</h4>
<p>OpenBNC requires a configuration file to run. This configuration file stores 
  the Bouncer's configuration, such as enabled features, listening ports, links 
  to other bouncers, and most important of all, each user's data. When the 'openbnc' 
  binary is run, it looks for an openbnc.conf file in the present directory, unless 
  you specify one by providing the '--config ' parameter followed by the path 
  and filename of the configuration file.</p>
<h5><a name="migrating"></a>2.1.1 - Migrating from an old psyBNC installation</h5>
<p>If you are upgrading from a psyBNC installation, you can use the 'convert.sh' 
  shell script to convert your existing psybnc.conf file to a valid OpenBNC configuration 
  file. You will need to re-run (insert .conf configuration tool here) because 
  OpenBNC requires some more parameters that do not exist in psyBNC.</p>
<h4><a name="cmdline"></a>2.2 - Command-line options</h4>
The following parameters can be passed to the 'openbnc' binary: 
<dl><dt>--user=[username]</dt>
  <dt>--group=[groupname]</dt>
  <dd>If OpenBNC is run as root, it will switch to the selected user's process space 
  and run unprivileged.</dd>
  <dt>--config=[path to .conf file]</dt>
  <dd>Allows specifying a configuration file, useful for testing or maintaining many 
  different set-ups.</dd>
  <dt>--user-limit=[value]</dt>
  <dd>Restricts the number of simultaneous users the bouncer can handle. In standalone/master 
    mode, it will read only the first X users from the configuration file, and 
    will not allow the creation of new users if the chosen limit has been reached. 
    In slave mode, it will not allow more than X users connected at once, redirecting 
    incoming connections to other bouncers on the network once the limit is reached.</dd>
  <dt>--interval=[seconds]</dt>
  <dd>This specifies a time interval, in seconds, that the bouncer will wait between 
  each attempt to connect to an IRC server. This can be used to avoid bouncers 
  with a high count of users to flood IRC servers once they are started.</dd>
  <dt>--pid-file=/path/to/openbnc.pid</dt>
  <dd>Allows specifying the file where OpenBNC will write its PID to.</dd>
</dl>
<h4><a name="motd"></a>2.3 - Displaying a custom Message Of The Day (MOTD)</h4>
<p>&nbsp;</p>
<h3><a name="usage"></a>3 - Usage</h3>
<h4><a name="quickstart"></a>3.1 - Quick Start guide</h4>
<h4><a name="commands"></a>3.2 - Detailed list of available commands</h4>
<p>&nbsp;</p>
<h3><a name="troubleshooting"></a>4 - Troubleshooting</h3>
<p>&nbsp;</p>

<p>
<a href="http://validator.w3.org/check?uri=referer"><img
src="http://www.w3.org/Icons/valid-html401"
alt="Valid HTML 4.01!" height="31" width="88"></a>
<a href="http://jigsaw.w3.org/css-validator/">
<img style="border:0;width:88px;height:31px"
src="http://jigsaw.w3.org/css-validator/images/vcss" 
alt="Valid CSS!">
</a>
</p>

</body>
</html>