From c904cd0bd7e73b2deebb416cb1e823ed2a39036b Mon Sep 17 00:00:00 2001 From: TerryHowe Date: Wed, 13 May 2015 14:17:40 -0600 Subject: [PATCH] Add some docs for list value formatter Change-Id: Ifd27e397d186ea36e04c9f342ba30cdf728101bd --- doc/source/list_commands.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/doc/source/list_commands.rst b/doc/source/list_commands.rst index 2be64e72..e2cda76c 100644 --- a/doc/source/list_commands.rst +++ b/doc/source/list_commands.rst @@ -63,6 +63,33 @@ for human consumption. | source | 408 | +---------------+------+ +value +----- + +The ``value`` formatter produces a space separated output with no headers. + +:: + + (.venv)$ cliffdemo files -f value + build 136 + cliffdemo.log 2690 + Makefile 5569 + source 408 + +This format can be very convenient when you want to pipe the output to +a script. + +:: + + (.venv)$ cliffdemo files -f value | while read NAME SIZE + do + echo $NAME is $SIZE bytes + done + build is 136 bytes + cliffdemo.log is 2690 bytes + Makefile is 5569 bytes + source is 408 bytes + Other Formatters ----------------