1SRAIN(1) Srain SRAIN(1)
2
6 srain - Srain Documentation
7 Modern IRC client written in GTK.
9 [image]
10 Latest version: 2022-10-02 Version 1.5.0.
12 The source code of this site is hosted on GitHub. If you found any
14 mistake, feel free to file issue or pull request.
15 Supporting Srain through OpenCollective.
17
19 All posts… or Feed
20
22 Srain
23 ci-status docs-status channel
24 Modern IRC client written in GTK. [image]
26 Packaging Status
28 pkgstat
29 Features
31 • Fully open source
32 • RFC {1459,2812} compatible
34 • Partial IRCv3 support
36 • Multi-platform support (Linux, Windows, macOS and BSD)
38 • Act like modern IM client
40 • Graphical user interface
42 • Convenient connection panel
44 • Interactive channel search
46 • Forward message in one click
48 • URL preview
50 • Desktop notificaion
52 • Special optimization for bridge/relay bot
54 • Act like geek IRC client
56 • Anything can be done via commands
58 • Fine-grained configuration with hot update support
60 • Regex based message render and filter mechanisms
62 • IPC based plugin system (TODO)
64 Need Help?
66 Frequently Asked Questions may be helpful.
67 Feel free to contact us if you have any question about Srain.
69 • IRC Channel: #srain @ Libera Chat
71 • Github: file an issue Here
73 License
75 GNU General Public License Version 3
76 Quick Start
78 • Start Srain
79 • Connect to IRC server
81 • Predefined Server
83 • Custom Server
85 • Using Command
87 • Join Channel
89 • Directly Join
91 • Search Channel
93 • Using Command
95 NOTE:
97 For your information, the following screenshots are taken under
98 GNOME 3.34.4 with Wayland backed with Arc GTK theme and Breeze icon
99 theme.
100 Start Srain
102 After the Installation of Srain, you will find Srain in your applica‐
103 tions list, if not, just type srain in your shell to run it. Then you
104 will see Srain's initial interface.
105 [image]
106 Connect to IRC server
108 freenode is a famous IRC network, the official channel of Srain #srain
109 is also hosted on it. Let's start by connecting to freenode.
110 Predefined Server
112 Srain has a predefined list of commonly used IRC servers, freenode is
113 one of it. If you want to add server into this list, refer to
114 Configuration Manual.
115 Click the connection button on the Srain header bar, select the page
117 "Quick Mode", select the item "freenode" from candidate box with label
118 "Server", enter your nickname, then click the "Connect" button:
119 [image]
120 If everything goes well, Srain should connected to freenode, then your
122 would see some message from freenode's server:
123 [image]
124 Custom Server
126 While the server your want to connect to is not listed in the prede‐
127 fined list, switch to the page "Advanced Mode", enter the hostname,
128 port, and etc.
129 NOTE:
131 • If the port is a TLS port, make sure that the option "Use secure
133 connection" is checked.
134 • If the server's certificate is untrusted and you insist on contin‐
136 uing, check the option "Do not verify certificate".
137 Then click the "Connect" button:
139 [image]
140 Using Command
142 Refer to /server and /connect.
143 If you want to automatically execute commands at each time Srain
145 starts, please refer to Playground.
146 Join Channel
148 After connecting to freenode, now let's try to join #srain, the offi‐
149 cial channel of Srain.
150 Directly Join
152 While your has a clear channel to join, such as #srain, just click the
153 join button, select the page "Join Channel", enter the channel name in
154 the input entry with label "Channel", then click the "Join" button:
155 [image]
156 Now you should joined the channel:
158 [image]
159 Search Channel
161 While you don't know the exact name of the channel, click the join but‐
162 ton, switch to page "Search Channel", click the button with "refresh"
163 icon, Srain should start receiving channel list from server.
164 Then you can enter the keyword or specify the filter conditions to
166 search channel. For example we enter "#s", select the channel you want
167 to join from channe list, then click "Join" button to join it.
168 [image]
169 NOTE:
171 If the channel requires a join password, try double click the row of
172 channel.
173 Using Command
175 Refer to /join.
176 Installation
178 Srain is available on GNU/Linux, Windows, macOS and BSD.
179 • Dependencies
181 • Building
183 • Play with Meson
185 • Makefile Helper
187 • Distribution Packages
189 • GNU/Linux
191 • Arch Linux
193 • Debian
195 • Fedora
197 • Flatpak
199 • Gentoo
201 • openSUSE
203 • Windows
205 • Pre-built package
207 • Build byself
209 • macOS
211 • BSD
213 • OpenBSD
215 Dependencies
217 ┌───────────────────┬─────────────────────┬──────────┐
218 │Name │ Notes │ Version │
219 ├───────────────────┼─────────────────────┼──────────┤
220 │meson │ Only for Building │ > 0.47.0 │
221 ├───────────────────┼─────────────────────┼──────────┤
222 │make │ Optional, only for │ │
223 │ │ development │ │
224 ├───────────────────┼─────────────────────┼──────────┤
225 │appstream │ Only for building, │ │
226 │ │ on Debian-based │ │
227 │ │ distributions │ │
228 ├───────────────────┼─────────────────────┼──────────┤
229 │coreutils │ Only for building │ │
230 ├───────────────────┼─────────────────────┼──────────┤
231 │gcc │ Only for building │ │
232 ├───────────────────┼─────────────────────┼──────────┤
233 │pkg-config │ Only for building │ │
234 ├───────────────────┼─────────────────────┼──────────┤
235 │gettext │ Only for building │ │
236 ├───────────────────┼─────────────────────┼──────────┤
237 │glib2 │ │ │
238 ├───────────────────┼─────────────────────┼──────────┤
239 │glib-networking │ Optional, for TLS │ │
240 │ │ connection support │ │
241 ├───────────────────┼─────────────────────┼──────────┤
242 │gtk+3 │ │ >= 3.18 │
243 ├───────────────────┼─────────────────────┼──────────┤
244 │libsoup │ │ │
245 ├───────────────────┼─────────────────────┼──────────┤
246 │libconfig │ │ >= 1.5 │
247 ├───────────────────┼─────────────────────┼──────────┤
248 │libsecret │ │ │
249 ├───────────────────┼─────────────────────┼──────────┤
250 │openssl │ │ │
251 ├───────────────────┼─────────────────────┼──────────┤
252 │python-sphinx │ Optional, for │ │
253 │ │ building documenta‐ │ │
254 │ │ tion │ │
255 ├───────────────────┼─────────────────────┼──────────┤
256 │adwaita-icon-theme │ Or other icon │ │
257 │ │ themes │ │
258 └───────────────────┴─────────────────────┴──────────┘
259 Building
261 You should install the aboved Dependencies on your platform before the
262 following steps.
263 Firstly, download source code of srain, you can get source code of lat‐
265 est release:
266 $ wget https://github.com/SrainApp/srain/archive/1.5.0.tar.gz
268 $ tar -xvzf 1.5.0.tar.gz
269 $ cd srain-1.5.0
270 Or get git version:
272 $ git clone https://github.com/SrainApp/srain.git
274 $ cd srain
275 Play with Meson
277 Srain use Meson with ninja backend as its build system. You can build
278 it via the following commands:
279 $ meson setup builddir
281 $ cd builddir
282 $ ninja
283 Install(root privileges required):
285 $ cd builddir
287 # ninja install
288 HTML documentation and manpage are built and installed by default, if
290 you don't need them, just set meson option doc_builders to an empty ar‐
291 ray when setup:
292 $ meson setup -Ddoc_builders=[] builddir
294 Makefile Helper
296 We also provide a simple Makefile helper to simplify meson commands.
297 It is convenient for development.
298 $ make # Build srain
300 $ make build # Same as above
301 $ make install # Install srain to prefix under project root
302 $ make run # Run srain with isolated $HOME and XDG Directory
303 $ make debug # Same as `make run`, but with GDB attached
304 $ make inspect # Same as `make run`, but with GtkInspector
305 $ make clean # Remove all compilation and installation result
306 $ make doc # View installed HTML documentation
307 Distribution Packages
309 GNU/Linux
310 Arch Linux
311 Packages srain and srain-git (git version) are available on AUR, it is
312 quite easy to install using AUR helper(yay as an example):
313 $ yay -S srain
315 $ yay -S srain-git # git version
316 If you are the user of Arch Linux CN Repository, try:
318 # pacman -S archlinuxcn/srain
320 # pacman -S archlinuxcn/srain-git # git version
321 Debian
323 Srain now in offical repository of Debian:
324 # apt install srain
326 Fedora
328 Srain now in offical repository of fedora, use dnf to install it.
329 # dnf install srain
331 Flatpak
333 cpba is maintaining Flatpak manifest for Srain and The built package is
336 available on Flathub, just execute the following commands to install if
337 you already have flatpak installed:
338 $ flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
340 $ flatpak install flathub im.srain.Srain
341 Gentoo
343 Please refers to gentoo portage overlays.
344 openSUSE
346 alois is maintaining openSUSE package for Srain, following this link to
347 install it.
348 Windows
350 Srain requires Windows 7 or later.
351 Pre-built package
353 After 2020-08-10 Version 1.1.2, we provide Windows portable binary that
354 you can get it from Github release page.
355 Build byself
357 If you want to build Srain on Windows youself, you should use the
358 toolchains provided by MSYS2 project.
359 Firstly install MSYS2, then open a MSYS2 shell, install the basic build
361 tools:
362 $ pacman -S base-devel
364 $ pacman -S mingw-w64-i686-toolchain # For 32-bit Windows
365 $ pacman -S mingw-w64-x86_64-toolchain # For 64-bit Windows
366 Then download the package script from MinGW PKGBUILD for Srain, run the
368 following commands at the directory of PKGBUILD:
369 $ MINGW_INSTALLS=mingw32 makepkg-mingw -fsi # For 32-bit Windows
371 $ MINGW_INSTALLS=mingw64 makepkg-mingw -fsi # For 64-bit Windows
372 If everything goes well, Srain is installed under your MinGW prefix.
374 NOTE:
376 If you suffer the "error while loading shared libraries: xxxx.dll:
377 cannot open shared object file: No such file or directory" problem
378 when running, please run it in cmd but not msys2 shell, and it will
379 show you real missing library. [1]
380 [1] https://github.com/Alexpux/MINGW-packages/issues/3939#issuecomment-397988379
382 macOS
384 WARNING:
385 macOS support of Srain is still experimental.
386 There is not a distribution package or package script for Srain on
388 macOS, you should build Srain by yourself.
389 Firstly install Homebrew, run the following commands to install depen‐
391 dencies:
392 $ brew install coreutils gcc pkg-config # building
394 $ brew install gettext glib-networking gtk+3 libsoup libconfig openssl adwaita-icon-theme
395 Next, tell pkg-config where to find the libraries we just installed:
397 export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:"/usr/local/opt/icu4c/lib/pkgconfig"
399 export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:"/usr/local/opt/openssl@3/lib/pkgconfig"
400 Then follow the steps in Building.
402 BSD
404 OpenBSD
405 Please refers to OpenBSD Ports.
406 Commands Manual
408 • Playground
409 • Syntax
411 • Available Commands
413 • /reload
415 • /server
417 • /connect
419 • /ignore & /unignore
421 • /query & /unquery
423 • /join
425 • /part
427 • /quit
429 • /topic
431 • /msg
433 • /me
435 • /nick
437 • /whois
439 • /invite
441 • /kick
443 • /mode
445 • /ctcp
447 • /pattern
449 • /filter & /unfilter
451 • /render & /unrender
453 • /quote
455 • /clear
457 • Obsoleted Commands
459 • /rignore & /unrignore
461 • /relay & /unrelay
463 Playground
465 User can run commands in two ways, the one way is typing them into the
466 input entry of chat buffer.
467 The another way is writing the commands to the server.auto-run and
469 chat.auto-run configuration items. For more details, please refer to
470 Configuration Manual.
471 Syntax
473 A command is a line of string that has the following format, different
474 elements are separated by whitespace:
475 /<name|alias> [subcommand] [<option> [value]]... [argument]...
477 User should use name to invoke a command. The command's name starts
479 with a slash / and doesn't contain any whitespace, such as: /join.
480 Some commands have alias that can be used instead of name, for example,
481 user can use /j instead of /join.
482 NOTE:
484 When you want to send a message starts with a slash, please prepend
485 another slash to the message. For example, you want to send "/this
486 is a slash prefixed message", you need to type "//this is a slash
487 prefixed message".
488 A subcommand is a instruction behind the command name, it is optional.
490 An option, as its name, is optional too, starts with a hyphen - and may
492 has a value.
493 option is often used as the switch of a flag or a way to change some
495 default values. For example, The command /connect -tls -port 6697, op‐
496 tion -tls is just a flag that tells srain use secure connections with
497 TLS. And -port requires a value, if -port is not specified, program
498 will use the default value 6667. Check /connect for more details.
499 If a value starts with a hyphen - or contains whitespaces, it should be
501 enclosed by single quotation mark '.
502 NOTE:
504 All option should appear behind subcommand (If any), and before ar‐
505 gument.
506 An argument is similar to value, but commonly it doesn't have a default
508 value so it can not be omitted (actually it depends on the implement of
509 the command). If the first argument starts with a hyphen -, it should
510 be enclosed by single quotation mark '. If an argument contains white‐
511 spaces, it should be quoted too. Specially, the last argument can con‐
512 tain whitespace without quoted.
513 If you want to use a single quotation mark in a quoted text, use back‐
515 slash \ to escape it. For backslash itself, use double backslash \\.
516 Available Commands
518 /reload
519 Usage:
520 /reload
522 Reload user configuration.
524 /server
526 Usage:
527 /server [connect|disconnect|list] <name>
529 Predefined IRC server management.
531 Sub commands:
533 • connect: connect to specified predefined server
535 • disconnect: disconnect from specified predefined server
537 • list: list all predefined servers
539 Arguments:
541 • name: unique name of server
543 /connect
545 Usage:
546 /connect [-port <port>] [-pwd <password>] [-tls] [-tls-noverify]
548 [-user <username>] [-real <realname>] <host> <nick>
549 Create a IRC server and connect to it immediately.
551 Options:
553 • -port: server port, default 6667
555 • -pwd: connection password, default empty
557 • -tls: use secure connections with TLS
559 • -tls-noverify: use TLS connection without certificate verification
561 • -user: specify username, default same as nickname
563 • -real: specify realname, default same as nickname
565 Arguments:
567 • host: server host
569 • nick: specify nickname
571 Example:
573 /connect -real 'I am srainbot' -tls -port 6697 chat.freenode.org srainbot
575 /connect 127.0.0.1 srainbot
576 /ignore & /unignore
578 Usage:
579 /ignore [-cur] <nick>
581 /unignore [-cur] <nick>
582 Ignore/unignore somebody's message.
584 Options:
586 • -cur: only ignore in current chat
588 /query & /unquery
590 Usage:
591 /query|q <nick>
593 /unquery [nick]
594 Start/stop private chat with somebody. For /unquery , If no nick is
596 specified, it stops the current private chat.
597 /join
599 Usage:
600 /join|j <channel>[,<channel>]... [<passwd>[,<passwd>]]...
602 Join specified channel(s), channels are separated by commas ,.
604 Example:
606 /join #archinux-cn,#gzlug,#linuxba
608 /join #channel1,#channe2 passwd1
609 /part
611 Usage:
612 /part|leave [<channel>[,<channel>]]... [<reason>]
614 Leave specified channel(s) with optional reason, channels are separated
616 by commas ,. If no channel is specified, it leaves the current channel.
617 Example:
619 /part #archinux-cn Zzz...
621 /part #archlinux-cn,#tuna
622 /part
623 /quit
625 Usage:
626 /quit [reason]
628 Quit current server with optional reason.
630 /topic
632 Usage:
633 /topic [-rm|<topic>]
635 Set the current channel's topic. If no topic specified, it just dis‐
637 plays the current channel's topic.
638 • -rm: remove current channel's topic
640 Example:
642 # Just view the topic
644 /topic
645 # Set the topic to "Welcome to Srain!"
646 /topic Welcome to Srain!
647 # Clear the topic
648 /topic -rm
649 /msg
651 Usage:
652 /msg|m <target> <message>
654 Send message to a target, the target can be channel or somebody's nick.
656 If you want to send a message to channel, you should /join it first.
657 /me
659 Usage:
660 /me <message>
662 Send an action message to the current target.
664 /nick
666 Usage:
667 /nick <new_nick>
669 Change your nickname.
671 /whois
673 Usage:
674 /whois <nick>
676 Get somebody's information on the server.
678 /invite
680 Usage:
681 /invite <nick> [channel]
683 Invite somebody to join a channel. If no channel is specified, it falls
685 back to current channel.
686 /kick
688 Usage:
689 /kick <nick> [channel] [reason]
691 Kick somebody from a channel, with optional reason. If no channel is
693 specified, it falls back to current channel.
694 /mode
696 Usage:
697 /mode <target> <mode>
699 Change target 's mode.
701 /ctcp
703 Usage:
704 /ctcp <target> <command> [message]
706 Send a CTCP request to target. The commonly used commands are: CLI‐
708 ENTINFO, FINGER, PING, SOURCE, TIME, VERSION, USERINFO. For the detail
709 of each command, please refer to https://modern.ircdocs.horse/ctcp.html
710 .
711 If you send a CTCP PING request without message, you will get the la‐
713 tency between the target.
714 NOTE:
716 DCC is not yet supported.
717 /pattern
719 Usage:
720 /pattern add <name> <pattern>
722 /pattern rm <name>
723 /pattern list
724 Regular expression pattern management. The added pattern can be used
726 elsewhere in the application, such as /filter & /unfilter and /render &
727 /unrender.
728 Sub commands:
730 • add: add a pattern with given name
732 • rm: remove a pattern with given name
734 • list: list all availables patterns
736 Arguments:
738 • name: unique name of pattern
740 • pattern: a valid Perl-compatible Regular Expression
742 /filter & /unfilter
744 Usage:
745 /filter [-cur] <pattern>
747 /unfilter [-cur] <pattern>
748 Filter message whose content matches specified pattern.
750 Options:
752 • -cur: only ignore in current chat
754 Arguments:
756 • pattern: name of regular expression pattern which is managed by
758 /pattern
759 Example:
761 This filter message that content is "Why GTK and not Qt?":
763 /pattern add troll ^Why GTK and not Qt\?$
765 /filter troll
766 To cancel the filter of these kind of message, use:
768 /unfilter troll
770 NOTE:
772 Pattern NO NEED to consider the case where the mIRC color code is
773 included in the message.
774 /render & /unrender
776 Usage:
777 /render [-cur] <nick> <pattern>
779 /unrender [-cur] <nick> <pattern>
780 Render message of specific user via specific pattern.
782 The given pattern should contains specific Named Subpatterns used for
784 capturing message fragment from original message content and become
785 part of rendered message.
786 There are list of available named subpatterns:
788 • (?<sender>): match name of sender, once this subpatterns is matched,
790 the original sender will be displayed as message remark
791 • (?<content>): match content of rendered message
793 • (?<time>): match time of rendered message
795 Arguments:
797 • nick: nickname of user
799 • pattern: name of regular expression pattern which is managed by
801 /pattern
802 Options:
804 • -cur: only effects the user under current chat
806 Example:
808 We assume that there is a IRC bot named "xmppbot". It forwards message
810 between XMPP and IRC. On IRC side, the forwarded message looks like
811 "<xmppbot> [xmpp_user] xmpp_message", you can render it to a more
812 easy-to-read format via the following commands:
813 /pattern add xmpp \[(?<sender>[^:]+?)\] (?<content>.*)
815 /render xmppbot xmpp
816 The forwarded meessage will look like "<xmpp_user> xmpp_message", and
818 the original message sender "xmppbot" will be displayed as message re‐
819 mark. Please refer to What is "relay message transform"? see its ef‐
820 fect.
821 NOTE:
823 Pattern SHOULD consider the case where the mIRC color code is in‐
824 cluded in the message.
825 /quote
827 Usage:
828 /quote <raw message>
830 For sending special IRC commands.
832 New in version 1.2.0.
834 /clear
837 Usage:
838 /clear
840 Clear all messages in current buffer.
842 New in version 1.4.
844 Obsoleted Commands
847 /rignore & /unrignore
848 This command has been dropped since 2019-06-14 Version 1.0.0rc5, please
849 use /filter & /unfilter instead.
850 /relay & /unrelay
852 This command has been dropped since 2019-06-14 Version 1.0.0rc5, please
853 use /render & /unrender instead.
854 Configuration Manual
856 Srain uses Libconfig to process configuration file.
857 • Configuration File
859 • Syntax
861 • Priority and Fallback
863 • All Configurable Items
865 Configuration File
867 The path of system wide configuration file builtin.cfg depends on the
868 compile flag --sysconfdir, default to be /etc/srain.
869 The path of user wide configuration file srain.cfg is $XDG_CON‐
871 FIG_HOME/srain, usually it is ~/.config/srain
872 (~/.var/app/im.srain.Srain for flatpak installs).
873 The difference between system wide and user wide configuration file is
875 the priority, The user wide configuration always overwrite the one in
876 system wide configuration. For more details about priority, refer to
877 Priority and Fallback.
878 Syntax
880 For the syntax of configuration file, please refer to Libconfig's docu‐
881 mentation: Configuration Files
882 For an example configuration, refer to All Configurable Items.
884 Priority and Fallback
886 A group is a collection of configurations. The same group in different
887 place have different priority.
888 server: { # A top level ``server`` group
890 # ...
892 user = {}
894 default-messages = {}
895 irc = {}
896 chat = { } # A ``chat`` group directly in ``server``
897 chat-list = (
899 { }, # A ``chat`` group in ``chat-list``
900 # ...
901 )
902 }
903 server-list: (
905 { }, # A ``server`` group in ``server-list``
906 # ...
907 )
908 For example, A server group contains the information(not all) of con‐
910 nection to IRC servers. server group can appear at the top level of
911 configuration file, or be an element of server-list list with a unique
912 name. The top level server is often used to specify the global configu‐
913 ration, and server-list is used to specify specified IRC servers.
914 The configuration in server-list can overwrite the top level server,
916 and if an option is not specified in server-list, It will fallback to
917 server.
918 Another similar group is chat, chat contains configuration of chat
920 panel, such as whether to show topic, whether to save chat log and etc.
921 Every server group can contain a chat group and a chat-list list. Ele‐
922 ments in chat-list are also identified with an unique name.
923 As same as the relationship between top level server and server-list,
925 chat-list is used to specify a specified chat and has higher priority.
926 As mentioned above, The priority of user configuration is always higher
928 than system's, so we can get the priority sorting of server and chat
929 group:
930 server-list(user) >
932 top level server(user) >
933 server-list(system) >
934 top level server(system)
935 chat-list in server-list(user) >
937 chat in server-list(user) >
938 chat-list in top level server(user) >
939 chat in top level server(user) >
940 chat-list in server-list(system) >
941 chat in server-list(system) >
942 chat-list in top level server(system) >
943 chat in top level server(system)
944 All Configurable Items
946 Here is the default system wide configuration file used by Srain, all
947 configurable items are already listed here. you can make a copy as your
948 user configuration file, but note:
949 1. User configuration always overwrite system's, if you don't know what
951 does this option means, please remove it from your user configura‐
952 tion rather than overwrite it
953 2. The server's name in server-list is unique, please remoeve the du‐
955 plicated server in server-list before using
956 # Srain built-in configuration file
958 # Application configuration.
959 version = "1.0.0rc5" # String; Every configuration file should have a
961 # version, altough it is not used yet
962 # id = "im.srain.Srain" # The identifier for Srain
963 theme = "default-bubble" # String; Theme; Available values: default
964 csd = true # Bool; Whether enable Client-Side Decoration
965 send-on-ctrl-enter = false # Bool; Send messsage on CTRL+Enter pressed
966 exit-on-close = false # Bool; Exit program on main window closed
967 auto-connect = [] # String array; Servers that are auto connected
968 # after startup
969 server-visibility = true # Bool; Whether the server buffer is visible
970 # If you want to report/fix a bug, terminal log will be helpful.
972 log =
973 {
974 prompt-color = true # Bool; Colorful output
975 prompt-file = false # Bool; Display the filename of the file which log
976 # statement is located
977 prompt-function = true # Bool; As aboved, function name
978 prompt-line = false # Bool; As aboved, line number
979 # String array; Specify the log level of a group of files
981 debug-targets = [] # Files with debug log level
982 info-targets = [] # Files with information log level
983 warn-targets = [""] # Files with warning log level
984 error-targets = [] # Files with error" log level
985 }
986 # Global IRC Server configuration, this group can also appear in server-list.
988 server =
989 {
990 auto-join = [] # String array; Chats that are auto joined after server
991 # is created
992 auto-run = [] # String array; Commands that are auto run after server
993 # is created
994 user =
996 {
997 nickname = "SrainUser"
998 username = "Srain"
999 realname = "Can you can a can?"
1000 login:
1002 {
1003 method = "none" # String; Login method; Available values:
1004 # - none: No login method, default value
1005 # - nickserv: Login with NICKSERV command
1006 # - msg-nickserv: Login with /msg NickServ identify
1007 # - sasl-plain: Login with SASL PLAIN mechanism
1008 # - sasl-ecdsa: Login with SASL
1009 # ECDSA-NIST256P-CHALLENGE mechanism
1010 # - sasl-external: Login with SASL EXTERNAL mechanism
1011 # (requires a TLS certificate set in the **server**
1012 # section, not the one just below)
1013 # For method "sasl-ecdsa"
1015 # certificate = "" # String; Path to login ECDSA certificate file, used for
1016 # sasl-ecdsa authentication (**not** sasl-external)
1017 }
1018 # Default messages for performing specified action
1020 part-message = "Leaving."
1021 kick-message = "Kick."
1022 away-message = "Away from keyboard."
1023 quit-message = "El Psy Congroo."
1024 }
1025 # Chat configuration, this group can also appear in chat-list.
1027 chat =
1028 {
1029 log = true # Bool; Persistent chat log to storage
1030 notify = true # Bool; Send notification when you are
1031 # mentioned by others or receiving any
1032 # ERROR message
1033 notify-all = true # Bool; Send notification when receiving
1034 # any PRIVMSG/ACTION/NOTIFY/ERROR message
1035 show-topic = true # Bool; Show topic
1036 show-avatar = false # Bool; Show user avater
1037 show-user-list = true # Bool; Show user list
1038 render-mirc-color = true # Bool; Render mirc color
1039 nick-completion-suffix = ":" # String; Suffix of completed nick name
1040 # e.g. "nick: msg"
1041 preview-url = true # Bool; Show previewer for every URL
1043 auto-preview-url = true # Bool; Automatically preview supported URL
1044 auto-run = [] # String array; Commands that are auto run after
1046 # chat is created
1047 }
1048 # Specified chat configuration, every element in list should have a unique
1050 # ``name``.
1051 chat-list =
1052 (
1053 {
1054 # ``name`` is necessary for a ``chat`` group in ``chat-list``.
1055 name = "#srain"
1056 show-topic = true
1057 }
1058 )
1059 }
1060 # Specified server configuration, every element in list should have a unique
1062 # "name".
1063 server-list =
1064 (
1065 {
1066 # ``name``, ``addresses`` are necessary for a ``server`` group
1067 # in ``server-list``, otherwise you can not connect to it.
1068 name = "Libera Chat" # String; The unique name of server
1069 addresses = [
1070 "irc.libera.chat:6697"
1071 ] # String array; Addresses of IRC server,
1072 # each address follows the format of
1073 # <host>[:<port>]. The port can be omitted,
1074 # default 6667 for non-TLS and 6697 for TLS
1075 tls = true # Bool; Connect with TLS encryption
1076 # tls-noverify = false # Bool; Connect with TLS encryption but without
1077 # certificate verification, only used while
1078 # connecting to a self-signed certificate
1079 # verified server
1080 encoding = "utf-8" # String; Encoding of IRC server, to get
1081 # all available value of encoding, check the
1082 # output of ``iconv --list``
1083 # ipv6 = false # Use IPv6 connection, not yet supported
1084 # certificate = "/home/you/.config/srain/libera.pem"
1085 # Client TLS certificate, that can be used for
1086 # authentication with CertFP or SASL EXTERNAL (if
1087 # ``method = "sasl-external"`` is set in the
1088 # ``user`` configuration)
1089 },
1090 {
1091 name = "GIMPNet"
1092 addresses = ["irc.gimp.org:6697", "irc.gnome.org:6697"]
1093 tls = true
1094 encoding = "utf-8"
1095 },
1096 {
1097 name = "OFTC"
1098 addresses = ["irc.oftc.net:6697"]
1099 tls = true
1100 encoding = "utf-8"
1101 },
1102 {
1103 name = "hackint"
1104 addresses = ["irc.hackint.org:6697"]
1105 tls = true
1106 encoding = "utf-8"
1107 },
1108 {
1109 name = "Rizon"
1110 addresses = ["irc.rizon.net:6697"]
1111 tls = true
1113 encoding = "utf-8"
1114 },
1115 {
1116 name = "DALnet"
1117 addresses = [
1118 "irc.dal.net:6697",
1119 "agility.nl.eu.dal.net:6697",
1120 "bifrost.ca.us.dal.net:6697",
1121 "bitcoin.uk.eu.dal.net:6697",
1122 "choopa.nj.us.dal.net:6697",
1123 "diamond.hub.dal.net:6697",
1124 "fidelity.tx.us.dal.net:6697",
1125 "foxtrot.hub.dal.net:6697",
1126 "halcyon.il.us.dal.net:6697",
1127 "hash.ix.nl.dal.net:6697",
1128 "hoon.ix.au.dal.net:6697",
1129 "istana.ix.sg.dal.net:6697",
1130 "jingo.ix.us.dal.net:6697",
1131 "karsk.ix.eu.dal.net:6697",
1132 "kiwi.ix.nz.dal.net:6697",
1133 "koala.vc.au.dal.net:6697",
1134 "laud.ix.us.dal.net:6697",
1135 "loyalty.ix.us.dal.net:6697",
1136 "merlin.hub.dal.net:6697",
1137 "midnight.hub.dal.net:6697",
1138 "ninja.hub.dal.net:6697",
1139 "nonstop.ix.me.dal.net:6697",
1140 "oi.ix.au.dal.net:6697",
1141 "oper-e.dal.net:6697",
1142 "paradigm.hub.dal.net:6697",
1143 "powertech.no.eu.dal.net:6697",
1144 "punch.wa.us.dal.net:6697",
1145 "rangers.ix.us.dal.net:6697",
1146 "redemption.ix.us.dal.net:6697",
1147 "renew.hub.dal.net:6697",
1148 "smurf.hub.dal.net:6697",
1149 "underworld.se.eu.dal.net:6697",
1150 "uworld.hub.dal.net:6697"
1151 ]
1152 tls = true
1153 encoding = "utf-8"
1154 },
1155 {
1156 name = "EFnet"
1157 addresses = [
1158 "irc.efnet.fr:6667",
1159 "efnet.port80.se:6697",
1160 "efnet.portlane.se:6667",
1161 "irc.du.se:6667",
1162 "irc.homelien.no:6667",
1163 "irc.inet.tele.dk:6667",
1164 "irc.nordunet.se:6667",
1165 "irc.underworld.no:6667",
1166 "irc.choopa.net:6697",
1167 "irc.colosolutions.net:6667",
1168 "irc.mzima.net:6667",
1169 "irc.prison.netirc.servercentral.net:6667"
1170 ]
1171 tls = false
1172 encoding = "utf-8"
1173 },
1174 {
1175 name = "IRCnet"
1176 addresses = [
1177 "irc.ssl.ircnet.com:6697",
1178 "irc.ircnet.com:6667",
1179 "irc.at.ircnet.com:6667",
1180 "irc.be.ircnet.com:6667",
1181 "irc.cz.ircnet.com:6667",
1182 "irc.dk.ircnet.com:6667",
1183 "irc.ee.ircnet.com:6667",
1184 "irc.fi.ircnet.com:6667",
1185 "irc.fr.ircnet.com:6667",
1186 "irc.de.ircnet.com:6667",
1187 "irc.hu.ircnet.com:6667",
1188 "irc.it.ircnet.com:6667",
1189 "irc.jp.ircnet.com:6667",
1190 "irc.nl.ircnet.com:6667",
1191 "irc.no.ircnet.com:6667",
1192 "irc.pl.ircnet.com:6667",
1193 "irc.si.ircnet.com:6667",
1194 "irc.se.ircnet.com:6667",
1195 "irc.us.ircnet.com:6667"
1196 ]
1197 tls = false
1198 encoding = "utf-8"
1199 },
1200 {
1201 name = "Undernet"
1202 addresses = [
1203 "irc.undernet.org:6667",
1204 "ix1.undernet.org:6667",
1205 "ix2.undernet.org:6667",
1206 "ashburn.va.us.undernet.org:6667",
1207 "bucharest.ro.eu.undernet.org:6667",
1208 "budapest.hu.eu.undernet.org:6667",
1209 "chicago.il.us.undernet.org:6667"
1210 ]
1211 tls = false
1212 encoding = "utf-8"
1213 },
1214 {
1215 name = "QuakeNet"
1216 addresses = [
1217 "irc.quakenet.org:6667",
1218 "dreamhack.se.quakenet.org:6667",
1219 "euroserv.fr.quakenet.org:6667",
1220 "irc.ipv6.quakenet.org:6667",
1221 "port80a.se.quakenet.org:6667",
1222 "port80b.se.quakenet.org:6667",
1223 "port80c.se.quakenet.org:6667",
1224 "portlane.se.quakenet.org:6667",
1225 "servercentral.il.us.quakenet.org:6667",
1226 "underworld1.no.quakenet.org:6667"
1227 ]
1228 tls = false
1229 encoding = "utf-8"
1230 },
1231 {
1232 name = "freenode"
1233 addresses = [
1234 "irc.freenode.net:6697",
1235 "chat.freenode.net:6697",
1236 "irc.freenode.org:6697",
1237 "chat.freenode.org:6697"
1238 ]
1239 tls = true
1240 encoding = "utf-8"
1241 },
1242 {
1243 name = "localhost"
1244 addresses = ["localhost:6667", "127.0.0.1:6667"]
1245 tls = false
1246 }
1247 # TODO: More predefined servers
1249 )
1250 Development Specification
1253 int bus_count = 1;
1254 Codeing Style
1256 • Public header 用 __XXX_H 形式
1257 • 提倡在作用域开头统一声明变量，而不是即用即声明，方便释放的时候统一处理
1259 • 缩进：四空格，无 Tab
1261 • 折行：
1263 • 头文件中的函数签名可以不折行，其他地方的代码一律小于 80 char per
1265 line
1266 • 参数过长时，从超过长度的第一个参数开始折行，参数无需对齐
1268 • 太长的字符串可以不折行
1270 • gtk_widget_class_bind_template_child() 由于实在太长，可以不折行
1272 • 花括号不换行（除非在 case
1274 中），右圆括号和左花括号之间没有空格（待定）
1275 • 命名：
1277 • 鼓励局部变量和函数参数使用缩写，全局变量及函数名，类型名不鼓励缩写
1279 • 宏大写，数据类型，类名用大驼峰法，变量使用全小写 + 下划线
1281 • 文件名全小写，以下划线分隔
1283 • 注释：
1285 • 按英文规范，句首第一个单词首字符大写，多句时使用标点符号，同样每行不得超过
1287 80 字符（汉字以两字符计），链接可以不折行
1288 • Git commit log: 格式为 MODULE(TYPE): DESCRIPTION
1290 ，当前可用的模块(MODULE) 有： All Core Sirc Sui Prefs Filter Decora‐
1291 tor Lib I18n Data Plugin Build Script Doc... ，可用的提交类型(TYPE)
1292 有： feat impl change fix improve cleanup refactor update release
1293 misc...
1294 • I18N：所有需要在界面上展示的格式化字符串中的控制字符均使用 numbered
1296 argument， 即 %n$X 形式
1297 • Change log: 应分为四类
1299 • Changed: 设计或功能上的改动，可能会带来兼容问题的一定要说明
1301 • Added: 新增的功能或者依赖
1303 • Removed: 移除的功能或者依赖
1305 • Imporved: 性能或功能或易用性上的改善以及 bug 修复
1307 • 发布前须知
1309 • 集成测试 (TODO)
1311 • 更新翻译
1313 • 更新文档
1315 • 更新 change log
1317 • 更新项目中的版本号
1319 • 确认文档中的提供的安装脚本可用
1321 • 对最新的 commit 打 tag
1323 • 通知各个发行版的打包维护者
1325 • Arch Linux: @SilverRainZ
1327 • Gentoo: @xeirrr
1329 • ...
1331 Miscellaneous
1333 Hot Keys
1334 • ctrl + j/k: switch chat panel
1335 • up/down: scroll message list
1337 NOTE:
1339 Customized hot keys will be supported in the future.
1340 Chat Logs
1342 Chat logs is enabled by default, log files are located at
1343 $XDG_DATA_HOME/srain/logs, usually it is ~/.local/share/srain/logs.
1344 Insert Emojis
1346 Click the emoji button or use shortcuts Ctrl+. or Ctrl+;.
1347 [image] Emoji button.UNINDENT
1348 New in version 1.3.
1350 Frequently Asked Questions
1353 Frequently asked questions are listed here, you can visit issue page to
1354 see more questions that asked by our users.
1355 • Does Srain support Windows?
1357 • What is "relay message transform"?
1359 • Where are the log files?
1361 • How can I send message which has a slash("/") prefixed?
1363 • How can I remove my stored password?
1365 • How can I hide JOIN/PART messages of channel?
1367 • Why can't I login to my ZNC server?
1369 Does Srain support Windows?
1371 Yes, please refer to Windows.
1372 What is "relay message transform"?
1374 There are many relay bots forward messages from other IM to IRC net‐
1375 work, "Relay message transform" make these messages easier to read.
1376 For example, there is a telegram bot named "telegram", the words in
1378 brackets is the named of the telegram user.
1379 [image]
1380 Run command /pattern add normal-relay \[(?<sender>[^:]+?)\] (?<con‐
1382 tent>.*) and /render telegram normal-relay, you get:
1383 [image]
1384 For more details, please refer to commands-pattern and commands-render.
1386 Where are the log files?
1388 Refer to Chat Logs.
1389 How can I send message which has a slash("/") prefixed?
1391 Please prepend another slash to the message.
1392 Refer to Syntax.
1394 How can I remove my stored password?
1396 Just leave the password entry empty and check the "Remember password"
1397 checkbox before connect to server or join channel, the corresponding
1398 password will be removed.
1399 Or you can use secret-tool (provided by libsecret) to manage all your
1401 stored passwords.
1402 How can I hide JOIN/PART messages of channel?
1404 So far, Srain has not yet a specialized option for hiding such mes‐
1405 sages. You can use write regular expression to filter them:
1406 /pattern add filter-join ^\w+ has joined$
1408 /filter filter-join
1409 /pattern add filter-part ^\w+ has left: .*$
1410 /filter filter-part
1411 NOTE:
1413 The content of regular expression depends on your language.
1414 Why can't I login to my ZNC server?
1416 According ZNC's FAQ, way 2, supply your "user@phone/network:pass"
1417 (without quotes) in the server password field. Other as usual.
1418 NOTE:
1420 Way 1 in ZNC's FAQ requires username field can be set via connection
1421 panel, which will be supported by Srain in the future.
1422 Change Log
1424 • 2022-10-02 Version 1.5.0
1425 • 2022-10-02 Version 1.4.2
1427 • 2022-10-02 Version 1.3.3
1429 • 2022-07-30 Version 1.4.1
1431 • 2022-05-07 Version 1.4.0
1433 • 2022-02-10 Version 1.3.2
1435 • 2021-12-18 Version 1.3.1
1437 • 2021-12-18 Version 1.2.5
1439 • 2021-09-23 Version 1.3.0
1441 • 2021-07-18 Version 1.2.4
1443 • 2021-06-26 Version 1.2.3
1445 • 2021-05-30 Version 1.2.2
1447 • 2021-04-02 Version 1.2.1
1449 • 2021-02-28 Version 1.2.0
1451 • 2020-10-01 Version 1.1.3
1453 • 2020-08-10 Version 1.1.2
1455 • 2020-06-27 Version 1.1.1
1457 • 2020-05-24 Version 1.1.0
1459 • 2020-04-11 Version 1.0.2
1461 • 2020-03-14 Version 1.0.1
1463 • 2020-02-24 Version 1.0.0
1465 • 2019-10-07 Version 1.0.0rc9999
1467 • 2019-06-14 Version 1.0.0rc5
1469 • 2019-05-13 Version 1.0.0rc4
1471 • 2019-04-14 Version 1.0.0rc3
1473 • 2019-01-24 Version 1.0.0rc2
1475 • 2018-09-10 Version 1.0.0rc1
1477 • 2018-02-28 Version 0.06.4
1479 • 2017-12-22 Version 0.06.3
1481 • 2017-09-12 Version 0.06.2
1483 • 2017-08-18 Version 0.06.1
1485 • 2017-07-29 Version 0.06
1487 • 2016-09-19 Version 0.05.1
1489 • 2016-08-27 Version 0.05
1491 • 2016-04-30 Version 0.03
1493 • 2016-04-13 Version 0.02
1495 • 2016-04-07 Version 0.01
1497 2022-10-02 Version 1.5.0
1499 • Features:
1500 • Able to identify Nordic GTK Theme as dark theme (#372)
1502 • Activate the corresponding buffer to a response user query (#381)
1504 • Changes:
1506 • No additional sphinx extensions are required to build documentation
1508 (#368)
1509 • Cleanup deprecated APIs (#369)
1511 • Suppress error message when connection keeps failing (#386)
1513 • Enable debian release build , thanks to @tomac4t (#387)
1515 • Bug fixes:
1517 • Fix SASL authentication error when connecting to Soju (#371)
1519 2022-10-02 Version 1.4.2
1521 • Backport #371
1522 2022-10-02 Version 1.3.3
1524 • Backport domain name change, see 2022-05-07 Version 1.4.0
1525 • Backport #371
1527 2022-07-30 Version 1.4.1
1529 • Changes:
1530 • New website, move domain name from srain.im to srain.silver‐
1532 rainz.me, see Migrate domain name to srain.silverrainz.me
1533 • Require mesion >= 0.47.0
1535 2022-05-07 Version 1.4.0
1537 • Features:
1538 • Add support for IRCv3 standard-replies (#354), by @progval
1540 • Add support for SASL EXTERNAL (#352), by @progval
1542 • Add support for invite-notify (#359), by @progval
1544 • Add conf item server-visibility for setting default server visib‐
1546 lity (#361), by @SilverRainZ
1547 • Add support for server-time (#345), by @progval
1549 • Add /clear command for clearing messages of current buffer (#268),
1551 by @SilverRainZ
1552 • Bug fixes:
1554 • Fix workflow for building MS Windows release artifact (#360), by
1556 @lifeibiren
1557 • Changes:
1559 • Make the buffer menu apply to the right-clicked item instead of the
1561 active buffer (#353), by progval
1562 • Srain now accepting donations through OpenCollective (‐
1564 https://opencollective.com/srain)
1565 • Disable workflow for building debian release artifact since we have
1567 offical debian package (99d9d86)
1568 2022-02-10 Version 1.3.2
1570 • Features:
1571 • Add French translation (#351), by @progval
1573 • Bug fixes:
1575 • Silence assertion failure on /part command (#348), by @progval
1577 • Silence "Unknown capability" warning on trailing whitespace (#349),
1579 by @progval
1580 • Changes:
1582 • Add tooltips to buttons with no text(#350), by @progval
1584 • Srain is added to offical repository of Debian, see Debian for de‐
1586 tails
1587 2021-12-18 Version 1.3.1
1589 • Bug fixes:
1590 • Fix build of macOS (#339), by @SilverRainZ
1592 • Make channel messages with origin out of channels can be shown (‐
1594 #336), by @progval
1595 • Rejoin channels after NICKSERV authentication finishes (#274), by
1597 @SilverRainZ
1598 2021-12-18 Version 1.2.5
1600 • Bug fixes:
1601 • Backport #336, #274
1603 2021-09-23 Version 1.3.0
1605 • Features:
1606 • Implement ISUPPORT parsing + the UTF8ONLY IRCv3 specification (‐
1608 #331), thanks to @progval
1609 • Add support for RPL_UMODEIS (#331), thanks to @progval
1611 • Make nick completion case-insensitive (#333), thanks to @progval
1613 • Add button for inserting emoji (#279)
1615 • Bug fixes:
1617 • Fix configuration syntax errors caused by trailing commas (#330),
1619 thanks to @progval
1620 2021-07-18 Version 1.2.4
1622 • Bug fixes:
1623 • Fix bug casued by #316 (#319)
1625 • Fix crach when URL preview async task failed (#322)
1627 2021-06-26 Version 1.2.3
1629 • Bug fixes:
1630 • Eliminate GDK warning (#316)
1632 2021-05-30 Version 1.2.2
1634 • Changed:
1635 • Add libera.chat IRC network (#311)
1637 • Updated Dutch translation (b6830e9)
1639 • Bug fixes:
1641 • Fix windows build (#300, #303)
1643 2021-04-02 Version 1.2.1
1645 • Features:
1646 • Add Ukrainian translations (#292), thanks to @andmizyk
1648 • Bug fixes:
1650 • Minor fixes (#290)
1652 2021-02-28 Version 1.2.0
1654 • Features:
1655 • Switch build system from Make to Meson (#266)
1657 • Add FreeBSD implementations for srn_get_executable_{path,dir},
1659 thanks to @wahjava
1660 • Add /quote command for sending special IRC commands, thanks to @hno
1662 (#283)
1663 • Add support for hiding server buffer (#287)
1665 • Bug fixes:
1667 • Fix an use-after-free BUG (#267)
1669 • Fix implicit declaration error on some systems, thanks to
1671 @lgbaldoni (#270)
1672 2020-10-01 Version 1.1.3
1674 • Bug fixes:
1675 • Fix an use-after-free BUG (#267)
1677 2020-08-10 Version 1.1.2
1679 NOTE:
1680 This release contains only improvement for MS Windows, user of other
1681 platform can ignore it.
1682 • Features:
1684 • Binary for MS Windows now can automatically built via Github Ac‐
1686 tions, thanks to @lifeibiren (#259), please refer to Windows for
1687 more details
1688 • Changes:
1690 • For ease of running on windows, Srain's executable path is added to
1692 the search paths of {configuration,data} file. Thanks to
1693 @lifeibiren (#259)
1694 2020-06-27 Version 1.1.1
1696 • Changes:
1697 • Improve auto-scroll policy of message list (#255)
1699 • Bug fixes:
1701 • Fix TLS certificate verification error on glib-networking 2.64.3 (‐
1703 #251)
1704 • Fix crash when connecting to an invalid host (#234)
1706 2020-05-24 Version 1.1.0
1708 • Features:
1709 • Support multiple selection of message (#138)
1711 • Support jump to mentioned message (#243)
1713 • Nickname will be highlighted when mentioned (#243)
1715 • Auto build deb package (#238)
1717 • Changes:
1719 • Improve fcous control of UI
1721 • Replace appdata with metainfo (#240)
1723 • Validate metainfo with appstream-util (#242)
1725 • Bug fixes:
1727 • Some implicit declarations fixes (#236)
1729 • Some typo fixes (#239)
1731 2020-04-11 Version 1.0.2
1733 • Features:
1734 • Add MAN documentation (deaf723)
1736 • Add more predefined IRC networks: DALnet, EFnet, IRCnet, Undernet
1738 and QuakeNet (#228)
1739 • Changes:
1741 • Build: Allow setting CC variable via environment (#224)
1743 • Add channel related messages to corresponding buffer as possible (‐
1745 #149)
1746 • Improve widget focus control (#229)
1748 • Drop unused icons (6239fe5)
1750 • Provide clearer error message when connecting (#233)
1752 • Update gentoo installation documentation Gentoo (ceb5ca3)
1754 • Bug fixes:
1756 • Truncate long message before sendisg (#227)
1758 • Deal with invalid UTF-8 string (50e7757)
1760 • Fix incorrect user number of channel user list (#230)
1762 • Fix incorrect icon install path (9f07380)
1764 2020-03-14 Version 1.0.1
1766 • Features:
1767 • Auto rename to original nick when ghost quit (#198)
1769 • Add hackint IRC network (#201), thanks to @kpcyrd
1771 • Add Dutch translation (#215), thanks to @Vistaus
1773 • Add two FAQs to documentation (#217)
1775 • Add debian pack script (contrib#1), thanks to @tomac4t. Please re‐
1777 fer to Debian to build a deb package
1778 • Changes:
1780 • Move continuous integration from travis CI to github actions (#203,
1782 #204), thanks to @tomac4t
1783 • Make header bar buttons repect default belief (#205, #218)
1785 • Bug fixes:
1787 • Fix case sensitivity issue for IRC messages (#202), thanks to
1789 @hhirtz
1790 • Fix invalid changelog section of appdata file (#214)
1792 • Fix missing dependences in documentation (#216), thanks to @avoidr
1794 2020-02-24 Version 1.0.0
1796 • Changes:
1797 • Some code cleanup
1799 • Update Quick Start documentation
1801 • Bug fixes:
1803 • Allow Srain runs without dbus secrets service (#195)
1805 • Fix nick generation logical (39ced08)
1807 NOTE:
1809 1.0.0 is the first stable release of Srain, enjoy!
1810 2019-10-07 Version 1.0.0rc9999
1812 • Features:
1813 • Activate corresponding buffer when channel URL is clicked (#190)
1815 • Command alias support (#188)
1817 • List predefined servers via command, see /server for details (‐
1819 656f3e5)
1820 • Changes:
1822 • Replace all icons with freedesktop standard icons (#120)
1824 • Bug fixes:
1826 • Fix wrong usage of GError (#179)
1828 • Fix image preview problem when image is hard to detect type (#163)
1830 • Fix memory leak of pattern filter (9464a9e)
1832 • Fix the breaking "abort sending" icon (#144)
1834 • Fix the invite menu of user (9f98cbb)
1836 2019-06-14 Version 1.0.0rc5
1838 • Added:
1839 • Regular expression pattern management using /pattern command
1841 • Add command /filter & /unfilter for filtering message via pat‐
1843 tern
1844 • Add command /render & /unrender for rendering message via pat‐
1846 tern
1847 • Changed:
1849 • Refactor detector module and rename it to render
1851 • Refactor filter module
1853 • Change project description
1855 • Removed:
1857 • Drop command /rignore & /unrignore
1859 • Drop command /relay & /unrelay
1861 2019-05-13 Version 1.0.0rc4
1863 • Added:
1864 • New dependency libsecret
1866 • Add password storage support
1868 • Add command line options --no-auto, used to require Srain not to
1870 automatically connect to servers
1871 • Add russian translation, thanks to @tim77
1873 • Allow user send slash(/) prefixed message
1875 • Removed:
1877 • Drop all password fields in configuration file
1879 • Changed:
1881 • Enable CSD(Client-Side Decoration) by default
1883 • Update chinese translation
1885 2019-04-14 Version 1.0.0rc3
1887 2019-01-24 Version 1.0.0rc2
1888 2018-09-10 Version 1.0.0rc1
1889 2018-02-28 Version 0.06.4
1890 • Changed:
1891 • Change default application ID to im.srain.Srain
1893 • Added:
1895 • CTCP support, including request & response CLIENTINFO, FINGER,
1897 PING, SOURCE, TIME, VERSION, USERINFO messages. DCC message is not
1898 yet supported. Use command /ctcp for sending a CTCP request
1899 • Login method support, you can specify it by configuration file op‐
1901 tion server.login_method:
1902 • sasl_plain: SASL PLAIN authentication support, will use
1904 server.user.username as identity, and use server.user.passwd
1905 as password
1906 • Added documentation Support Tables used to show Srain's features,
1908 inspried by https://ircv3.net/software/clients.html
1909 • Added a semantic version parser, not yet used
1911 • Added appdata file which requier by application store, thanks to
1913 @cpba
1914 • openSUSE package is available, please refer to openSUSE for de‐
1916 tails, thanks to @alois
1917 • Flatpak package is available, please refer to Fedora for details,
1919 thanks to @cpba
1920 • Improved:
1922 • Fixed a logical error in IRC message parser: all parameters are
1924 equal whether matched by <middle> or <trailing>, thanks to
1925 @DanielOaks
1926 • Improved connection state control, you can smoothly disconnect/quit
1928 from server even it is unresponsive
1929 • Fixed truncated message output by /server list subcommand
1931 • Fixed crash at g_type_check_instance() under GLib 2.54.3+
1933 • Fixed: Do not free a SrianServerBuffer which has non-empty buffer
1935 • Ensure the QUIT message can be sent before application shutdown
1937 • Removed entry from desktop file, thanks to @TingPing
1939 • Fixed grammer of join message, thanks to @raindev
1941 • Re-enable CI for Srain: ci-status
1943 2017-12-22 Version 0.06.3
1945 • Changed:
1946 • Configurable file option tls_not_verify in irc block in server
1948 block is renamed to tls_noverify, old option name is still sup‐
1949 ported
1950 • Command option tls-not-verify for /server and /connect is renamed
1952 to tls-noverify, old option name is still supported
1953 • Added:
1955 • Connect popover supports connect to predefined server
1957 • Join popover supports channel search
1959 • Improved:
1961 • Modified margin and padding of some widgets
1963 • Improved the style of unread message counter
1965 • Fixed markup parse error of decorator
1967 • Fixed crashing while connecting from connect popover
1969 • Fixed use after free while removing user
1971 • Improved the performance and extensibility of user list
1973 • Improved compatibility with older versions of GTK(> 3.16)
1975 • Refactor the code of chat panel, helpful for the next development
1977 2017-09-12 Version 0.06.2
1979 • Added:
1980 • mIRC color support, can be disabled via setting render_mirc_color
1982 option in chat block in server block to false
1983 • Improved:
1985 • Better error reporting while operating the UI
1987 • IRC URL can be opened directly within the application
1989 • Text in input entry, connection panel and join panel will not be
1991 cleared while operation is not successful
1992 • Fixed: in some cases, nickname registration will case infinity loop
1994 • Decorator and filter now can process xml message
1996 • Imporved the handling of channel topic
1998 2017-08-18 Version 0.06.1
2000 • Added:
2001 • Added GPL copyright statements
2003 • RPL_CHANNEL_URL (328) message support
2005 • Command line options support, type srain -h for help message
2007 • Support for Creating server and joining channel from IRC URL
2009 • New dependency libsoup
2011 • Add reconnect timer: if connection fails, Srain will wait for 5
2013 seconds then try to connect again. If it still fails, waiting time
2014 will increase by 5 second
2015 • Improved:
2017 • Fixed the crash when QUIT
2019 • Fixed: avoid sending empty password
2021 • More empty parameters checks
2023 • Imporve server connection status control
2025 2017-07-29 Version 0.06
2027 • Changed:
2028 • The third time of refactor ;-)
2030 • New command parser, for the syntax, refer to Syntax.
2032 • Changed the format of Chat log
2034 • The /relay & /unrelay command doesn't support custom delimiter,
2036 this function will be implemented as python plugin in the future
2037 • Use reStructuredText for document instead of Markdown
2039 • Added:
2041 • Message filter: mechanism for filtering message
2043 • Message Decorator: mechanism for changing message
2045 • Install script for Gentoo, thanks to @rtlanceroad !
2047 • New command /rignore & /unrignore for ignore message using regular
2049 expression, thanks to @zwindl !
2050 • Config file support
2052 • Configurable log module, more convenient for developing and report‐
2054 ing issue
2055 • New Return value type, for more friendly error reporting
2057 • New command /server for IRC servers management
2059 • Srain home page is available at:
2061 :del:`https://srain.im`
2062 (expired, use https://srain.silverrainz.me)
2063 • Srain help documentation is available at:
2065 :del:`https://doc.srain.im`
2066 (expired, use https://srain.silverrainz.me)
2067 • Removed:
2069 • Remove libircclient dependence
2071 • Improved:
2073 • Improve reconnection stuff: auto reconnect when ping time out
2075 • More accurate message mention
2077 • Display preview image in correct size
2079 • Any number of image links in message can be previewed
2081 • HTTP(and some other protocols) link, domain name, email address and
2083 IRC channel name in topic and messages can be rendered as hyper
2084 link
2085 • The sent message can be merged to last sent message
2087 • Fixed some bugs
2089 2016-09-19 Version 0.05.1
2091 • Create missing directory: $XDG_CACHE_HOME/srain/avatars
2092 2016-08-27 Version 0.05
2094 • Changed:
2095 • Port to libircclient
2097 • SSL connection support
2099 • Server password support
2101 • Channel password support
2103 • Added:
2105 • Convenience GtkPopover for connecting and joining
2107 • Nick popmenu
2109 • Translations: zh_CN
2111 • Forward message
2113 • Chat log
2115 • Colorful user list icon
2117 • Mentioned highlight
2119 • Desktop notification
2121 • Improved:
2123 • More friendly User interface
2125 • Stronger {upload,avatar} plugin
2127 • Fixed a lot of bugs
2129 2016-04-30 Version 0.03
2131 • New interface between UI and IRC module
2132 • Multi-server support
2134 • Channel name is not case sensitive now
2136 • /quit command will close all SrainChan of a server
2138 • Fix GTK-Warning when close a SrainCHan
2140 NOTE:
2142 0.03 is a pre-release, some functions are no completed yet. it also
2143 has some undetected bugs.
2144 2016-04-13 Version 0.02
2146 • Bugs fixed
2147 • Port to GTK+-3.20
2149 NOTE:
2151 0.02 is a pre-release, some functions are no completed yet. it also
2152 has some undetected bugs.
2153 2016-04-07 Version 0.01
2155 • Implement basic functions of a IRC client
2156 • Themes: Silver Rain (light)
2158 • Simple python plugin support:
2160 • Auto upload image to pastebin (img.vim-cn.org)
2162 • Get github avatar according nickname
2164 • NB: plugin will separated from this repo in the future
2166 • Image preview from URL
2168 • Relay bot message transfrom
2170 • Nick auto completion
2172 • Combine message from same person
2174 NOTE:
2176 0.01 is a pre-release, some functions are no completed yet. it also
2177 has some undetected bugs.
2178 Support Tables
2180 • Basic IRC Client Support
2181 • Client-to-Client Protocol (CTCP) Support
2183 • IRCv3 Client Support
2185 Basic IRC Client Support
2187 ┌────────────────────┬─────────────┐
2188 │Function │ Support │
2189 ├────────────────────┼─────────────┤
2190 │Auto reconnect │ Yes │
2191 ├────────────────────┼─────────────┤
2192 │Multiple connection │ Yes │
2193 ├────────────────────┼─────────────┤
2194 │TLS connection │ Yes │
2195 ├────────────────────┼─────────────┤
2196 │Nick completion │ Yes │
2197 ├────────────────────┼─────────────┤
2198 │Ignore and filter │ Yes │
2199 ├────────────────────┼─────────────┤
2200 │Chat log │ Yes │
2201 ├────────────────────┼─────────────┤
2202 │Configuration file │ Yes │
2203 ├────────────────────┼─────────────┤
2204 │Command │ Yes │
2205 ├────────────────────┼─────────────┤
2206 │mIRC color │ Yes │
2207 ├────────────────────┼─────────────┤
2208 │Plugin │ Unavailable │
2209 └────────────────────┴─────────────┘
2210 Client-to-Client Protocol (CTCP) Support
2212 ┌───────────┬─────────┐
2213 │Message │ Support │
2214 ├───────────┼─────────┤
2215 │ACTION │ Yes │
2216 └───────────┴─────────┘
2217 │CLIENTINFO │ Yes │
2219 ├───────────┼─────────┤
2220 │DCC │ No │
2221 ├───────────┼─────────┤
2222 │FINGER │ Yes │
2223 ├───────────┼─────────┤
2224 │PING │ Yes │
2225 ├───────────┼─────────┤
2226 │SOURCE │ Yes │
2227 ├───────────┼─────────┤
2228 │TIME │ Yes │
2229 ├───────────┼─────────┤
2230 │VERSION │ Yes │
2231 ├───────────┼─────────┤
2232 │USERINFO │ Yes │
2233 └───────────┴─────────┘
2234 IRCv3 Client Support
2236 ┌──────────────────┬────────────────────────────┐
2237 │Feature │ Support │
2238 ├──────────────────┼────────────────────────────┤
2239 │CAP v3.1 │ Yes │
2240 ├──────────────────┼────────────────────────────┤
2241 │CAP v3.2 │ Yes │
2242 ├──────────────────┼────────────────────────────┤
2243 │cap-notify │ Yes │
2244 ├──────────────────┼────────────────────────────┤
2245 │account-notify │ No │
2246 ├──────────────────┼────────────────────────────┤
2247 │account-tag │ No │
2248 ├──────────────────┼────────────────────────────┤
2249 │away-notify │ No │
2250 ├──────────────────┼────────────────────────────┤
2251 │batch │ No │
2252 ├──────────────────┼────────────────────────────┤
2253 │chghost │ No │
2254 ├──────────────────┼────────────────────────────┤
2255 │echo-message │ No │
2256 ├──────────────────┼────────────────────────────┤
2257 │extended-join │ No │
2258 ├──────────────────┼────────────────────────────┤
2259 │invite-notify │ Yes │
2260 ├──────────────────┼────────────────────────────┤
2261 │Monitor │ No │
2262 ├──────────────────┼────────────────────────────┤
2263 │multi-prefix │ No │
2264 ├──────────────────┼────────────────────────────┤
2265 │SASL v3.1 │ PLAIN,ECDSA-NIST256P-CHAL‐ │
2266 │ │ LENGE │
2267 ├──────────────────┼────────────────────────────┤
2268 │SASL v3.2 │ PLAIN,ECDSA-NIST256P-CHAL‐ │
2269 │ │ LENGE │
2270 ├──────────────────┼────────────────────────────┤
2271 │server-time │ No │
2272 ├──────────────────┼────────────────────────────┤
2273 │starttls │ No │
2274 ├──────────────────┼────────────────────────────┤
2275 │sts │ No │
2276 ├──────────────────┼────────────────────────────┤
2277 │userhost-in-names │ No │
2278 └──────────────────┴────────────────────────────┘
2279
2281 Shengyu Zhang
2282
2284 2022, Shengyu Zhang
22851.5.0 Oct 02, 2022 SRAIN(1)