Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MemoServ guide #378

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions content/_guides/memo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
---
title: Sending memos
category: using
weight: 61
---

Libera.chat supports sending memos to users or channels using MemoServ. Memos

Check failure on line 7 in content/_guides/memo.md

View workflow job for this annotation

GitHub Actions / Check markdown for style issues

Proper names should have the correct capitalization [Expected: Libera.Chat; Actual: Libera.chat]
may be sent to users or channels. You may send memos to offline users for them
to read when they come online.

Both the sender's nick and the target nick or channel name must be registered.
See [Nickname registration]({% link _guides/registration.md %}) for more
information.

## Sending a memo

To send a memo, run the following command in your IRC client:

```

Check failure on line 19 in content/_guides/memo.md

View workflow job for this annotation

GitHub Actions / Check markdown for style issues

Fenced code blocks should have a language specified [Context: "```"]
/msg MemoServ SEND <nick/#channel> <memo text>
```

If you send a memo to a channel, all users in the channel receive the memo in
glguy marked this conversation as resolved.
Show resolved Hide resolved
their memo list.

If you allowed to view the access list for a channel, you can send a message
to the channel operators by running the following command in your IRC client:

```

Check failure on line 29 in content/_guides/memo.md

View workflow job for this annotation

GitHub Actions / Check markdown for style issues

Fenced code blocks should have a language specified [Context: "```"]
/msg MemoServ SENDOPS <#channel> <memo text>
```

## Listing memos

You can display a list of memos in your inbox by running the following command
in your IRC client:

```

Check failure on line 38 in content/_guides/memo.md

View workflow job for this annotation

GitHub Actions / Check markdown for style issues

Fenced code blocks should have a language specified [Context: "```"]
/msg MemoServ LIST
```

MemoServ returns a list of all memos in your inbox along with information
about who sent the memo and when it was sent. Each memo is identified by a
number.

## Reading memos

To read your new memos, run the following command in your IRC client:

```

Check failure on line 50 in content/_guides/memo.md

View workflow job for this annotation

GitHub Actions / Check markdown for style issues

Fenced code blocks should have a language specified [Context: "```"]
/msg MemoServ READ NEW
```

MemoServ responds with a list of all unread memo contents.

To read a specific memo, [find the memo number](#listing-memos) and run the
following command in your IRC client:

```

Check failure on line 59 in content/_guides/memo.md

View workflow job for this annotation

GitHub Actions / Check markdown for style issues

Fenced code blocks should have a language specified [Context: "```"]
/msg MemoServ READ <memo number>
```

MemoServ responds with the content of the selected memo.

## Forwarding memos

You can forward memos to other users. The recipient nick must be registered on
Libera.chat.

Check failure on line 68 in content/_guides/memo.md

View workflow job for this annotation

GitHub Actions / Check markdown for style issues

Proper names should have the correct capitalization [Expected: Libera.Chat; Actual: Libera.chat]

To forward a memo, [find the memo number](#listing-memos) and run the
following command in your IRC client:

```

Check failure on line 73 in content/_guides/memo.md

View workflow job for this annotation

GitHub Actions / Check markdown for style issues

Fenced code blocks should have a language specified [Context: "```"]
/msg MemoServ FORWARD <nick> <memo number>
```

## Deleting memos

To delete a memo from your list, [find the memo number](#listing-memos) and
run the following command in your IRC client:

```

Check failure on line 82 in content/_guides/memo.md

View workflow job for this annotation

GitHub Actions / Check markdown for style issues

Fenced code blocks should have a language specified [Context: "```"]
/msg MemoServ DELETE <memo number>
```

When you delete a memo, all memo numbers change to account for the deleted
memo. Make sure to [list memos again](#listing-memos) before deleting another
memo.

To delete all memos in your memo list, run the following command
in your IRC client:

```

Check failure on line 93 in content/_guides/memo.md

View workflow job for this annotation

GitHub Actions / Check markdown for style issues

Fenced code blocks should have a language specified [Context: "```"]
/msg MemoServ DELETE ALL
```

To delete all read (old) memos in your memo list, run the following command in
your IRC client:

```
/msg MemoServ DELETE OLD
```

## Ignoring memos from users
glguy marked this conversation as resolved.
Show resolved Hide resolved

If you don't want to receive memos from a specific user, you can add them to
your ignore list. You can add up to 40 users to your ignore list.

To add a new user to your ignore list, run the following command in your IRC
client:

```
/msg MemoServ IGNORE ADD <nick>
```

To remove a user from your ignore list, run the following command
in your IRC client:

```
/msg MemoServ IGNORE DEL <nick>
```

To return the whole list of users on your ignore list, run the following
command in your IRC client:

```
/msg MemoServ IGNORE LIST
```

To remove all users from your ignore list, run the following command in your IRC client:

```
/msg MemoServ IGNORE CLEAR
```
Loading