diff --git a/README.rst b/README.rst index eb8b64a..5743e27 100644 --- a/README.rst +++ b/README.rst @@ -7,6 +7,11 @@ Docker Custodian Keep docker hosts tidy. +.. contents:: + :backlinks: none + + + dcgc ---- @@ -21,6 +26,8 @@ Maximum age can be specificied with any format supported by Example: +.. code:: sh + dcgc --max-container-age 3days --max-image-age 30days @@ -31,6 +38,8 @@ Prevent images from being removed to keep around forever you can use the exclude list to prevent them from being removed. +:: + --exclude-image Never remove images with this tag. May be specified more than once. @@ -51,4 +60,6 @@ with `--prefix` and it has been running for longer than `--max-run-time`. Example: +.. code:: sh + dcstop --max-run-time 2days --prefix "projectprefix_"