diff options
| author | Jenkins <jenkins@review.openstack.org> | 2015-06-08 15:18:43 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2015-06-08 15:18:43 +0000 |
| commit | bff7d6bfd6ae1fc9e54c5604d97f89cc84ed7d1b (patch) | |
| tree | 0b561d54fad12f1a9fbd557be5fc524193e57512 | |
| parent | e030f5e2c72b7675dc743b0263f7c3816f274c7b (diff) | |
| parent | c904cd0bd7e73b2deebb416cb1e823ed2a39036b (diff) | |
| download | cliff-1.13.0.tar.gz | |
Merge "Add some docs for list value formatter"1.13.0
| -rw-r--r-- | doc/source/list_commands.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/source/list_commands.rst b/doc/source/list_commands.rst index 2be64e7..e2cda76 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 ---------------- |