ubottu/USAGE.md

85 lines
2.7 KiB
Markdown
Raw Normal View History

2024-03-25 21:47:44 +00:00
# Ubottu Commands
This documentation outlines the usage of commands supported by the bot. The bot reacts to commands prefixed with `!`. Below are the available commands and their descriptions:
## Factoids / Facts
This is a dynamic list of replies.
2024-03-30 23:23:16 +00:00
The available facts are available at [here](https://maubot.haxxors.com/factoids/). You can make [suggestions](https://cloud.haxxors.com/s/CqfdcDAQWEWE8R3) for additional facts.
2024-03-25 21:47:44 +00:00
2024-03-27 13:40:05 +00:00
**Usage**: `!fact_name [| username])`
2024-03-27 13:39:39 +00:00
2024-03-27 13:32:24 +00:00
**Example 1**:`!noble`
2024-03-27 13:39:39 +00:00
2024-03-27 13:40:28 +00:00
**Response**: `Ubuntu 24.04 (Noble Numbat) will be the 40th release of...`
2024-03-25 21:47:44 +00:00
**Example 2**: `!noble | Bob`
2024-03-27 13:39:39 +00:00
2024-03-27 13:32:24 +00:00
**Response**: `Bob: Ubuntu 24.04 (Noble Numbat) will be the 40th...`
2024-03-25 21:47:44 +00:00
2024-04-06 23:58:56 +00:00
### Placeholders
Facts can include placeholders. Currently supported are:
- Members of Launchpad groups:
- List of moderators and admins in a room
Both can be combined. If a group includes other teams there is no recursion.
**Example**: `We need help here Defenders! {launchpad_group.matrix-defenders} {moderators}`
**Response**: `We need help here Defenders! [matrix-defenders-member1} [matrix-defenders-member2] [...] [room-admin1] [room-moderator1]`
2024-03-27 13:22:33 +00:00
## Launchpad Bugs
The bot reacts to URLs from bugs.launchpad.net and to "bug [#]bugnumber" in messages.
2024-03-27 13:41:32 +00:00
**Example 1**: `got this issue right now https://bugs.launchpad.net/snapd/+bug/2052688 on my computer`
2024-03-27 13:39:39 +00:00
2024-03-27 13:41:32 +00:00
**Example 2**: `i am affected by bug 2052688 on my computer`
2024-03-27 13:39:39 +00:00
2024-03-27 13:41:32 +00:00
**Example 3**: `i am affected by bug #2052688 on my computer`
2024-03-27 13:39:39 +00:00
2024-03-27 13:41:32 +00:00
**Response**: `Launchpad Bug #2052688 in snapd "run-snapd-ns-snapd\x2ddesktop [...] " [Undecided, New]`
2024-03-27 13:22:33 +00:00
2024-03-25 21:47:44 +00:00
## Time Commands
### `!time <city>`
Retrieves the current local time for a specified city.
**Usage**: `!time city_name`
2024-03-27 13:39:39 +00:00
2024-03-27 13:32:24 +00:00
**Example**:!time duesseldorf **Response**: The current time in Düsseldorf, Nordrhein-Westfalen, Deutschland is Friday, 22 March 2024, 19:59`
2024-03-25 21:47:44 +00:00
### `!utc`
Retrieves the current time in UTC timezone, displayed as the local time in London.
**Usage**: `!utc`
2024-03-27 13:39:39 +00:00
2024-03-25 21:47:44 +00:00
**Response**: `The current time in London, Greater London, England, United Kingdom is Friday, 22 March 2024, 19:00`
## Package Commands
### `!package <package_name> [<distribution>]`
Fetches package information for a specified package name and distribution.
The distribution argument is optional and defaults to "noble".
**Usage**:`!package package_name distribution`
2024-03-27 13:39:39 +00:00
2024-03-25 21:47:44 +00:00
**Example**:`!package nano jammy`
2024-03-27 13:39:39 +00:00
2024-03-25 21:47:44 +00:00
**Response**: `nano (6.2-1, jammy): Depends on libc6 (>= 2.34), libncursesw6 (>= 6), libtinfo6 (>= 6)`
### `!depends <package_name>`
Retrieves the dependencies of the specified package name, typically from the latest distribution.
**Usage**: `!depends package_name`
2024-03-27 13:39:39 +00:00
2024-03-25 21:47:44 +00:00
**Example**: `!depends nano`
2024-03-27 13:32:24 +00:00
2024-03-27 13:39:39 +00:00
**Response**: `nano (7.2-2, noble): Depends on libc6 (>= 2.38), libncursesw6 (>= 6), libtinfo6 (>= 6)`nano (7.2-2, noble)`