Documentation fixes
- update bip.vim and bip.conf sample files - remove nonsense LOG_STD log level
This commit is contained in:
Loc Gomez
parent
89e88f6b7b
commit
efe0c43b9c
74
bip.conf.5
74
bip.conf.5
@ -61,43 +61,6 @@ also find an example configuration file along with BIP.
|
||||
|
||||
.SH GLOBAL OPTIONS
|
||||
|
||||
.TP
|
||||
\fBbacklog\fP (default: \fBtrue\fP)
|
||||
Enable or disable the whole backlog system, which allows clients to see a
|
||||
log replay upon connection.
|
||||
|
||||
.TP
|
||||
\fBbacklog_always\fP (default: \fBfalse\fP)
|
||||
If true, clients will always receive \fBbacklog_lines\fP log lines, even if
|
||||
they were already sent before. That means :
|
||||
If \fBbacklog_always\fP is false, backlog will be reset whenever there
|
||||
is no more client connected to a network. Else backlog will not be reset.
|
||||
This option should of course not be enabled if \fBbacklog_lines\fP is 0 !
|
||||
If you still want to do so, don't forget to /BIP BLRESET sometimes.
|
||||
|
||||
.TP
|
||||
\fBbacklog_lines\fP (default: \fB10\fP)
|
||||
If set to 0, BIP will replay all the logs since last client disconnect. Else,
|
||||
it'll replay exactly \fBbacklog_lines\fP lines on each channel and privates.
|
||||
Be aware that BIP will replay \fBbacklog_lines\fP lines of all privates, even
|
||||
if there are more. For example if Coyote told you 12 lines and then RoadRunner
|
||||
6, you'll only have a replay of the 6 RoadRunner's lines and the last 4 of
|
||||
Coyote's.
|
||||
|
||||
\fBbacklog_no_timestamp\fP (default: \fBfalse\fP)
|
||||
If true, backlogged line won't include the timestamp.
|
||||
|
||||
.TP
|
||||
\fBbacklog_reset_on_talk\fP (default: \fBfalse\fP)
|
||||
When true, backlog will be reset 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 that specific network.
|
||||
|
||||
.TP
|
||||
\fBbacklog_msg_only\fP (default: \fBfalse\fP)
|
||||
When true, bip will backlog only channel/private messages/notices. No topic
|
||||
change, nick change, user quit/part/join will be backlogged upon connection.
|
||||
|
||||
.TP
|
||||
\fBclient_side_ssl\fP (default: \fBfalse\fP)
|
||||
When true, clients will need to connect to BIP using SSL.
|
||||
@ -201,6 +164,43 @@ options. It may appear more than once in the configuration file.
|
||||
If a user has admin set to true, he'll become a bip administrator, which allows
|
||||
him for example to RELOAD bip from IRC or to see the user configuration.
|
||||
|
||||
.TP
|
||||
\fBbacklog\fP (default: \fBtrue\fP)
|
||||
Enable or disable the whole backlog system, which allows clients to see a
|
||||
log replay upon connection.
|
||||
|
||||
.TP
|
||||
\fBbacklog_always\fP (default: \fBfalse\fP)
|
||||
If true, clients will always receive \fBbacklog_lines\fP log lines, even if
|
||||
they were already sent before. That means :
|
||||
If \fBbacklog_always\fP is false, backlog will be reset whenever there
|
||||
is no more client connected to a network. Else backlog will not be reset.
|
||||
This option should of course not be enabled if \fBbacklog_lines\fP is 0 !
|
||||
If you still want to do so, don't forget to /BIP BLRESET sometimes.
|
||||
|
||||
.TP
|
||||
\fBbacklog_lines\fP (default: \fB10\fP)
|
||||
If set to 0, BIP will replay all the logs since last client disconnect. Else,
|
||||
it'll replay exactly \fBbacklog_lines\fP lines on each channel and privates.
|
||||
Be aware that BIP will replay \fBbacklog_lines\fP lines of all privates, even
|
||||
if there are more. For example if Coyote told you 12 lines and then RoadRunner
|
||||
6, you'll only have a replay of the 6 RoadRunner's lines and the last 4 of
|
||||
Coyote's.
|
||||
|
||||
\fBbacklog_no_timestamp\fP (default: \fBfalse\fP)
|
||||
If true, backlogged line won't include the timestamp.
|
||||
|
||||
.TP
|
||||
\fBbacklog_reset_on_talk\fP (default: \fBfalse\fP)
|
||||
When true, backlog will be reset 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 that specific network.
|
||||
|
||||
.TP
|
||||
\fBbacklog_msg_only\fP (default: \fBfalse\fP)
|
||||
When true, bip will backlog only channel/private messages/notices. No topic
|
||||
change, nick change, user quit/part/join will be backlogged upon connection.
|
||||
|
||||
.TP
|
||||
\fBbip_use_notice\fP (default: \fBfalse\fP)
|
||||
If \fBbip_use_notice\fP is true, bip's notifications to the clients will be
|
||||
|
||||
@ -20,10 +20,20 @@ client_side_ssl = false;
|
||||
# serve SSL clients. If unset, it defaults to <biphome>/bip.pem
|
||||
#client_side_ssl_pem = "/path/to/pemfile";
|
||||
|
||||
log_level = 3;
|
||||
|
||||
# Define where the pidfile should be stored. Defaults to <biphome>/bip.pid
|
||||
#pid_file="/var/run/bip/bip.pid";
|
||||
|
||||
# Uncomment this line to disable logging and backlogging.
|
||||
#log = false
|
||||
|
||||
# Define bip's log level :
|
||||
# 0 : only fatal errors
|
||||
# 1 : add others errors
|
||||
# 2 : add warnings
|
||||
# 3 : add info messages
|
||||
# 4 : add debug messages
|
||||
log_level = 3;
|
||||
|
||||
# This is where logs go. Channel and private messages will use that
|
||||
# configuration value as a prefix, and then log_format to determine
|
||||
# full log filename.
|
||||
@ -132,13 +142,15 @@ user {
|
||||
backlog_lines = 10; # number of lines in backlog, 0 means
|
||||
# no limit
|
||||
backlog_always = true; # backlog even lines already backlogged
|
||||
# = do not reset backlog when no client
|
||||
# attached anymore
|
||||
#backlog_no_timestamp = false; # Disables time stamps if you find them
|
||||
# ugly.
|
||||
|
||||
# If blreset_on_talk talking on an irc network has the same effect of
|
||||
# issuing /bip blreset, meaning that stuffed logged before the command
|
||||
# won't be read back on backlog
|
||||
#blreset_on_talk = false;
|
||||
#backlog_reset_on_talk = false;
|
||||
|
||||
# If bl_msg_only is true, only channel and private messages will be
|
||||
# backlogged upon the reconnection of a client. Default is false, thus
|
||||
@ -158,7 +170,6 @@ user {
|
||||
|
||||
# If you have multiple IP addresses, you can set the one you
|
||||
# want bip to use here. See manpage for more information.
|
||||
|
||||
#vhost = "192.168.10.6";
|
||||
|
||||
# When source_port is defined, bip will connect to the IRC
|
||||
@ -167,6 +178,7 @@ user {
|
||||
#source_port = "4567";
|
||||
|
||||
# these will be sent to the real server
|
||||
#nick = "othernick";
|
||||
#user = "otheruser";
|
||||
#realname = "otheruser";
|
||||
#password = "serverpassword";
|
||||
@ -177,7 +189,6 @@ user {
|
||||
#no_client_away_msg = "Having life, knock again later";
|
||||
#follow_nick = true;
|
||||
#ignore_first_nick = true;
|
||||
#on_connect_send = "PRIVMSG NickServ :IDENTIFY nspassword";
|
||||
|
||||
# Autojoined channels:
|
||||
channel { name = "#bip"; };
|
||||
|
||||
@ -53,6 +53,7 @@ syn region bipMain start=/\%^/ end=/\%$/
|
||||
|
||||
" Top level elements
|
||||
syn keyword bipKeyword contained nextgroup=bipBoolV client_side_ssl
|
||||
\ log log_system
|
||||
syn keyword bipKeyword contained nextgroup=bipStringV log_root
|
||||
\ log_format pid_file client_side_ssl_pem
|
||||
syn keyword bipKeyword contained nextgroup=bipNumericV port log_level
|
||||
@ -72,24 +73,23 @@ syn region bipUser contained matchgroup=Macro start=/user\s*{\s*/
|
||||
\ contains=bipUKeyword,bipConnection,bipComment,bipEndError,bipWhite
|
||||
syn keyword bipUKeyword contained nextgroup=bipStringV password name
|
||||
\ default_nick default_user default_realname ssl_check_store
|
||||
\ ssl_check_mode
|
||||
\ ssl_check_mode ssl_client_certfile
|
||||
syn keyword bipUKeyword contained nextgroup=bipNumericV backlog_lines
|
||||
syn keyword bipUKeyword contained nextgroup=bipBoolV admin
|
||||
\ no_backlog always_backlog bl_msg_only blreset_on_talk
|
||||
\ backlog_no_timestamp backlog log_system backlog_reset_on_talk
|
||||
" DEPRECATED \ always_backlog bl_msg_only blreset_on_talk
|
||||
\ backlog_no_timestamp backlog backlog_reset_on_talk
|
||||
\ backlog_msg_only backlog_always bip_use_notice
|
||||
|
||||
" Connection block (level 2)
|
||||
syn region bipConnection contained matchgroup=Macro
|
||||
\ start=/connection\s*{\s*/ end=/};/
|
||||
\ contains=bipCoKeyword,bipChannel,bipComment,bipEndError,bipWhite
|
||||
syn keyword bipCoKeyword contained nextgroup=bipBoolV ssl follow_nick
|
||||
syn keyword bipCoKeyword contained nextgroup=bipBoolV follow_nick
|
||||
\ ignore_first_nick
|
||||
syn keyword bipCoKeyword contained nextgroup=bipStringV name user nick
|
||||
\ network password vhost away_nick on_connect_send realname
|
||||
\ no_client_away_msg ssl_check_mode
|
||||
syn keyword bipCoKeyword contained nextgroup=bipNumericV source_port
|
||||
no_client_away_msg
|
||||
|
||||
" Channel elements (lvl 2)
|
||||
syn region bipChannel contained matchgroup=Macro
|
||||
|
||||
@ -250,8 +250,8 @@ pid_is_there:
|
||||
}
|
||||
if (pid)
|
||||
mylog(LOG_INFO, "pid file found (pid %ld).", pid);
|
||||
mylog(LOG_STD, "Another instance of bip is certainly runing.");
|
||||
mylog(LOG_STD, "If you are sure this is not the case remove"
|
||||
mylog(LOG_FATAL, "Another instance of bip is certainly runing.");
|
||||
mylog(LOG_FATAL, "If you are sure this is not the case remove"
|
||||
" %s.", conf_pid_file);
|
||||
exit(2);
|
||||
}
|
||||
|
||||
@ -97,7 +97,7 @@ command:
|
||||
| LEX_IP LEX_EQ LEX_STRING { $$ = tuple_s_new(LEX_IP, $3); }
|
||||
| LEX_PORT LEX_EQ LEX_INT { $$ = tuple_i_new(LEX_PORT, $3); }
|
||||
| LEX_CSS LEX_EQ LEX_BOOL { $$ = tuple_i_new(LEX_CSS, $3); }
|
||||
| LEX_CSS_PEM LEX_EQ LEX_STRING { $$ = tuple_s_new(LEX_CSS_PEM, $3); }
|
||||
| LEX_CSS_PEM LEX_EQ LEX_STRING { $$ = tuple_s_new(LEX_CSS_PEM, $2); }
|
||||
| LEX_LOG LEX_EQ LEX_BOOL { $$ = tuple_i_new(LEX_LOG, $3); }
|
||||
| LEX_LOG_SYSTEM LEX_EQ LEX_BOOL { $$ = tuple_i_new(LEX_LOG_SYSTEM, $3); }
|
||||
| LEX_LOG_SYNC_INTERVAL LEX_EQ LEX_INT { $$ = tuple_i_new(
|
||||
|
||||
@ -18,7 +18,6 @@
|
||||
#include <stdarg.h>
|
||||
|
||||
/* Warning: must be in order, 0 = less output */
|
||||
#define LOG_STD -1
|
||||
#define LOG_FATAL 0
|
||||
#define LOG_ERROR 1
|
||||
#define LOG_WARN 2
|
||||
|
||||
Loading…
Reference in New Issue
Block a user