DESCRIPTION
A BIP configuration file consists of a list of variable affectations or
sections. It contains the global options, networks definitions, users
configuration, users connections declarations. Each section is
described in this manpage.
The bip.conf skeleton should be something like this :
option1 = value;
option2 = value;
network {
net_opt = value;
...
server { ... };
server { ... };
};
user {
user_opt = value;
...
connection {
conn_opt = value;
...
channel { ... };
};
connection {
conn_opt = value;
...
channel { ... };
channel { ... };
...
};
};
SYNTAX RULES
The syntax is quite simple :
- everything after the # character is ignored (comments)
- each variable affectation must be finished with a ;
- each section { } must be finished with a ;
If you use vim you will probably want to use vim with the provided
bip.vim syntax file to avoid common syntax and lexical mistakes. You
can also find an example configuration file along with BIP.
GLOBAL OPTIONS
backlog_always (default: false)
If true, clients will always receive backlog_lines log lines,
even if they were already sent before. This option should of
you'll only have a replay of the 6 RoadRunner's lines and the
last 4 of Coyote's.
backlog_no_timestamp (default: false) If true, backlogged line
won't include the timestamp.
backlog_reset_on_talk (default: false)
When true, backlog will not be reset upon client disconnection
but upon client talk (channel/private message or action). It
means that next time you log to your bip session the backlogging
will start at the time right after your last words on irc.
backlog_msg_only (default: false)
When true, bip will backlog only channel/private mes-
sages/notices. No topic change, nick change, user quit/part/join
will be backlogged upon connection.
client_side_ssl (default: false)
When true, clients will need to connect to BIP using SSL.
ip Ignored for the time beeing.
log (default: true)
When true, the log system is enabled. Else, BIP will not write a
single log file. Backlog is then stored into memory.
log_format (default: %u/%n/%Y-%m/%c.%d.log)
Determines the log file name depending on :
- %u username (name in user { }; section)
- %n network name (name in connection { }; section)
- %c channel name
- %Y 4 digits year
- %m 2 digits month
- %d 2 digits day
log_level (default: 1)
Specify the verbosity of BIP from 0 (fatal errors) to 6 (huge
debug output)
log_root (default: HOME/.bip/logs)
Main log directory. Sub-directories and files will be created
from there depending on log_format.
NETWORK SECTION
This section allows you to declare a network for use in the connection
sections. It may appear more than once in the configuration file.
ssl (default: false)
If true, BIP will connect to this network using SSL only. You
cannot mix SSL servers and non-SSL servers in the same network
section. This is by choice, we believe it's a bad idea.
name It's the network name used in the connection section. Please
note that this value is not used in log_format, since it uses
the variable name from the connection section.
SERVER SUB-SECTION
BIP will cycle through the server sections list when reconnecting to a
network. It may appear more than once in a network section.
host The server's hostname or IP address.
port (default: 6667)
The server port to connect to.
USER SECTION
This section allows you to define the users allowed to connect to BIP
and their options. It may appear more than once in the configuration
file.
default_nick
The default nick option for each connection section where no
nick is defined. See CONNECTION SECTION for more details.
default_realname
The default realname option for each connection section where no
realname is defined. See CONNECTION SECTION for more details.
default_user
The default user option for each connection section where no
user is defined. See CONNECTION SECTION for more details.
name The user name. It'll be used to authenticate to bip and in
log_format.
ssl_check_store (default: not set)
This repository is browsed by BIP when a SSL certificate or CA
check is needed.
CONNECTION SUB-SECTION
Each connection section associates a user to the networks he wants to
connect to. Thus, it must be declared in the user sections, and can be
used more than once.
away_nick (default: not set)
If true, and if there are no more client attached, BIP will
change nickname to this away_nick. Your nickname will be
restored upon client connect.
no_client_away_msg (default: not set)
This options allows you to set an away message. This away mes-
sage will be set when the last client disconnects, and removed
when a client connects.
follow_nick (default: false)
If set to true, when you change nick, BIP stores the new nick-
name as the new default nickname value. Thus, if you are discon-
nected from the server, BIP will restore the correct nickname.
ignore_first_nick (default: false)
If set to true, BIP will ignore the nickname sent by the client
upon connect. Further nickname changes will be processed as
usual.
network
The network name. See the NETWORK SECTION.
nick BIP will send that string as your nickname upon connect. If not
specified and if default_nickname is specified in the user sec-
tion, BIP will use that default nickname string.
on_connect_send
You can specify this field more than once. BIP will send the
text as is to the server. It'd be useful for a greet on connect
or to send you NickServ password.
password
user BIP will send that string as the user part (usually between !
and @ in a whois result) upon connect. It's also used by the
oidentd support (if enabled). If not specified and if
default_user is specified in the user section, BIP will use that
default user string.
vhost If specified, BIP will use vhost as the IP address to bind to
when connecting to the IRC server. It'll allow you to use a spe-
cific IP address for this network when you have more than one.
This options is totally useless to people who only have one IP
address.
CHANNEL SUB-SUB-SECTION
This section defines the list of channels to join for a user on a par-
ticular network. It is to be found in the connection sections and
appear more than once in a connection section.
name The channel name (#bip, &bip, ...).
key The channel key if needed.
SEE ALSO
bip, bipmkpw
AUTHOR
bip authors:
Arnaud 'nohar' Cornet
Loic 'Kyoshiro' Gomez
Thanks to jj, YS and lafouine, for hanging around while we were coding.
Crypto shamelessly taken from Christophe 'sexy' Devine.
This man page is written by Loic 'Kyoshiro' Gomez.
10 October 2005 BIP(1)
Man(1) output converted with
man2html