summaryrefslogtreecommitdiff
path: root/docs/source/markdown/options
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-09-26 14:08:44 -0600
committerEd Santiago <santiago@redhat.com>2022-09-29 08:44:00 -0600
commit309f4fb543f47905c79261c19ca197b4a226abe4 (patch)
treefe325b3fa1f0cd534d09e9f958db0fb923636f8e /docs/source/markdown/options
parentf52feded3ce6c1ad2af046ab774fbc2b9c832487 (diff)
downloadpodman-309f4fb543f47905c79261c19ca197b4a226abe4.tar.gz
podman-309f4fb543f47905c79261c19ca197b4a226abe4.tar.bz2
podman-309f4fb543f47905c79261c19ca197b4a226abe4.zip
Man pages: refactor common options: --log-opt
Simple in reality, but hard to review due to lots of little diffs: - "Logging driver specific options" was only in podman-run; I added it to create and kube-play. - whitespace changes, the 'e.g.'s got consistent 4-space indentation - the "same keys" and "supported only" sentences, I moved up to be closer to **tag** and without intervening whitespace, because they were unclear as they were: I believe the intent is to apply those sentences only to **tag**, not to the **--log-opt** option itself. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/options')
-rw-r--r--docs/source/markdown/options/log-opt.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/source/markdown/options/log-opt.md b/docs/source/markdown/options/log-opt.md
new file mode 100644
index 000000000..4eafc1fb0
--- /dev/null
+++ b/docs/source/markdown/options/log-opt.md
@@ -0,0 +1,16 @@
+#### **--log-opt**=*name=value*
+
+Logging driver specific options.
+
+Set custom logging configuration. The following *name*s are supported:
+
+**path**: specify a path to the log file
+ (e.g. **--log-opt path=/var/log/container/mycontainer.json**);
+
+**max-size**: specify a max size of the log file
+ (e.g. **--log-opt max-size=10mb**);
+
+**tag**: specify a custom log tag for the container
+ (e.g. **--log-opt tag="{{.ImageName}}"**.
+It supports the same keys as **podman inspect --format**.
+This option is currently supported only by the **journald** log driver.