help

Use the help command to return information about one or more ADEdit commands. It’s followed by a command pattern that is either the name of a single ADEdit command or a string with wild cards that specifies multiple possible commands. The command pattern can also be a command abbreviation.

The command pattern wild cards are:

  • ? for a single character
  • * for multiple characters

Zone type

Not applicable

Syntax

help command_pattern

Abbreviation

h

Options

This command takes no options.

Arguments

This command takes the following argument:

Argument Type Description

command_pattern

string

Required. Specifies the name of one or more ADEdit commands for which to return information.

You can specify a command name, command shortcut or use the ? and * wild cards to specify a single character or multiple characters respectively.

Return value

This command returns information for the specified command or commands. If there’s no match for the command_pattern you specify, the command returns nothing.

Examples

help explain_sd

This example returns information for the explain_sd command.

help ?et*

This example returns information for the ADEdit commands that start with get or set, such as get_zones, get_zone_field, set_zone_field, and set_role_field.

Related commands

None.