emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Docs: improve irc documentation

Browse source 
Explain how `+pass-user-fields` works and show a basic example for
configuring a pass entry to be used by circe.

Show how to connect to IRC and show a list of commands that can be used
in circe buffers.
This commit is contained in:
Mark Redeman 2018-06-23 15:28:27 +02:00
parent 7a6407eb92
commit e8834710c2
No known key found for this signature in database
GPG key ID: E555FD0E65FF9E9E
1 changed files with 36 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

40
modules/app/irc/README.org
View file

@ -3,10 +3,12 @@
This module turns adds an IRC client to Emacs ([[https://github.com/jorgenschaefer/circe][~circe~)]] with native notifications ([[https://github.com/eqyiel/circe-notifications][circe-notifications]]).
* Table of Contents :TOC:
- [[#dependencies][Dependencies]]
- [[#configure][Configure]]
- [[#pass-the-unix-password-manager][Pass: the unix password manager]]
- [[#emacs-auth-source-api][Emacs' auth-source API]]
- [[Dependencies][Dependencies]]
- [[Configure][Configure]]
- [[Pass: the unix password manager][Pass: the unix password manager]]
- [[Emacs' auth-source API][Emacs' auth-source API]]
- [[Appendix][Appendix]]
- [[Commands][Commands]]
* Dependencies
This module has no dependencies, besides =gnutls-cli= or =openssl= for secure connections.
@ -52,6 +54,15 @@ But wait, there's more! This stores your password in a public variable which cou
And you're good to go!
Note that =+pass-get-user= tries to find your username by looking for the fields
listed in =+pass-user-fields= (by default =login=, =user==, =username== and =email=)=).
An example configuration looks like
#+BEGIN_SRC txt :tangle no
mysecretpassword
username: myusername
#+END_SRC
** Emacs' auth-source API
~auth-source~ is built into Emacs. As suggested [[https://github.com/jorgenschaefer/circe/wiki/Configuration#safer-password-management][in the circe wiki]], you can store (and retrieve) encrypted passwords with it.
@ -78,3 +89,24 @@ And you're good to go!
:channels ("#emacs")))
#+END_SRC
* Appendix
** Commands
Here is a list of available commands, their default keybindings (defined in
[[../../private/default/+bindings.el][private/default/+bindings.el]]), and corresponding ex commands (if any -- defined
in [[../../private/default/+evil-commands.el][private/default/+evil-commands.el]]).
| command | key | description |
|---------+-----------+-------------------------------------------|
| ~=irc~ | =SPC o I= | Connect to IRC and all configured servers |
When in a circe buffer these keybindings will be available.
| command | key | description |
|------------------------+-----------+----------------------------------------------|
| ~tracking-next-buffer~ | =SPC m a= | Switch to the next active buffer |
| ~circe-command-JOIN~ | =SPC m j= | Join a channel |
| ~+irc/send-message~ | =SPC m m= | Send a private message |
| ~circe-command-NAMES~ | =SPC m n= | List the names of the current channel |
| ~circe-command-PART~ | =SPC m p= | Part the current channel |
| ~+irc/quit~ | =SPC m Q= | Kill the current circe session and workgroup |
| ~circe-reconnect~ | =SPC m R= | Reconnect the current server |