How to use this manual
Contents
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.
- Required arguments
- The list of required parameters and their syntax.
- Optional arguments
- The list of optional parameters and their syntax.
- 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:
This documentation applies to the following versions of Splunk: 4.1 , 4.1.1 , 4.1.2 , 4.1.3 , 4.1.4 , 4.1.5 , 4.1.6 , 4.1.7 , 4.1.8 , 4.2 , 4.2.1 , 4.2.2 , 4.2.3 , 4.2.4 , 4.2.5 , 4.3 , 4.3.1 , 4.3.2 View the Article History for its revisions.