doc: update darkirc private messages section

This commit is contained in:
dasman
2024-06-12 02:29:09 +03:00
parent 2bdb1b8cf9
commit 8fcdd85673

View File

@@ -12,14 +12,16 @@ when you first run `darkirc`.
Generate a keypair using the following command:
```shell
% darkirc --gen-keypair
% darkirc --gen-chacha-keypair
```
This will generate a Public Key and a Private Key.
Save the Private key safely & add it to the `darkirc_config.toml` file as shown below.
Save the Private key safely & add it to the `darkirc_config.toml`
file under [crypto] as shown below.
```toml
[private_key.your_private_key_goes_here]
[crypto]
dm_chacha_secret.your_private_key_goes_here
```
To share your Public Key with a user over `darkirc` you can use one of the
@@ -40,22 +42,20 @@ privately chat after they have each other's public keys:
Alice would add bob to her contact list in her own config file:
```toml
[contact.bob]
contact_pubkey = D6UzKA6qCG5Mep16i6pJYkUCQcnp46E1jPBsUhyJiXhb
dm_chacha_public = D6UzKA6qCG5Mep16i6pJYkUCQcnp46E1jPBsUhyJiXhb
```
And Bob would do the same:
```toml
[contact.alice]
contact_pubkey = 9sfMEVLphJ4dTX3SEvm6NBhTbWDqfsxu7R2bo88CtV8g
dm_chacha_public = 9sfMEVLphJ4dTX3SEvm6NBhTbWDqfsxu7R2bo88CtV8g
```
Lets see an Example where 'alice' sends “Hi” message to 'bob' using
the /msg command
/msg bob Hi
```
/msg bob Hi
```
<u>Note for Weechat Client Users:</u>\
When you private message someone as shown above, the buffer will not
@@ -66,16 +66,16 @@ the recent message which she just send to 'bob' until 'bob' replies,
but 'bob' will get a buffer shown on his irc client with the message 'Hi'.
Reply from 'bob' to 'alice'
/msg alice welcome!
```
/msg alice welcome!
```
Or instead of `/msg` command, you can use:
```
/query bob hello
```
This works exactly the same as `/msg` except it will open a new buffer
with Bob in your client regardless.
with Bob in your client regardless of sending a msg or not.
<u><b>Note</b></u>: The contact name is not the irc nickname, it can
be anything you want, and you should use it when DMing.
@@ -84,6 +84,6 @@ be anything you want, and you should use it when DMing.
case you lost your Public Key and you still have your Private key in
`darkirc_config.toml` file, you recover the Public Key like so:
```shell
% darkirc --recover-pubkey {your_private_key}
% darkirc --get_chacha_pubkey <chacha-secret>
```