diff --git a/docs/startup-HOWTO.html b/docs/startup-HOWTO.html index f8b42957..fc1b01fa 100644 --- a/docs/startup-HOWTO.html +++ b/docs/startup-HOWTO.html @@ -15,11 +15,14 @@
Disable automatic window closing when /PARTing channel or /UNQUERYing -query:
+Disable automatic window closing when /PART
ing channel or
+/UNQUERY
ing query:
/SET autoclose_windows OFF @@ -141,9 +144,9 @@ If you want lines containing your nick to hilight: work for you, use Meta-p and Meta-n keys. For jumping to beginning or end of the buffer, use /SB HOME and /SB END commands. --By default, irssi uses "hidden windows" for everything. Hidden -window is created every time you /JOIN a channel or /QUERY someone. -There's several ways you can change between these windows:
+By default, irssi uses "hidden windows" for everything. Hidden window is +created every time you
/JOIN
a channel or/QUERY
+someone. There's several ways you can change between these windows:Meta-1, Meta-2, .. Meta-0 - Jump directly between windows 1-10 @@ -176,11 +179,12 @@ want to use ALT instead of Windows key for it, use:And how exactly do you set these X resources? For Debian, there's -/etc/X11/Xresources/xterm file where you can put them and it's read -automatically when X starts. ~/.Xresources and ~/.Xdefaults files might also -work. If you can't get anything else to work, just copy&paste those lines to -~/.Xresources and directly call "xrdb -merge ~/.Xresources" in some xterm. -The resources affect only the new xterms you start, not existing ones.
+/etc/X11/Xresources/xterm
file where you can put them and it's +read automatically when X starts.~/.Xresources
and +~/.Xdefaults
files might also work. If you can't get anything +else to work, just copy and paste those lines to~/.Xresources
+and directly callxrdb -merge ~/.Xresources
in some xterm. +The resources affect only the new xterms you start, not existing ones.Many windows SSH clients also don't allow usage of ALT. One excellent client that does allow is putty, you can download it from @@ -260,11 +264,16 @@ helps with reconnecting if your primary server breaks and is probably useful in some other ways too :) For information how to actually use irssi correctly with multiple servers see the chapter 6.
-First you need to have your IRC network set, use /IRCNET command to -see if it's already there. If it isn't, use /IRCNET ADD yourircnet. To -make Irssi work properly with different IRC networks, you might need to -give some special settings to /IRCNET ADD, see manual.txt for more -information about them. Irssi defaults to IRCNet's behaviour.
+First you need to have your IRC network set, use
+ +/IRCNET
+command to see if it's already there. If it isn't, use/IRCNET ADD +yourircnet
. If you want to execute some commands automatically when +you're connected to some network, use -autosendcmd option. Here's some +examples:+ /IRCNET ADD -autosendcmd '^msg bot invite' ircnet + /IRCNET ADD -autosendcmd "/^msg nickserv ident pass;wait -opn 2000" opn +After that you need to add your servers. For example:
@@ -295,7 +304,6 @@ first found bot in the list. If you don't need the bot masks (ie. the bot is always with the same nick, like chanserv) you can give only the -botcmd option and the command is always sent. -4. Setting up windows and automatically restoring them at startup
First connect to all the servers, join the channels and create the @@ -307,17 +315,18 @@ use commands:
/WINDOW ITEM MOVE <number>|<name> - move channel/query to another window
When everything looks the way you like, use /LAYOUT SAVE command -(and /SAVE, if you don't have autosaving enabled) and when you start -irssi next time, irssi remembers the positions of the channels, queries -and everything. This "remembering" doesn't mean that simply using -/LAYOUT SAVE would automatically make irssi reconnect to all servers -and join all channels, you'll need the /SERVER ADD -auto and /CHANNEL -ADD -auto commands to do that.
+When everything looks the way you like, use /LAYOUT SAVE
+command (and /SAVE
, if you don't have autosaving enabled) and
+when you start irssi next time, irssi remembers the positions of the
+channels, queries and everything. This "remembering" doesn't mean that
+simply using /LAYOUT SAVE
would automatically make irssi
+reconnect to all servers and join all channels, you'll need the
+/SERVER ADD -auto
and /CHANNEL ADD -auto
commands
+to do that.
If you want to change the layout, you just rearrange the layout like -you want it and use /LAYOUT SAVE again. If you want to remove the -layout for some reason, use /LAYOUT RESET.
+you want it and use/LAYOUT SAVE
again. If you want to remove
+the layout for some reason, use /LAYOUT RESET.
This doesn't have any effect until you restart irssi. If you want to -remove it immediately, just /WINDOW CLOSE it.
+remove it immediately, just/WINDOW CLOSE
it.
Another common window is "messages window", where all private messages go. By default it's disabled and query windows are created @@ -354,7 +363,7 @@ irssi. To create it immediately say:
Note that neither use_msgs_window nor use_status_window have any -effect at all if /LAYOUT SAVE has been used.
+effect at all if/LAYOUT SAVE
has been used.
This brings us to message levels.. What are they? All messages that irssi prints have one or more "message levels". Most common are PUBLIC @@ -385,9 +394,9 @@ how you do connect to new server without closing the old connection:
/CONNECT irc.server.org -Instead of the /SERVER which disconnects the existing connection. To -see list of all active connections, use /SERVER without any parameters. -You should see a list of something like:
+Instead of the /SERVER
which disconnects the existing
+connection. To see list of all active connections, use /SERVER<(code>
+without any parameters. You should see a list of something like:
-!- IRCNet: irc.song.fi:6667 (IRCNet) @@ -475,8 +484,8 @@ for each server. Here's how to do them (repeat for each server)-7. /LASTLOG and jumping around in scrollback
-/LASTLOG command can be used for searching texts in scrollback -buffer. Simplest usages are
+
/LASTLOG
command can be used for searching texts in +scrollback buffer. Simplest usages are/LASTLOG word - print all lines with "word" in them @@ -493,22 +502,24 @@ If you want to save the full lastlog to file, useWith -file option you don't need -force even if there's more than 1000 -lines. /LASTLOG has a lot of other options too, see /HELP lastlog for -details.
+lines. /LASTLOG has a lot of other options too, see/HELP +lastlog
for details.Once you've found the lines you were interested in, you might want -to check the discussion around them. Irssi has /SCROLLBACK (or alias -/SB) command for jumping around in scrollback buffer. Since /LASTLOG -prints the timestamp when the message was originally printed, you can -use /SB GOTO hh:mm to jump directly there. To get back to the bottom of -scrollback, use /SB END command.
+to check the discussion around them. Irssi has/SCROLLBACK
(or +alias/SB
) command for jumping around in scrollback buffer. +Since/LASTLOG
prints the timestamp when the message was +originally printed, you can use/SB GOTO hh:mm
to jump +directly there. To get back to the bottom of scrollback, use/SB +END
command.8. Logging
Irssi can automatically log important messages when you're set away -(/AWAY reason). When you set yourself unaway (/AWAY), the new messages -in away log are printed to screen. You can configure it with:
+(/AWAY reason
). When you set yourself unaway +(/AWAY
), the new messages in away log are printed to screen. +You can configure it with:/SET awaylog_level MSGS HILIGHT - Specifies what messages to log @@ -524,7 +535,8 @@ You can turn it on withBy default it logs pretty much everything execept CTCPS or CRAP -(/WHOIS requests, etc). You can specify the logging level yourself with
+(/WHOIS
requests, etc). You can specify the logging level +yourself with/SET autolog_level ALL -CRAP -CLIENTCRAP -CTCPS (this is the default) @@ -546,7 +558,8 @@ logs by adding date/time formats to the file name. The formats are in /SET autolog_path ~/irclogs/%Y/$tag/$0.%m-%d.log-For logging only some specific channels or nicks, see /HELP log
+For logging only some specific channels or nicks, see
/HELP +log
9. Changing keyboard bindings
@@ -556,33 +569,34 @@ about. It doesn't let irssi know everything, so for example shift-backspace can't be bound unless you modify xterm resources somehow. -/HELP bind tells pretty much everything there is to know about -keyboard bindings. However, there's the problem of how to bind some -non-standard keys. They might differ a bit with each terminal, so -you'll need to find out what exactly the keypress produces. Easiest -way to check that would be to see what it prints in "cat". Here's -an example for pressing F1 key:
+
/HELP bind
tells pretty much everything there is to know +about keyboard bindings. However, there's the problem of how to bind some +non-standard keys. They might differ a bit with each terminal, so you'll +need to find out what exactly the keypress produces. Easiest way to check +that would be to see what it prints incat
. Here's an example +for pressing F1 key:-[cras@hurina] ~% cat -^[OP + [cras@hurina] ~% cat + ^[OP-So in irssi you would use /BIND ^[OP /ECHO F1 pressed. If you use -multiple terminals which have different bindings for the key, it would -be better to use eg.:
+So in irssi you would use
/BIND ^[OP /ECHO F1
pressed. If +you use multiple terminals which have different bindings for the key, it +would be better to use eg.:-/BIND ^[OP key F1 -/BIND ^[11~ key F1 -/BIND F1 /ECHO F1 pressed. + /BIND ^[OP key F1 + /BIND ^[11~ key F1 + /BIND F1 /ECHO F1 pressed.10. Proxies and IRC bouncers
Irssi supports connecting to IRC servers via a proxy. All server connections are then made through it, and if you've set up everything -properly, you don't need to do any /QUOTE SERVER commands manually.
+properly, you don't need to do any/QUOTE SERVER
commands +manually.Here's an example: You have your bouncer (lets say, BNC or BNC-like) listening in irc.bouncer.org port 5000. You want to use it to connect @@ -608,12 +622,13 @@ about them:
/SERVER ADD -auto -ircnet efnet irc.efnet.org
With the proxy /SETs however, irssi now connects to those servers -through your BNC. All server connections are made through them so you -can just forget that your bouncer even exists.
+With the proxy /SET
s however, irssi now connects to those
+servers through your BNC. All server connections are made through them so
+you can just forget that your bouncer even exists.
If you don't want to use the proxy for some reason, there's -noproxy -option which you can give to /SERVER and /SERVER ADD commands.
+option which you can give to/SERVER
and /SERVER
+ADD
commands.
Proxy specific settings:
@@ -677,8 +692,8 @@ as with dircproxy, by creating fake connections: /SERVER ADD -auto -ircnet opn fake.opn 6667 opnpass -So, you'll specify the usernames with /IRCNET ADD command, and the -user's password with /SERVER ADD.
+So, you'll specify the usernames with /IRCNET ADD
command,
+and the user's password with /SERVER ADD
.
Irssi proxy
@@ -689,7 +704,10 @@ irssi in a screen to use it though.Irssi proxy is a bit different than most proxies, normally proxies create a new connection to IRC server when you connect to it, but irssi proxy shares your existing IRC connection(s) to multiple -clients.
+clients. And even more clearly: You can use only one IRC +server connection to IRC with as many clients as you want. Can +anyone figure out even more easier ways to say this, so I wouldn't need to +try to explain this thing for minutes every time? :)Irssi proxy supports sharing multiple server connections in different ports, like you can share ircnet in port 2777 and efnet in port 2778.
@@ -703,9 +721,9 @@ ports, like you can share ircnet in port 2777 and efnet in port 2778.NOTE: you MUST add all the servers you -are using to server and ircnet lists with /SERVER ADD and /IRCNET ADD. -..Except if you really don't want to for some reason, and you only use -one server connection, you may simply set:
+are using to server and ircnet lists with/SERVER ADD
and
+/IRCNET ADD
. ..Except if you really don't want to for some
+reason, and you only use one server connection, you may simply set:
/SET irssiproxy_ports *=2777 @@ -714,7 +732,7 @@ one server connection, you may simply set:Usage in client side:
Just connect to the irssi proxy like it is a normal server with password -specified in /SET irssiproxy_password. For example:
+specified in/SET irssiproxy_password
. For example:/SERVER ADD -ircnet ircnet my.irssi-proxy.org 2777 secret @@ -909,22 +927,21 @@ of them you might want to change (the default value is shown):12. Statusbar
-/STATUSBAR displays a list of statusbars:
+
/STATUSBAR
displays a list of statusbars:-Name Type Placement Position Visible -window window bottom 0 always -window_inact window bottom 1 inactive -prompt root bottom 100 always -topic root top 1 always + Name Type Placement Position Visible + window window bottom 0 always + window_inact window bottom 1 inactive + prompt root bottom 100 always + topic root top 1 always-/STATUSBAR <name> prints the statusbar -settings and it's items. /STATUSBAR <name> -ENABLE|DISABLE enables/disables the statusbar. -/STATUSBAR <name> RESET resets the statusbar to -it's default settings, or if the statusbar was created by you, it will be -removed.
+
/STATUSBAR <name>
prints the statusbar settings and +it's items./STATUSBAR <name> ENABLE|DISABLE
+enables/disables the statusbar./STATUSBAR <name> RESET
+resets the statusbar to it's default settings, or if the statusbar was +created by you, it will be removed.Type can be window or root, meaning if the statusbar should be created for each split window, or just once. Placement can be top or @@ -951,5 +968,5 @@ where you want to show it. Statusbar items can be modified with:
The item name with statusbar scripts is usually same as the script's name. Script's documentation should tell if this isn't the case. So, to add mail.pl before the window activity item (see the list with -/STATUSBAR window), use: /STATUSBAR window ADD -before act -mail.
+/STATUSBAR
window), use:/STATUSBAR window ADD -before +act mail
.