diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/about/index.markdown | 96 | ||||
| -rw-r--r-- | documentation/index.markdown | 37 |
2 files changed, 127 insertions, 6 deletions
diff --git a/documentation/about/index.markdown b/documentation/about/index.markdown new file mode 100644 index 0000000..9c60ce7 --- /dev/null +++ b/documentation/about/index.markdown @@ -0,0 +1,96 @@ +--- +layout: page +title: About Irssi +permalink: /about/ +categories: [ _1 ] +twocolumn: true +--- + +Introduction +------------ + +Irssi is a terminal based IRC client for UNIX systems. It also supports SILC +and ICB protocols via plugins. + +<div markdown="1"> + +### Greatest features +You might be wondering what makes Irssi such an easy and comfortable client +to use; Joost Vunderink wrote a summary of the most beneficial Irssi features. + +</div> +<div markdown="1"> + +### Autologging +Irssi can automatically log any channels, queries or special windows that +you want. The logfiles will be separated per IRC network by default, and even +log rotation is supported. Log file formats, themes and destination directories +can be easily configured with the Irssi log settings. + +</div> +<div markdown="1"> + +### Formats and themes +Theming is a popular item in todays desktop enviroments, it's an easy yet +powerful way to customize your Irssi client's look and feel. Irssi's +formatting is modular which means you can just change the appearance of the +objects and all items contaning that object will change into that format. + +</div> +<div markdown="1"> + +### Configurable keybindings +This feature is a piece of art; it allows you to modify the default +keybindings and create your own so you can customize your client. If these +keybindings are tuned, you can switch through the windows in no time, execute +commands and even complete objects with these bindings. + +</div> +<div markdown="1"> + +### Paste detection +If you have ever pasted a bunchload of text into a wrong channel, you know +how hard the consequences can be. Irssi tries to detect when you are pasting +large amounts of text, by looking at the speed that characters are entered; +if such pasting is detected [TAB]-characters are sent as-is instead of being +tab-completed and eventually ending up in a wrong destination window. When +Irssi detects such a pasting, you will get the option to either abort the +paste or execute the paste, this way you have total control of the pasting. + +</div> +<div markdown="1"> + +### Perl scripting +Perl is one of the most used programming languages around the globe and +integrating Perl into applications means flexible and powerful scripting +capabilities. The entire behavior and appearence of Irssi can be modified +within these Perl scripts. Irssi provides a script archive with many +contributed Irssi scripts which provide both useful extra features and the +required assistance to make your own scripts. + +</div> +<div markdown="1"> + +### Irssi-proxy +This is much more than just a bouncer, Irssi-proxy is a plugin which allows +to bind a port to each IRC server you are connected to. This means that +instead of having to remember to identify with a password, you can just +connect to the Irssi-proxy with a server password. The copy of Irssi running +the proxy works just as a normal client which you can use, but you can also +connect one or more clients to it to share the connections. Using Irssi as a +proxy has the major advantage of Irssi's power as an IRC client. You never +have to worry about losing your connection to IRC. Even if you don't want to +use Irssi as a client, I can strongly recommend it as a proxy because you can +just connect to it with any IRC client by just connecting to the specified +port instead of SSH-ing to the machine that your Irssi is running on. + +</div> +<div markdown="1"> + +### Upgrades +Upgrading your Irssi client to the latest version can be easily done +without losing the connections to the IRC servers and without restarting +Irssi. You can use the UPGRADE command to load the new Irssi binary and +restoring your connections. + +</div> diff --git a/documentation/index.markdown b/documentation/index.markdown index 1f5feab..34cb822 100644 --- a/documentation/index.markdown +++ b/documentation/index.markdown @@ -1,23 +1,30 @@ --- layout: page -title: Documentation +title: Help permalink: documentation/ categories: [ _nav ] --- -## Irssi documentation and tutorials: - ### Documentation -- Check the built-in `/HELP`, it has all the details on command syntax +- [Frequently Asked Questions](faq) - [Startup How-To](startup) +- Check the built-in `/HELP`, it has all the details on command syntax - [Settings](settings) -- [Frequently Asked Questions](faq) -- [Writing good bug reports](//github.com/irssi/irssi/blob/master/docs/crash.txt){:rel='external'} - [Design](//github.com/irssi/irssi/blob/master/docs/design.txt){:rel='external'} - [Manual](//github.com/irssi/irssi/blob/master/docs/manual.txt){:rel='external'}, a bit dated and unfinished - [Contributing](/development) +### Support + +- [`#irssi` IRC](/support/irc) + +> If your irssi crashes, it's always a bug. Please read [bugreporting howto](/documentation/crash) +and send one. For other type of bugs, it would still be nice to hear of them, +but chances are that it's already known. Send all bugreports to irssi's [bug +reporting system](//github.com/irssi/irssi/issues), but check if it has already +been reported first. + ### Miscellaneous - [Tips & Tricks](tips) @@ -25,6 +32,7 @@ categories: [ _nav ] - [Colour Formats](//github.com/irssi/irssi/blob/master/docs/formats.txt){:rel='external'} - [Special Variables](//github.com/irssi/irssi/blob/master/docs/special_vars.txt){:rel='external'} - [Irssi 0.8.17 Tips](//github.com/shabble/irssi-docs/wiki/Irssi-0.8.17){:rel='external'} +- [About Irssi](about) (historical) ### Tutorials @@ -41,3 +49,20 @@ categories: [ _nav ] - [Signals](//github.com/irssi/irssi/blob/master/docs/signals.txt){:rel='external'} - (Unofficial) [Irssi Scripting and Documentation Wiki](//github.com/shabble/irssi-docs/wiki){:rel='external'} +### Compiling problems + +Read the [INSTALL](//github.com/irssi/irssi/blob/master/INSTALL){:rel='external'} file that comes with irssi, it explains the most common +problems. + +### Still problems? + +Read the [FAQ](/documentation/faq) +before asking anything. +The [Startup How-To](/documentation/startup) is quite useful as well. +And if you just want to know about some setting, you could very well guess +it yourself too, like if you want to change something related to windows, +try `/SET window`. + +If you still haven't found what you're looking for, and googling didn't help either, +try asking on IRC in `#irssi`. + |