'########::'####:'##::::'##:'########:::::'########::'##::: ##::'######::
 ##.... ##:. ##:: ###::'###: ##.... ##:::: ##.... ##: ###:: ##:'##... ##:
 ##:::: ##:: ##:: ####'####: ##:::: ##:::: ##:::: ##: ####: ##: ##:::..::
 ########::: ##:: ## ### ##: ########::::: ########:: ## ## ##: ##:::::::
 ##.....:::: ##:: ##. #: ##: ##.....:::::: ##.... ##: ##. ####: ##:::::::
 ##::::::::: ##:: ##:.:: ##: ##::::::::::: ##:::: ##: ##:. ###: ##::: ##:
 ##::::::::'####: ##:::: ##: ##::::::::::: ########:: ##::. ##:. ######::
..:::::::::....::..:::::..::..::::::::::::........:::..::::..:::......:::
0.9.1

PimpBNC web configuration

AUTH

Client authentication settings

PASSWORD_TYPE
Required: Yes
Key name: PASSWORD_TYPE
Description:
Password type for "PASSWORD". 0=plain text, 1=crypt(). Run PimpBNC with --crypt to generate crypt() password
Arguments: 0|1

Go to top

PASSWORD
Required: Yes
Key name: PASSWORD
Description:
Plain or encrypted password clients must supply when connecting
Arguments: plain_password|encrypted_password

Go to top

AWAY

Changes nick, performs commands and logs messages while you are away

AWAY_AT
Required: No
Key name: AWAY_AT
Description:
Away mode is activated when number of clients connected is this number of below
Arguments: number

Go to top

AWAY_MESSAGE
Required: No
Key name: AWAY_MESSAGE
Description:
Use this message when marking away at server
Arguments: message

Go to top

AWAY_FILE
Required: No
Key name: AWAY_FILE
Description:
Save away-log to this file. If no filename is given, logging is disabled.
Arguments: filename

Go to top

AWAY_COMMAND
Required: No
Key name: AWAY_COMMAND
Description:
Perform this command when set away. msg nick text - Message a nick with a reason. You can also use notice. amsg text - Send this text to all channels you are on. You can also use anotice. raw command - Perform this raw command. You can type multiple nicks by using coma ("nick1,nick2,nick3") or even channels instead of nicks ("#chan1,#chan2".)
Arguments: (amsg|msg|anotice|notice|raw) text

Go to top

AWAY_NICK
Required: No
Key name: AWAY_NICK
Description:
Change to this nick when set away. Will try to change back when you connect again.
Arguments: nick

Go to top

BUGREPORTS

Sending bugreports to the authors of PimpBNC

INCLUDE_LOG
Required: Yes
Key name: INCLUDE_LOG
Description:
Include log-file when sending bug-report. PimpBNC will try to filter out sensitive data before sending. We will -ONLY- use the data sent to locate and fix bugs in PimpBNC!!
Arguments: Yes or No
Yes No
Go to top

FROM
Required: Yes
Key name: FROM
Description:

Arguments: E-mail address

Go to top

CHANNEL

DCC

Route DCC to correct client, bounce dcc, proxy dcc

DISABLE_DCC_PROCESSING
Required: No
Key name: DISABLE_DCC_PROCESSING
Description:
Disable all processing of DCC
Arguments: Yes or No
Yes No
Go to top

DEBUGGING

Various debug options

DEBUG_COMPRESS_APP
Required: No
Key name: DEBUG_COMPRESS_APP
Description:
What application to pipe through
Arguments: application

Go to top

DEBUG
Required: No
Key name: DEBUG
Description:
Enable debugging Lots of crap and sensitive data such as your conversations will be logged
Arguments: Yes or No
Yes   No
Go to top

DEBUG_COMPRESS
Required: No
Key name: DEBUG_COMPRESS
Description:
Pipe log output through an external application to compress it
Arguments: Yes or No
Yes   No
Go to top

DEBUG_TO_CLIENT
Required: No
Key name: DEBUG_TO_CLIENT
Description:
Send debug info to client
Arguments: Yes or No
Yes   No
Go to top

DEBUG_APPEND
Required: No
Key name: DEBUG_APPEND
Description:
Append to log file instead of overwriting it when PimpBNC starts
Arguments: Yes or No
Yes   No
Go to top

DEBUG_FILE
Required: No
Key name: DEBUG_FILE
Description:
Write debug log to this file Set it to blank to log to console
Arguments: filename

Go to top

GENERAL

General settings

DISABLE_LISTEN
Required: No
Key name: DISABLE_LISTEN
Description:
Disable listening for clients
Arguments: Yes or No
Yes   No
Go to top

DISABLE_SERVER
Required: No
Key name: DISABLE_SERVER
Description:
Disable connecting to IRC server
Arguments: Yes or No
Yes   No
Go to top

RECONNECT_ON_STONED_SERVER
Required: No
Key name: RECONNECT_ON_STONED_SERVER
Description:
Most (all?) IRC servers send a PING singal to the client every now and then to see if it's still alive. This signal is usually send every 30-300 seconds depending on server configuration. If the IRC server is down or other network problems occure that PimpBNC can't detect then this option will reconnect you to the IRC servers.
Arguments: seconds

Go to top

MSG_FROM
Required: No
Key name: MSG_FROM
Description:
PimpBNC's nick/user/host This will be used when sending messages to your client
Arguments: nick!user@host

Go to top

BACKGROUND
Required: No
Key name: BACKGROUND
Description:
Run in background / release console Note! fork() must be supported by operating system Windows does not support fork, but most other operating systems does!
Arguments: Yes or No
Yes   No
Go to top

PID_FILE
Required: No
Key name: PID_FILE
Description:
If a filename is specified here, PimpBNC will store it's PID in this file. It also prevents you from accedentially running two PimpBNC's at the same time
Arguments: filename

Go to top

LOGO_FILE
Required: No
Key name: LOGO_FILE
Description:
PimpBNC will use the logo's in the file when starting up. If this file dosen't exists PimpBNC will complain but nothing else
Arguments: filename

Go to top

HOOKS

Internal hook system. You probably don't need to change this unless you are a developer.

HOOK_SAFE_MODE
Required: No
Key name: HOOK_SAFE_MODE
Description:
Enables safe-mode for hooks. It is slower, gives less information when something goes wrong but totally safe. If you enable this option, almost all code run internally will be recompiled and evaluated every time it's run.
Arguments: Yes or No
Yes   No
Go to top

HOOK_CHECK_SUBS
Required: No
Key name: HOOK_CHECK_SUBS
Description:
Check if a sub exists before attempting to execute it. Normally PimpBNC shuts down (with lots of debug info) if a sub that doesn't exist is called from a hook. Disable this only if you are a developer that needs to troubleshoot your code. When developing modules it is advicable to disable BACKGROUND mode as well.
Arguments: Yes or No
Yes   No
Go to top

HOOK_DEBUG
Required: Yes
Key name: HOOK_DEBUG
Description:
Hook debugging takes up very much disc space because it logs all internal sub-calls. This is a sort of last-resourt debugging for developers. It generates something like 10-15 times more data than what is received from the server. Will not work if DEBUG_TO_CLIENT is enabled.1
Arguments: Yes or No
Yes   No
Go to top

MODULES

Settings related to loading of extra modules and scripts

LOAD_EXTRAS
Required: No
Key name: LOAD_EXTRAS
Description:
Load extra modules (part from PimpBNC core) from folder(s) specified in EXTRAS_FOLDER
Arguments: Yes or No
Yes No
Go to top

EXTRAS_FOLDER
Required: No
Key name: EXTRAS_FOLDER
Description:
If LOAD_EXTRAS is set to 1, load all modules found in this/these folders
Arguments: path|{ path1 path2 etc }

Go to top

NETWORK

Options related to listening for incoming connections from clients and connecting to servers

KEEP_CLIENTS_CONNECTED
Required: No
Key name: KEEP_CLIENTS_CONNECTED
Description:
Set this option to yes if you do not want PimpBNC to disconnect your client(s) when (re)connecting to server. Note that many clients depend on reconnecting, and might not work if this option is set to Yes.
Arguments: Yes or No
Yes No
Go to top

LISTEN_PORT
Required: Yes
Key name: LISTEN_PORT
Description:
This is the PORT PimpBNC will be listening on. When connecting to PimpBNC you must specify this port in the client! Note that on many systems (such as Linux/Unix/BSD) you must have root privelegies to listen on ports below 1024. You can only listen to a specific port with one application at the time, and it doesn't really matter witch port you choose.
Arguments: number between 1 and 65535

Go to top

USER
Required: Yes
Key name: USER
Description:
Set the username you will be using on IRC (nick!username@host).
Arguments: username

Go to top

NEVER_GIVE_UP
Required: No
Key name: NEVER_GIVE_UP
Description:
Keep trying to connect even if the first server isn't up.
Arguments: Yes or No
Yes No
Go to top

MAX_CLIENTS
Required: No
Key name: MAX_CLIENTS
Description:
How many simultaneous clients that can connect 0 = unlimited
Arguments: number

Go to top

REMOTE_HOST
Required: No
Key name: REMOTE_HOST
Description:
List of servers to connect to. Note that this version of PimpBNC will only connect to one IRC server at the time!
Arguments: { server1 server2:port server3:port:password }

Go to top

LOCAL_IP
Required: No
Key name: LOCAL_IP
Description:
What IP address to use when connecting to IRC server. The IP address must exist on your system.
Arguments: none|ip-address

Go to top

LISTEN_IP
Required: No
Key name: LISTEN_IP
Description:
Bind to this IP address when listening Leave blank to listen on all
Arguments: none|ip-address

Go to top

NICK
Required: Yes
Key name: NICK
Description:
Set the nick names PimpBNC will try when connecting to a server.
Arguments: { nick1 nick2 nick3 }

Go to top

REALNAME
Required: Yes
Key name: REALNAME
Description:
Set the name or information you want to show up when people whois you.
Arguments: Your name

Go to top

DEFAULT_REMOTE_PORT
Required: Yes
Key name: DEFAULT_REMOTE_PORT
Description:
Default server-port, will be used if none specified in server list
Arguments: number between 1 and 65535

Go to top

RECONNECT_DELAY
Required: No
Key name: RECONNECT_DELAY
Description:
Number of seconds to wait before trying next server in list.
Arguments: none|seconds

Go to top

ROUTING

Routing of data between clients and server

ROUTE_TEXT_TO_CLIENTS
Required: Yes
Key name: ROUTE_TEXT_TO_CLIENTS
Description:
Route PRIVMSG and NOTICE from a client to all other clients (others can see what one is saying)
Arguments: Yes or No
Yes No
Go to top

STARTUP

Startup sequence configuration

TIME_STARTUP_SEQUENCE
Required: Yes
Key name: TIME_STARTUP_SEQUENCE
Description:
Show time used on different elements of startup sequence
Arguments: Yes or No
Yes No
Go to top

SHOW_MODULES
Required: Yes
Key name: SHOW_MODULES
Description:
Show what modules are being compiled
Arguments: Yes or No
Yes No
Go to top

TRANSLATION

PimpBNC translation settings (NOT DONE YET!)

PBNC_LANGUAGE_FILE
Required: No
Key name: PBNC_LANGUAGE_FILE
Description:
Translation file. PimpBNC will use this to translate it's messages into another language
Arguments: path and file

Go to top

UPDATE

Options related to update notification and automatic updating

UPDATECHECK_ON_STARTUP
Required: No
Key name: UPDATECHECK_ON_STARTUP
Description:
Check for new version of PimpBNC during startup and notify if new found
Arguments: Yes or No
Yes   No
Go to top

UPDATECHECK_ON_CONNECT
Required: No
Key name: UPDATECHECK_ON_CONNECT
Description:
Check for new version of PimpBNC when clients connect and notify them if new found
Arguments: Yes or No
Yes   No
Go to top

SEND_USAGE
Required: No
Key name: SEND_USAGE
Description:
Send OS version, PERL version and PimpBNC version when querying for update (used for statistics)
Arguments: Yes or No
Yes   No
Go to top

AUTO_UPDATE
Required: No
Key name: AUTO_UPDATE
Description:
Automatic update of PimpBNC while running. This is a hairy process still in BETA, it MIGHT crash PimpBNC. It will also overwrite existing source files, so if you have made any changes to them DO NOT ENABLE THIS! Currently checks for update on startup and when a client authenticates (connects to PimpBNC)
Arguments: Yes or No
Yes   No
Go to top

Categories