command.md

title	ntitle	nsub	layout	command	command-groups	numerics	format	examples	supported-by-default	supported-by	contributors
EXAMPLE IRC Command	EXAMPLE	Does whatever's described on this page	command	EXAMPLE	any applicable groups	001 002 003	EXAMPLE [<format>] <goes> <here>	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 .. .. ..	true	unreal inspircd hybrid true true true	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).