Help - Basic Parameters

Sections

Basic Parameters

parameters are passed to the applet via the following syntax :

<param name="name" value="value">

Parameter NameInformation
nick

default nick to be used. '?' characters will be replaced by random numbers.

Example:

<param name="nick" value="Guest??">

name

"real" user name, sent to IRC server.

If you type /whois NickName you will get a line like this:-

NickName is UserId@you.yourip.com * RealName

If you don't specify a UserID param then name will be copied into userid as well.

This param is mandatory, and the applet will not work without it.

Example:

<param name="name" value="RealName">

host

IRC server host.

Example:

<param name="host" value="irc.server.net">

gui

PJIRC graphical user interface.

Example:

<param name="gui" value="pixx">

port

IRC server port.

Default Value:
6667
Example:

<param name="port" value="6667">

commandX, with X a figure

Tells the applet to execute this command once

connected to the server.

Example:

<param name="command1" value="/nickserv identify password">

<param name="command2" value="/join #channel">

language

sets the langage to be used. The name corresponds to a langage file

that must be accessible from the applet. For example, if there is

a file lang/mylang.lng, then you may enter value="lang/mylang".

Default Value:
english
Example:

<param name="language" value="french">

quitmessage

sets the quit message.

Default Value:
empty
Example:

<param name="quitmessage" value="PJIRC forever!">

asl

enable or disable asl handling. Asl (for age, sex and localtion) is

parsed from the full user name. Other parts of the software may behave

differently provided the nick is male or female, its age, and so on...

The full name format is expected to be "age sex localtion", for instance

"22 m Belgium".

Default Value:
disabled
Example:

<param name="asl" value="true">

aslmale

set the string corresponding to the male gender in the full name for

asl parsing.

Default Value:
m
Example:

<param name="aslmale" value="m">

aslfemale

set the string corresponding to the female gender in the full name

for asl parsing.

Default Value:
f
Example:

<param name="aslfemale" value="f">

aslunknown

set the string corresponding to the unknown gender in the full name

for asl parsing.

Default Value:
x
Example:

<param name="aslunknown" value="x">

useinfo

replace the status window by the info window. The info window acts

exactly as the status window, but only shows motd and welcome

messages. Since whois etc... results are no more shown, popup

commands such as whois, finger, etc... are disabled.

Default Value:
disabled
Example:

<param name="useinfo" value="false">

soundbeep

set the beep sound. The beep sound is the sound played when the

/beep command is used. The file must be in .au format.

Example:

<param name="soundbeep" value="snd/bell2.au">

soundquery

set the incoming private sound. The sound is played when a new

private source is opened.

Example:

<param name="soundquery" value="snd/ding.au">

password

set the server password on connection.

Example:

<param name="password" value="mysecretpassword">

alternatenick

set the alternate nickname, to be used if primary nickname is

already used on the server.

Example:

<param name="alternatenick" value="someothernick">

languageencoding

set the language file encoding to be used. If not

specified, default encoding will be used.

Example:

<param name="languageencoding" value="UnicodeLittle">

authorizedjoinlist

set the list of channels the user is authorized to join.

Syntax is "all#channel1#channel2..." or

"none+#channel1+#channel2+...".

If the channel name contains a "-" or a "+" then you must escape it to use it.

eg: "\-"

so that #Myroom-xpc01

becomes #Myroom\-xpc01

Default Value:
all
Example:

<param name="authorizedjoinlist" value="none+#mychannel">

authorizedleavelist

set the list of channels the user is authorized to

leave. Syntax is "all#channel1#channel2..." or

"none+#channel1+#channel2+...".

f the channel name contains a "-" or a "+" then you must escape it to use it.

eg: "\-"

so that #Myroom-xpc01

becomes #Myroom\-xpc01

Default Value:
all
Example:

<param name="authorizedleavelist" value="all#mychannel">

authorizedcommandlist

set the list of command the user is athorized to do.

Syntax is "all-command1-command2..." or "none+command1+command2+...". Don't prefix the command with the / character.

Default Value:
all
Example:

<param name="authorizedcommandlist" value="none+me">

coding

specify what encoding algorithm should be used for sending the text

to the irc server. Values are :

0 : strict ascii, MSB is dropped, shouldn't be used.

1 : pjirc unicode to ascii protocol, charcode is sent as it if

below than u0x00ff. Should be used if pjirc is used with

other non UTF8 compatible clients.

2 : UTF8

3 : local charset coding, should be avoided when possible for

compatibility reasons

Default Value:
1
Example:

<param name="coding" value="2">

lngextension

modify the default lng file extension.

Default Value:
lng
Example:

<param name="lngextension" value="txt">

userid

set the userid. The user id will be used for ident id and for

user name at connecttime.

If you type /whois NickName you will get a line like this:-

NickName is UserId@you.yourip.com * RealName

If the id is empty, then the name param will be used for id, and nickname will be used as username

at connect time.

Default Value:
Uses name param.
Example:

<param name="userid" value="UserID">

autoconnection

set whether the applet should try to trigger connection

as soon at it is launched.

Default Value:
true
Example:

<param name="autoconnection" value="false">

useidentserver

enable or disable the ident server.

Default Value:
enabled
Example:

<param name="useidentserver" value="false">

mutliserver

enable or disable the multiserver support.

Default Value:
disabled
Example:

<param name="multiserver" value="true">

alternateserverI

set the Ith alternate server. Syntax is

"host port" or "host port password".

Please note that the port is mandatory. The parameter will not work without it.

Example:

<param name="alternateserver1" value="irc.secondhost.com 6667">

serveralias

set the default server alias.

Default Value:
empty
Example:

<param name="serveralias" value="Alias">

noasldisplayprefix

set the "no display asl" full name prefix. If the

user's full name begins with this prefix, then

the floating asl window won't be displayed. An

empty string disables this feature.

Default Value:
disabled
Example:

<param name="noasldisplayprefix" value="true">

smileys

sets whether smileys should be replaced by graphical representations.

Default Value:
false
Example:

<param name="style:smileys" value="true">

righttoleft

set righttoleft display, instead of lefttoright default display.

Default Value:
false
Example:

<param name="style:righttoleft" value="true">

sourcecolorruleN

set the Nth source color rule. Rule syntax is

"type name index1=color1 index2=color2 ...".

Example:

<param name="style:sourcecolorrule1" value="none+Channel all 0=00ff00">

<param name="style:sourcecolorrule2" value="none+Query none+some_nick 0=000000 1=ffffff">

sourcefontruleN

set the Nth source font rule. Rule syntax is

"type name fontname fontsize".

Example:

<param name="style:sourcefontrule1" value="none+Channel all Arial 12">

backgroundimage

toggle master background image switch. If this flag is

turned off, all background images will be ignored.

Default Value:
false
Example:

<param name="style:backgroundimage" value="true">

backgroundimageX

background image configuration number X. Syntax is "sourcetype sourcename tiling image" with sourcetype and sourcename the target source type and name, tiling a figure and image the image file name. Valid source types are DCCChat, Channel, Query, Status, ChanList and Default. As for the command parameter, there can't be any gap in the X indexes.

Possible tiling values are:

0 : Center

1 : Stretch

2 : Tiling

3 : Top left

259 : Top right

515 : Bottom left

771 : Bottom right

Example:

<param name="style:backgroundimage1" value="none+channel none+#happy 1 img/content.gif">

<param name="style:backgroundimage2" value="none+Query all 2 img/soleil.gif">

bitmapsmileys

enable or disable bitmap smileys. Once enabled, bitmaps are

defined via the smiley parameter. This parameter has no effect if smileys are disabled.

Default Value:
false
Example:

<param name="style:bitmapsmileys" value="true">

smileyX

set the Xnth smiley. A smiley is a pair of text>image. Each time

the text is found on a line, it will be replaced by the

corresponding image. As for the command parameter, the first smiley

must be smiley1 and there must'nt be any gap. The format of the

parameter is "text image", where image is any URL the applet can

access.

Example:

<param name="style:smiley1" value=" img/smile.gif">

<param name="style:smiley2" value=" img/sad.gif">

floatingasl

activate "mouseover" floating asl information. "asl" parameter may be also activated, but this is not mandatory.

Default Value:
disabled
Example:

<param name="style:floatingasl" value="true">

floatingaslalpha

set the floating asl alpha transparency value. Between 0

and 255, 0 is invisible and 255 fully opaque. This parameter may be ignored if the java virtual machine doens't support transparency.

Default Value:
170
Example:

<param name="style:floatingaslalpha" value="150">

pluginX

set the Xth plugin to be loaded at startup.

Example:

<param name="plugin1" value="MyPlugin">

soundwordX

set the Xth sound configuration. Syntax is "word sound". When "word" is detected in a message, then "sound" is played.

Example:

<param name="soundword1" value="lol snd/lol.au">

fingerreply

set the finger reply.

Example:

<param name="fingerreply" value="A lucky Plouf's IRC user">

fileparameter

URL to the file containing all PJIRC parameters. If this parameter is used, then no other parameter will be taken into account and the specified configuration file will be used instead. The configuration file format is the same as the pjirc.cfg file.

Example:

<param name="fileparameter" value="pjirc.cfg">

aslseparatorstring

set the asl separator string. When the ASL parser reach this string, the parsing stops and any text being found after this string (including the separator) will be ignored.

Example:

<param name="aslseparatorstring" value="|">

allowdccchat

set whether dcc chat is allowed.

Default Value:
true
Example:

<param name="allowdccchat" value="false">

allowdccfile

set whether dcc file is allowed.

Default Value:
true
Example:

<param name="allowdccfile" value="false">

linespacing

set the additional space that will be used between two lines of text. Unit is pixel.

Default Value:
Example:

<param name="style:linespacing" value="10">

maximumlinecount

set the maximum line count in the history buffer. This can save memory for very long chats.

Default Value:
1024
Example:

<param name="style:maximumlinecount" value="256">

autorejoin

enables the automatic channel rejoin when kicked out. By default, autorejoin is disabled.

Default Value:
false
Example:

<param name="autorejoin" value="true">

initX

set the Xth initial command to be executed when the applet starts up. This is usefull when several servers need to be automatically joined.

Example:

<param name="init1" value="/newserver Undernet eu.undernet.org">

highlightlinks

highlight links when mouse moves over them. By default, this is not enabled.

Default Value:
false
Example:

<param name="style:highlightlinks" value="true">

disablequeries

disable all queries.

Default Value:
false
Example:

<param name="disablequeries" value="true">