Back to dev
[project/drush.git] / docs / output-formats.html
1 <h1>Drush Output Formats</h1>
2 <p>
3 Many Drush commands produce output that may be rendered in a variety
4 of different ways using a pluggable formatting system.  Drush commands
5 that support output formats will show a --format option in their
6 help text.  The available formats are also listed in the help text,
7 along with the default value for the format option.  The list of formats
8 shown is abbreviated; to see the complete list of available formats, run
9 the help command with the --verbose option.
10 <p>
11 The --pipe option is a quick, consistent way to get machine readable
12 output from a command, in whatever way the command author thought was
13 helpful. The --pipe option is equivalent to using --format=&lt;pipe-format&gt;
14 The pipe format will be shown in the options section of the command help,
15 under the --pipe option. For historic reasons, --pipe also hides all log
16 messages.
17 <p>
18 To best understand how the various Drush output formatters work,
19 it is best to first look at the output of the command using the
20 'var_export' format.  This will show the result of the command using
21 the exact structure that was built by the command, without any
22 reformatting.  This is the "standard format" for the Drush command.
23 Different formatters will take this information and present it in
24 different ways.
25
26 <h2>Global Options</h2>
27 <ul>
28     <li>--list-separator: Specify how elements in a list should be separated. In lists of lists, this applies to the elements in the inner lists.</li>
29     <li>--line-separator: In nested lists of lists, specify how the outer lists ("lines") should be separated.</li>
30 </ul>
31 <h2>Output Formats</h2>
32 <p>
33 A list of available formats, and their affect on the output of
34 certain Drush commands, is shown below.