How to use this manual

How to use this manual

This manual serves as a reference guide for the Splunk user who is looking for a catalog of the search commands with complete syntax, descriptions, and examples for usage.

Layout for each topic

Each search command topic contains the following headers: synopsis, description, examples, and see also.

Synopsis

The synopsis includes a short description of each search command, the complete syntax for each search command, and a description for each argument. If the arguments have another hierarchy of options, each of these sets of options follow the argument descriptions.

Description

The description includes details about how to use the search command.

Examples

This section lists examples of usage for the search command.

See also

This sections lists and links to all related or similar search commands.

Conventions used to describe syntax

The syntax for each search command is defined under the "Synopsis".

Important: The arguments in the syntax are presented in the order they are meant to be used.

Conventions used to describe arguments

Each of the arguments included in the search command syntax are listed alphabetically and defined as follows: