File: README.md

package info (click to toggle)
irssi-plugin-robustirc 0.6-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, sid, stretch
  • size: 256 kB
  • ctags: 229
  • sloc: ansic: 1,347; makefile: 10
file content (100 lines) | stat: -rw-r--r-- 2,221 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
This is an irssi plugin which allows you to connect to a
[RobustIRC](http://robustirc.net/) network without using [a
bridge](https://github.com/robustirc/bridge).

The plugin is very new, hence there will likely be bugs. Please report them so
that we get a chance to fix them.

## Installing

On Debian testing, use:

```
sudo apt-get install irssi-plugin-robustirc
```

## Building from source

To build:
```bash
git clone https://github.com/robustirc/irssi-robustirc.git
mkdir irssi-robustirc/build
cd irssi-robustirc/build
cmake .. && make
sudo make install
```

If you need to specify a custom path to the irssi sources, specify `IRSSI_PATH`:
```bash
cmake -DIRSSI_PATH:PATH=$HOME/irssi ..
```

To build with https://code.google.com/p/address-sanitizer/wiki/AddressSanitizer enabled:
```bash
cmake -DCMAKE_BUILD_TYPE:String="asan" ..
```
to use asan, run `irssi 2>/tmp/asan.log`. When memory errors are found, irssi will terminate and you can examine /tmp/asan.log

## Using

If you just want to load the module and connect as quickly as possible, here is how you do it:
```
/load robustirc
/connect -robustirc robustirc.net
```

### Persistent setup

To load the RobustIRC plugin automatically when starting irssi, use:

```bash
echo 'LOAD robustirc' >> ~/.irssi/startup
```

#### Converting an existing network

In case you were previously connecting to legacy-irc.robustirc.net, or to a bridge, open up `~/.irssi/config` in an editor, find the corresponding network entry in the `chatnets` section and add:

```
type = "robustirc";
```

Then, find the corresponding server entry in the `servers` section and replace the `address` line with the address of the RobustIRC network, e.g.:

```
address = "robustirc.net";
```

#### Configuring a new network

Edit `~/.irssi/config` and add a new network to the `chatnets` section:

```
<network> = { type = "robustirc"; };
```

Then, add a server to the `servers` section:

```
  {
    address = "robustirc.net";
    chatnet = "<network>";
    autoconnect = "yes";
  }
```

Here’s a full example:

```
chatnets = {
  robustirc = { type = "robustirc"; };
};

servers = (
  {
    address = "robustirc.net";
    chatnet = "robustirc";
    autoconnect = "yes";
  }
);
```