command.md

title	EXAMPLE IRC Command
ntitle	EXAMPLE
nsub	Does whatever's described on this page
layout	command
command	EXAMPLE
command-groups	any applicable groups
numerics	001 002 003
format	EXAMPLE [<format>] <goes> <here>
examples	desc content First example C -> EXAMPLE works like this S <- :irc.example.com 001 .. .. .. desc content Second example C -> example also :works in this way S <- :irc.example.com 002 .. .. .. S <- :irc.example.com 003 .. .. ..
supported-by-default	true
supported-by	unreal inspircd hybrid true true true
contributors	doaks

The EXAMPLE command does whatever's described here. This is a one-paragraph explanation of the command, before the text below dives into specifics.

---

{% include command-format-header.html %}

• <format>: This is an optional parameter that indicates A, B, and C.
• <goes>: This is a mandatory parameter that indicates D, E, and F.
• <here>: This is a mandatory parameter that indicates X, Y, and Z.

If the user doesn't have the permission to run this command, the ERR_BLAHBLAH response is sent and the command fails.

If the <format> parameter is omitted, the server assumes that the target is the user who sent the command.

If the command is successful, the server sends a NOTE back to the user (as shown in the examples below).

This section describes, in detail, how the command responds in each case, and what each parameter means (along with whether those parameters are optional or mandatory).