[pve-docs.git] / output-format.adoc

ifndef::manvolnum[]
Output format options `[FORMAT_OPTIONS]`
---------------------------------------
endif::manvolnum[]
ifdef::manvolnum[]
FORMAT_OPTIONS
--------------
endif::manvolnum[]

It is possible to specify the output format using the
`--output-format` parameter. The default format 'text' uses ASCII-art
to draw nice borders around tables. It additionally transforms some
values into human-readable text, for example:

- Unix epoch is displayed as ISO 8601 date string.
- Durations are displayed as week/day/hour/minute/second count, i.e `1d 5h`.
- Byte sizes value include units (`B`, `KiB`, `MiB`, `GiB`, `TiB`, `PiB`).
- Fractions are display as percentage, i.e. 1.0 is displayed as 100%.

You can also completely suppress output using option `--quiet`.


include::output-format-opts.adoc[]
Commit	Line	Data
	1	ifndef::manvolnum[]
	2	Output format options `[FORMAT_OPTIONS]`
	3	---------------------------------------
	4	endif::manvolnum[]
	5	ifdef::manvolnum[]
	6	FORMAT_OPTIONS
	7	--------------
	8	endif::manvolnum[]
	9
	10	It is possible to specify the output format using the
	11	`--output-format` parameter. The default format 'text' uses ASCII-art
	12	to draw nice borders around tables. It additionally transforms some
	13	values into human-readable text, for example:
	14
	15	- Unix epoch is displayed as ISO 8601 date string.
	16	- Durations are displayed as week/day/hour/minute/second count, i.e `1d 5h`.
	17	- Byte sizes value include units (`B`, `KiB`, `MiB`, `GiB`, `TiB`, `PiB`).
	18	- Fractions are display as percentage, i.e. 1.0 is displayed as 100%.
	19
	20	You can also completely suppress output using option `--quiet`.
	21
	22
	23	include::output-format-opts.adoc[]