From 0f5c6b1f7d41419cdead8a919ecc38daeb59a3fa Mon Sep 17 00:00:00 2001 From: Kristofer Rye Date: Tue, 10 Jun 2014 12:49:18 -0400 Subject: [PATCH 1/9] Create a mirror README.md file. --- README.md | 115 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..a2bf1e7a --- /dev/null +++ b/README.md @@ -0,0 +1,115 @@ + + +irssi, http://irssi.org + + + * INSTALLATION + +See INSTALL file. + + + * FILES + + - docs/ directory contains several documents: + - startup-HOWTO.txt - new users should read this + - manual.txt - manual I started writing but didn't get it very far :) + - perl.txt - Perl scripting help + - formats.txt - How to use colors, etc. with irssi + - faq.txt - Frequently Asked Questions + - special_vars.txt - some predefined $variables you can use with irssi + + + * ABOUT + +Irssi is a modular IRC client that currently has only text mode user +interface, but 80-90% of the code isn't text mode specific, so other +UIs could be created pretty easily. Also, Irssi isn't really even IRC +specific anymore, there's already a working SILC (http://www.silcnet.org) +module available. Support for other protocols like ICQ could be created +some day too. + + + * FEATURES + +So what's so great about Irssi? Here's a list of some features I can +think of currently: + + - Optional automation - There's lots of things Irssi does for you + automatically that some people like and others just hate. Things like: + nick completion, creating new window for newly joined channel, creating + queries when msgs/notices are received or when you send a msg, closing + queries when it's been idle for some time, etc. + + - Multiserver friendy - I think Irssi has clearly the best support + for handling multiple server connections. You can have as many as you + want in as many ircnets as you want. Having several connections in one + server works too, for example when you hit the (ircnet's) 10 + channels/connection limit you can just create another connection and + you hardly notice it. If connection to server is lost, Irssi tries to + connect back until it's successful. Also channels you were joined + before disconnection are restored, even if they're "temporarily + unavailable" because of netsplits, Irssi keeps rejoining back to them. + Also worth noticing - there's not that stupid "server is bound to this + window, if this window gets closed the connection closes" thing that + ircII based clients have. + + - Channel automation - You can specify what channels to join to + immediately after connected to some server or IRC network. After joined + to channel, Irssi can automatically request ops for you (or do + anything, actually) from channel's bots. + + - Window content saving - Say /LAYOUT SAVE when you've put all the + channels and queries to their correct place, and after restarting + Irssi, the channels will be joined back into windows where they were + saved. + + - Tab completing anything - You can complete lots of things with tab: + nicks, commands, command -options, file names, settings, text format + names, channels and server names. There's also an excellent /msg + completion that works transparently with multiple IRC networks. + Completing channel nicks is also pretty intelligent, it first goes + through the people who have talked to you recently, then the people who + have talked to anyone recently and only then it fallbacks to rest of + the nicks. You can also complete a set of words you've specified, for + example homepage changes it to your actual home page URL. + + - Excellent logging - You can log any way you want and as easily or + hard as you want. With autologging Irssi logs everything to specified + directory, one file per channel/nick. ircII style /WINDOW LOG ON is + also supported. There's also the "hard way" of logging - /LOG command + which lets you specify exactly what you wish to log and where. Log + rotating is supported with all the different logging methods, you can + specify how often you want it to rotate and what kind of time stamp to + use. + + - Excellent ignoring - You can most probably ignore anything any way + you want. Nick masks, words, regular expressions. You can add + exceptions to ignores. You can ignore other people's replies in + channels to nicks you have ignored. You can also specify that the + specific ignores work only in specific channel(s). + + - Lastlog and scrollback handling - /LASTLOG command has some new + features: -new option checks only lines that came since you last did + /LASTLOG command, -away option checks new lines since you last went + away. Regular expression matches work also, of course. Going to some + wanted place at scrollback has always been hard with non-GUI clients. A + search command that jumps around in scrollback in GUI-style is still + missing from Irssi, but there's something that's almost as good as it. + /LASTLOG always shows timestamps when the line was printed, even if you + didn't have timestamps on. Now doing /SB GOTO jumps + directly to the position in scrollback you wanted. Great feature when + you want to browse a bit of the discussion what happened when someone + said your name (as seen in awaylog) or topic was changed (/last + -topics) + + + * BUGS / SUGGESTIONS + +See TODO file and http://bugs.irssi.org if it is already listed in there; +if not open a bugreport on http://bugs.irssi.org or send a mail to +staff@irssi.org + +You can also contact the Irssi developers on #irssi @ EFnet, Freenode, IRCnet, +Quakenet and Undernet. + +The IRCnet channel is for development related questions and discussions. From 1f24e3a828db9d8200ce84e5b06870f0997f6855 Mon Sep 17 00:00:00 2001 From: Kristofer Rye Date: Tue, 10 Jun 2014 12:50:04 -0400 Subject: [PATCH 2/9] Remove preceding whitespace. --- README | 2 -- 1 file changed, 2 deletions(-) diff --git a/README b/README index a2bf1e7a..5241b4c3 100644 --- a/README +++ b/README @@ -1,5 +1,3 @@ - - irssi, http://irssi.org From 314ead0c203943ad463d97df93cee7f71a41b851 Mon Sep 17 00:00:00 2001 From: Kristofer Rye Date: Tue, 10 Jun 2014 12:51:50 -0400 Subject: [PATCH 3/9] Oops, wrong file. --- README | 2 ++ README.md | 2 -- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README b/README index 5241b4c3..a2bf1e7a 100644 --- a/README +++ b/README @@ -1,3 +1,5 @@ + + irssi, http://irssi.org diff --git a/README.md b/README.md index a2bf1e7a..5241b4c3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ - - irssi, http://irssi.org From d9de727b12491f930312ca3dac7051f23ffb5b26 Mon Sep 17 00:00:00 2001 From: Kristofer Rye Date: Tue, 10 Jun 2014 12:52:51 -0400 Subject: [PATCH 4/9] Switch to Markdown headings for the section headings. --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5241b4c3..31629928 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,10 @@ -irssi, http://irssi.org +# irssi, http://irssi.org - - * INSTALLATION +## INSTALLATION See INSTALL file. - - * FILES +## FILES - docs/ directory contains several documents: - startup-HOWTO.txt - new users should read this @@ -17,7 +15,7 @@ See INSTALL file. - special_vars.txt - some predefined $variables you can use with irssi - * ABOUT +## ABOUT Irssi is a modular IRC client that currently has only text mode user interface, but 80-90% of the code isn't text mode specific, so other @@ -26,8 +24,7 @@ specific anymore, there's already a working SILC (http://www.silcnet.org) module available. Support for other protocols like ICQ could be created some day too. - - * FEATURES +## FEATURES So what's so great about Irssi? Here's a list of some features I can think of currently: @@ -101,7 +98,7 @@ think of currently: -topics) - * BUGS / SUGGESTIONS +## BUGS / SUGGESTIONS See TODO file and http://bugs.irssi.org if it is already listed in there; if not open a bugreport on http://bugs.irssi.org or send a mail to From 23928fdaa91af6950054d63a304ef80f17e0ebb4 Mon Sep 17 00:00:00 2001 From: Kristofer Rye Date: Tue, 10 Jun 2014 12:54:07 -0400 Subject: [PATCH 5/9] Change the case on the headers. All-caps is kinda shouting. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 31629928..ece403d2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # irssi, http://irssi.org -## INSTALLATION +## Installation See INSTALL file. -## FILES +## Files - docs/ directory contains several documents: - startup-HOWTO.txt - new users should read this @@ -15,7 +15,7 @@ See INSTALL file. - special_vars.txt - some predefined $variables you can use with irssi -## ABOUT +## About Irssi is a modular IRC client that currently has only text mode user interface, but 80-90% of the code isn't text mode specific, so other @@ -24,7 +24,7 @@ specific anymore, there's already a working SILC (http://www.silcnet.org) module available. Support for other protocols like ICQ could be created some day too. -## FEATURES +## Features So what's so great about Irssi? Here's a list of some features I can think of currently: @@ -98,7 +98,7 @@ think of currently: -topics) -## BUGS / SUGGESTIONS +## Bugs / Suggestions See TODO file and http://bugs.irssi.org if it is already listed in there; if not open a bugreport on http://bugs.irssi.org or send a mail to From e717f13274fc8c298d0ba60365d9f3839fe12a23 Mon Sep 17 00:00:00 2001 From: Kristofer Rye Date: Tue, 10 Jun 2014 12:56:45 -0400 Subject: [PATCH 6/9] Put filenames in code blocks. --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ece403d2..7172efe3 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,17 @@ ## Installation -See INSTALL file. +See `INSTALL` file. ## Files - - docs/ directory contains several documents: - - startup-HOWTO.txt - new users should read this - - manual.txt - manual I started writing but didn't get it very far :) - - perl.txt - Perl scripting help - - formats.txt - How to use colors, etc. with irssi - - faq.txt - Frequently Asked Questions - - special_vars.txt - some predefined $variables you can use with irssi + - The `docs/` directory contains several documents: + - `startup-HOWTO.txt` - new users should read this + - `manual.txt` - manual I started writing but didn't get it very far :) + - `perl.txt` - Perl scripting help + - `formats.txt` - How to use colors, etc. with irssi + - `faq.txt` - Frequently Asked Questions + - `special_vars.txt` - some predefined $variables you can use with irssi ## About @@ -100,9 +100,9 @@ think of currently: ## Bugs / Suggestions -See TODO file and http://bugs.irssi.org if it is already listed in there; if not open a bugreport on http://bugs.irssi.org or send a mail to staff@irssi.org +See `TODO` file and http://bugs.irssi.org if it is already listed in there; You can also contact the Irssi developers on #irssi @ EFnet, Freenode, IRCnet, Quakenet and Undernet. From d31ccc2a474f068ee81a4dbbf13e9a686df8cfbb Mon Sep 17 00:00:00 2001 From: Kristofer Rye Date: Tue, 10 Jun 2014 12:57:10 -0400 Subject: [PATCH 7/9] Make the mailing link an actual link. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7172efe3..38163b16 100644 --- a/README.md +++ b/README.md @@ -100,9 +100,9 @@ think of currently: ## Bugs / Suggestions -if not open a bugreport on http://bugs.irssi.org or send a mail to -staff@irssi.org See `TODO` file and http://bugs.irssi.org if it is already listed in there; +if not open a bugreport on http://bugs.irssi.org or [send a mail to +staff@irssi.org](mailto:staff@irssi.org) You can also contact the Irssi developers on #irssi @ EFnet, Freenode, IRCnet, Quakenet and Undernet. From 3d7f90a6b1f0b9d131ca931bf4542bf6a3166b1a Mon Sep 17 00:00:00 2001 From: Kristofer Rye Date: Tue, 10 Jun 2014 12:58:45 -0400 Subject: [PATCH 8/9] Make features list contents bolded. --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 38163b16..cf621e5e 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,13 @@ some day too. So what's so great about Irssi? Here's a list of some features I can think of currently: - - Optional automation - There's lots of things Irssi does for you + - **Optional automation** - There's lots of things Irssi does for you automatically that some people like and others just hate. Things like: nick completion, creating new window for newly joined channel, creating queries when msgs/notices are received or when you send a msg, closing queries when it's been idle for some time, etc. - - Multiserver friendy - I think Irssi has clearly the best support + - **Multiserver friendy** - I think Irssi has clearly the best support for handling multiple server connections. You can have as many as you want in as many ircnets as you want. Having several connections in one server works too, for example when you hit the (ircnet's) 10 @@ -48,17 +48,17 @@ think of currently: window, if this window gets closed the connection closes" thing that ircII based clients have. - - Channel automation - You can specify what channels to join to + - **Channel automation** - You can specify what channels to join to immediately after connected to some server or IRC network. After joined to channel, Irssi can automatically request ops for you (or do anything, actually) from channel's bots. - - Window content saving - Say /LAYOUT SAVE when you've put all the + - **Window content saving** - Say /LAYOUT SAVE when you've put all the channels and queries to their correct place, and after restarting Irssi, the channels will be joined back into windows where they were saved. - - Tab completing anything - You can complete lots of things with tab: + - **Tab completing anything** - You can complete lots of things with tab: nicks, commands, command -options, file names, settings, text format names, channels and server names. There's also an excellent /msg completion that works transparently with multiple IRC networks. @@ -68,7 +68,7 @@ think of currently: the nicks. You can also complete a set of words you've specified, for example homepage changes it to your actual home page URL. - - Excellent logging - You can log any way you want and as easily or + - **Excellent logging** - You can log any way you want and as easily or hard as you want. With autologging Irssi logs everything to specified directory, one file per channel/nick. ircII style /WINDOW LOG ON is also supported. There's also the "hard way" of logging - /LOG command @@ -77,13 +77,13 @@ think of currently: specify how often you want it to rotate and what kind of time stamp to use. - - Excellent ignoring - You can most probably ignore anything any way + - **Excellent ignoring** - You can most probably ignore anything any way you want. Nick masks, words, regular expressions. You can add exceptions to ignores. You can ignore other people's replies in channels to nicks you have ignored. You can also specify that the specific ignores work only in specific channel(s). - - Lastlog and scrollback handling - /LASTLOG command has some new + - **Lastlog and scrollback handling** - /LASTLOG command has some new features: -new option checks only lines that came since you last did /LASTLOG command, -away option checks new lines since you last went away. Regular expression matches work also, of course. Going to some From 4f2cc1b9e2c291602ad7cd8cb68f4e2b59ef44cd Mon Sep 17 00:00:00 2001 From: Kristofer Rye Date: Tue, 10 Jun 2014 13:00:34 -0400 Subject: [PATCH 9/9] Delete the old README. --- README | 115 --------------------------------------------------------- 1 file changed, 115 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index a2bf1e7a..00000000 --- a/README +++ /dev/null @@ -1,115 +0,0 @@ - - -irssi, http://irssi.org - - - * INSTALLATION - -See INSTALL file. - - - * FILES - - - docs/ directory contains several documents: - - startup-HOWTO.txt - new users should read this - - manual.txt - manual I started writing but didn't get it very far :) - - perl.txt - Perl scripting help - - formats.txt - How to use colors, etc. with irssi - - faq.txt - Frequently Asked Questions - - special_vars.txt - some predefined $variables you can use with irssi - - - * ABOUT - -Irssi is a modular IRC client that currently has only text mode user -interface, but 80-90% of the code isn't text mode specific, so other -UIs could be created pretty easily. Also, Irssi isn't really even IRC -specific anymore, there's already a working SILC (http://www.silcnet.org) -module available. Support for other protocols like ICQ could be created -some day too. - - - * FEATURES - -So what's so great about Irssi? Here's a list of some features I can -think of currently: - - - Optional automation - There's lots of things Irssi does for you - automatically that some people like and others just hate. Things like: - nick completion, creating new window for newly joined channel, creating - queries when msgs/notices are received or when you send a msg, closing - queries when it's been idle for some time, etc. - - - Multiserver friendy - I think Irssi has clearly the best support - for handling multiple server connections. You can have as many as you - want in as many ircnets as you want. Having several connections in one - server works too, for example when you hit the (ircnet's) 10 - channels/connection limit you can just create another connection and - you hardly notice it. If connection to server is lost, Irssi tries to - connect back until it's successful. Also channels you were joined - before disconnection are restored, even if they're "temporarily - unavailable" because of netsplits, Irssi keeps rejoining back to them. - Also worth noticing - there's not that stupid "server is bound to this - window, if this window gets closed the connection closes" thing that - ircII based clients have. - - - Channel automation - You can specify what channels to join to - immediately after connected to some server or IRC network. After joined - to channel, Irssi can automatically request ops for you (or do - anything, actually) from channel's bots. - - - Window content saving - Say /LAYOUT SAVE when you've put all the - channels and queries to their correct place, and after restarting - Irssi, the channels will be joined back into windows where they were - saved. - - - Tab completing anything - You can complete lots of things with tab: - nicks, commands, command -options, file names, settings, text format - names, channels and server names. There's also an excellent /msg - completion that works transparently with multiple IRC networks. - Completing channel nicks is also pretty intelligent, it first goes - through the people who have talked to you recently, then the people who - have talked to anyone recently and only then it fallbacks to rest of - the nicks. You can also complete a set of words you've specified, for - example homepage changes it to your actual home page URL. - - - Excellent logging - You can log any way you want and as easily or - hard as you want. With autologging Irssi logs everything to specified - directory, one file per channel/nick. ircII style /WINDOW LOG ON is - also supported. There's also the "hard way" of logging - /LOG command - which lets you specify exactly what you wish to log and where. Log - rotating is supported with all the different logging methods, you can - specify how often you want it to rotate and what kind of time stamp to - use. - - - Excellent ignoring - You can most probably ignore anything any way - you want. Nick masks, words, regular expressions. You can add - exceptions to ignores. You can ignore other people's replies in - channels to nicks you have ignored. You can also specify that the - specific ignores work only in specific channel(s). - - - Lastlog and scrollback handling - /LASTLOG command has some new - features: -new option checks only lines that came since you last did - /LASTLOG command, -away option checks new lines since you last went - away. Regular expression matches work also, of course. Going to some - wanted place at scrollback has always been hard with non-GUI clients. A - search command that jumps around in scrollback in GUI-style is still - missing from Irssi, but there's something that's almost as good as it. - /LASTLOG always shows timestamps when the line was printed, even if you - didn't have timestamps on. Now doing /SB GOTO jumps - directly to the position in scrollback you wanted. Great feature when - you want to browse a bit of the discussion what happened when someone - said your name (as seen in awaylog) or topic was changed (/last - -topics) - - - * BUGS / SUGGESTIONS - -See TODO file and http://bugs.irssi.org if it is already listed in there; -if not open a bugreport on http://bugs.irssi.org or send a mail to -staff@irssi.org - -You can also contact the Irssi developers on #irssi @ EFnet, Freenode, IRCnet, -Quakenet and Undernet. - -The IRCnet channel is for development related questions and discussions.