spacemacs/contrib/irc/erc/README.md

47 lines
1.4 KiB
Markdown
Raw Normal View History

2015-03-25 03:34:19 +00:00
# ERC contribution layer for Spacemacs
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
**Table of Contents**
- [ERC contribution layer for Spacemacs](#erc-contribution-layer-for-spacemacs)
- [Description](#description)
- [Install](#install)
- [Key bindings](#key-bindings)
<!-- markdown-toc end -->
## Description
Basic layer for ERC.
TBD:
- show mode-line tracking of active channels (so that you know when to <kbd>C-c C-SPC</kbd> or it's equivalent evil-ized shortcut)
- evil-ized keyboard shortcuts
- documentation on storing credentials and preferred channels list
## Install
To use this contribution add it to your `~/.spacemacs`
```elisp
(setq-default dotspacemacs-configuration-layers '(erc))
```
## Key bindings
Key Binding | Description
--------------|------------------------------------------------------------
`<SPC> a i e` | Starts ERC
`<SPC> a i E` | Starts ERC via TLS/SSL
`<SPC> m b` | Switch between ERC buffers
`<SPC> m d` | Interactively input a user action and send it to IRC.
`<SPC> m j` | Join a channel, executes the /join command
2015-04-08 22:54:34 +00:00
`<SPC> m n` | Run "/names #channel" in the current channel.
`<SPC> m l` | Run the /list command
`<SPC> m p` | Part from the channel
`<SPC> m q` | Quit server
**Note** If you want to connect securely to an IRC server, you must run
`erc-tls` command on <kbd>SPC a i E</kbd> instead of the `erc` command.