Repository :
http://git.fedorahosted.org/cgit/docs/fedora-cookbook.git
On branch : master
---------------------------------------------------------------
commit 90649101cee7d499cafbbc3ba9851cf679ba5da2
Author: Pete Travis <immanetize(a)fedoraproject.org>
Date: Thu May 22 13:33:56 2014 -0600
wrapping up bip recipe
follow up on cited bz is still required
---------------------------------------------------------------
en-US/Communications.xml | 9 ++++--
en-US/Communications/bip.xml | 56 ++++++++++++++++++++++++++++++++++++------
2 files changed, 54 insertions(+), 11 deletions(-)
diff --git a/en-US/Communications.xml b/en-US/Communications.xml
index b6b8f58..8e2913f 100644
--- a/en-US/Communications.xml
+++ b/en-US/Communications.xml
@@ -4,6 +4,9 @@
%BOOK_ENTITIES;
]>
<chapter id="Communications">
-<title>Communications</title>
-
-<para /> </chapter>
+ <title>Communications</title>
+ <section id="Communications-IRC">
+ <title>Internet Relay Chat</title>
+ <xi:include href="Communications/bip.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </section>
+</chapter>
diff --git a/en-US/Communications/bip.xml b/en-US/Communications/bip.xml
index 829412e..f41b959 100644
--- a/en-US/Communications/bip.xml
+++ b/en-US/Communications/bip.xml
@@ -14,7 +14,7 @@
<section id="bip">
<title>Installing the <systemitem
class="daemon">bip</systemitem> IRC Proxy</title>
<para>
- Internet Relay Chat, or IRC, is a venerable and popular way to communicate over the
internet. Fedora users can <ulink
href="https://fedoraproject.org/wiki/Communicating_and_getting_help#...
help</ulink> on IRC, and many other open source projects use it to collaborate. IRC
is accessed using an <emphasis>IRC Client</emphasis>, and clients are
available for almost every platform, including <systemitem
class="osname">Windows</systemitem>, <systemitem
class="osname">OS X</systemitem>, <systemitem
class="osname">Android</systemitem>, <systemitem
class="osname">iOS</systemitem>, and of course every Linux
distribution.
+ Internet Relay Chat, or IRC, is a venerable and popular way to communicate over the
internet. Fedora users can <ulink
url="https://fedoraproject.org/wiki/Communicating_and_getting_help#I...
help</ulink> on IRC, and many other open source projects use it to collaborate. IRC
is accessed using an <emphasis>IRC Client</emphasis>, and clients are
available for almost every platform, including <systemitem
class="osname">Windows</systemitem>, <systemitem
class="osname">OS X</systemitem>, <systemitem
class="osname">Android</systemitem>, <systemitem
class="osname">iOS</systemitem>, and of course every Linux
distribution.
</para>
<indexterm>
<primary>bouncer</primary>
@@ -66,19 +66,20 @@
<title>Directions</title>
<procedure>
<title>Installing and Configuring <systemitem
class="daemon">bip</systemitem></title>
- <step><para>
+ <step>
+ <para>
Install required packages on the server:
</para>
<screen>
<command>yum install bip</command>
</screen>
- </para></step>
+ </step>
<step>
<para>
Use the <application>bipgenconfig</application> utility to generate
a configuration file.
</para>
<para>
- In this example, you will configure the <xref
linkend="http://freenode.net/">freenode</xref> IRC network.
Fedora's IRC channels are on Freenode.
+ In this example, you will configure the <ulink
url="http://freenode.net/">freenode</ulink> IRC network. Fedora's
IRC channels are on Freenode.
</para>
<substeps>
<step>
@@ -196,7 +197,7 @@
* Channel key (optional)
Do you want to add a new channel ? [Y/n] n
Do you want to add a new connection ? [Y/n] n
- <computeroutput></screen>
+ </computeroutput></screen>
<para>
Configure the channels you would like to automatically join, and enter
the channel password if required. <systemitem
class="daemon">bip</systemitem> will connect to these channels when it
starts. If you join additional channels, bip can keep them open for you, but they will
not be rejoined if the service is restarted.
</para>
@@ -241,13 +242,52 @@
</para>
</step>
<step>
- <para>Configure your IRC client to use the bip service</para>
+ <para>Configure your IRC client to use the bip service.</para>
+ <para>
+ This example is for <application>HexChat</application>. To
configure other clients, refer to that client's documentation.
+ </para>
<substeps>
<step>
- <para />
+ <para>
+ Launch <application>hexchat</application> and open the Network
List by clicking <guimenuitem>Hexchat</guimenuitem> then
<guimenuitem>Network List...</guimenuitem>.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click the <guibutton>Add</guibutton> button in the Network List
window.
+ </para>
+ <para>
+ A new network item is immediately added to the
<guilabel>Networks</guilabel>. Type in a name for your network, such as
<replaceable>Fedorauser's BIP server</replaceable>.
+ </para>
</step>
<step>
- <para />
+ <para>Click <guibutton>Edit...</guibutton> to enter more
details for the connection.</para>
+ <substeps>
+ <step>
+ <para>
+ Click <guibutton>Add</guibutton> to add an address for your
server. A new entry will immediately be created for editing in the list.
+ </para>
+ <para>
+ Enter your server's IP address and the port number. It should look
something like this:
+ </para>
+ <screen>
+ <systemitem
class="ipaddress">192.168.1.72</systemitem>/7778
+ </screen>
+ </step>
+ <step>
+ <para>
+ Enter your bip user information in the
<guilabel>Password:</guilabel>. The form is
<emphasis>bip_username:bip_connection:bip_user_password</emphasis>. To use
the freenode connection from the earlier steps, this would be:
+ </para>
+ <screen>
+
fedorauser:freenode:<replaceable>bip_user_password</replaceable>
+ </screen>
+ </step>
+ <step>
+ <para>
+ If you choose, checking the box for <guilabel>Connect to this
network automatically</guilabel> will configure hexchat to connect to your bouncer
every time hexchat is opened.
+ </para>
+ </step>
+ </substeps>
</step>
</substeps>
</step>