Creating a new session

What is session?

Session is ekg2-name for protocol account.

How to enable protocol support

First step is to load plugin, which adds given protocol support. You can find list of such plugins on main wiki page.

plugin +<pluginname>

e.g.:

plugin +jabber

You should then get:

08:43:21 ::: Plugin jabber loaded

If you get:

::: Plugin jabber can not be found

That probably means you didn't have dependencies needed for that plugin. It is also possible that that plugin wasn't enabled for compiling, wasn't installed, was installed with wrong permissions, is linked with unavailable libraries etc.

You can also get:

::: Plugin jabber not initialized correctly, check debug window

and in debug window (selected with alt-backtick) something like:

ABI versions mismatch.  jabber_plugin ABI ver. 4529,  core ABI ver. 4535

That means your plugin is older than EKG2 you are using and you have to update it.

How to add a new session?

If your plugin was loaded correctly, you should now be able to create a new session using it. To do so, enter:

/session --add <PROTO>:<UID>

e.g.:

/session --add xmpp:user@server.tld

Some protos (e.g. irc) doesn't need an explicitly specified <UID> — in that cases you can just specify anything after <PROTO>:.

If you get:

::: Invalid user id

That means either you haven't loaded right plugin, you are using wrong <PROTO> or <UID> part doesn't fulfill requirements.

Basic session tasks

After creating session, you can select it by using:

/session --sw <PROTO>:<UID>

or:

/session --sw <ALIAS>

<ALIAS> is 'simple' name given with session variable 'alias'. You can set session variable using:

/session <PROTO>:<UID> <NAME> <VALUE>

in this case:

/session xmpp:user@server.tld alias jab

If you've already selected session, you can skip <PROTO>:<UID> part. If you specified session alias, you can use always use it instead of <PROTO>:<UID>.

/session alias jab
/session jab othername otherval

To delete session use:

/session -d session_name

Account password

Most protocols supported by EKG2 use password for user user authentication. You can set password using 'password' session variable:

/session password <PASSWORD>

If you're using ncurses UI, you can also use hidden password input by typing:

/session password

Then ncurses will let you input your password without echoing.

Connecting

After your session is set, you can connect to the server by typing:

/connect

Some protocols may require additional session variables (e.g. 'server') to be set before connecting.