> ## Documentation Index
> Fetch the complete documentation index at: https://docs.razebot.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Syntax

> General explanation of how to format durations, entries, and flags in commands.

# Syntax

> General explanation of how to format durations, entries, and flags in commands.

## Formatting a duration

Some commands require a `duration` parameter, which should be written as a number followed by a time unit. Here are the supported units:

| Unit | Meaning |
| ---- | ------- |
| `s`  | seconds |
| `m`  | minutes |
| `h`  | hours   |
| `d`  | days    |
| `w`  | weeks   |

Multiple units can be combined. For example, `1w2d` means one week and two days.

```bash theme={null} theme={null}
Syntax:  ;timeout (member) (duration) (reason)
Correct: ;timeout @wanderer 1h spamming
Correct: ;timeout @wanderer 2d3h repeated violations
Wrong:   ;timeout @wanderer 1 hour
Wrong:   ;timeout @wanderer 2 days 3 hours
```

## Removing entries by ID

Commands that have `list` and `remove` subcommands support removal by entry ID:

1. Run the `list` subcommand to find the entry ID
2. Remove it using `select:ID`

```bash theme={null} theme={null}
;automod list
;automod remove select:3
```

## Flag punishments

The `--do` flag specifies what action to take when a rule is triggered. Available options:

| Flag         | Action                              |
| ------------ | ----------------------------------- |
| `warn`       | Issues the user a warning           |
| `jail`       | Restricts the user's channel access |
| `kick`       | Removes the user from the server    |
| `ban`        | Permanently bans the user           |
| `delete`     | Removes the offending message       |
| `stripstaff` | Removes staff roles (antinuke only) |

<Warning>
  Use `--` (double dash) not `—` (em dash). An em dash will not be recognised by the bot.
</Warning>

```bash theme={null} theme={null}
;automod words add badword --do delete
;automod spam threshold 5 --do kick
```

## Command syntax conventions

Throughout this documentation, parameters are written as follows:

| Format        | Meaning                   |
| ------------- | ------------------------- |
| `(parameter)` | Required parameter        |
| `[parameter]` | Optional parameter        |
| `(a\|b\|c)`   | Choose one of the options |