# bsdirc quick start

From nothing to sitting in your channels in five minutes. The full
manual is README.md.

## 1. Build and start

    $ tar xzf bsdirc-0.9.tar.gz
    $ cd bsdirc
    $ make
    $ doas make install
    $ bsdirc

Settings live in `~/.bsdirc/config`. You never have to edit it: every
command below saves what it changes.

## 2. Add a network

Libera.Chat, with TLS and SASL login:

    /server add libera irc.libera.chat 6697 -sasl -auto
    /server set libera account YOURACCOUNT
    /server set libera password YOURPASSWORD
    /connect libera

QuakeNet, logging in to Q (hides your host with +x):

    /server add quakenet se.quakenet.org 6667 -qauth -auto
    /server set quakenet account YOURACCOUNT
    /server set quakenet password YOURPASSWORD
    /connect quakenet

Your nick is your login name by default. To change it:

    /server set libera nick yournick

`-auto` connects at startup. Leave out `-sasl` or `-qauth` if you
have no account.

## 3. Join channels and keep them

    /join #openbsd
    /join #runbsd
    /autojoin save

`/autojoin save` remembers every channel you are in now, so they are
joined again next time, in the same window order.

## 4. Moving around

| Key | Does |
|---|---|
| Alt-1 ... Alt-9, Alt-0 | window 1 to 10 (or Esc then the digit) |
| Alt-a | next window with something new |
| PgUp / PgDn | scroll |
| Tab | complete nicks, channels and commands |
| Alt-s / Alt-n | hide or show the window list / nick list |
| Alt-l | plain text view, for copying and clicking links |

In the window list: grey means nothing new, white means someone
wrote, red means you were mentioned or got a private message.

## 5. Everyday commands

    /msg nick text      private message (opens a window)
    /me waves           action
    /url                last links in this channel; /url 1 shows one whole
    /away gone          away on all networks; /away to come back
    /close              close the window
    /quit               leave

## 6. Run it in tmux

    $ tmux new -s irc bsdirc

Detach with Ctrl-b d and come back with `tmux attach -t irc`. When you
detach, bsdirc goes to window 1 and sets you away after 10 minutes;
it removes away when you attach again. To start it at boot, add this
with `crontab -e`:

    @reboot /usr/bin/tmux new -d -s irc /usr/local/bin/bsdirc

## 7. Make it yours

    /set theme irssi    blue bars like irssi (default, irssi or bw)
    /set backlog 100    log lines shown when a window opens (0 = off)
    /ignore troll       ignore a person, nick and host
    /ignore #big joins parts quits    quiet a busy channel

Type `/help` for everything else.