From 52b92023edeba3a5e2c466d92d742e54b14a85cb Mon Sep 17 00:00:00 2001
From: baude <bbaude@redhat.com>
Date: Thu, 24 Oct 2019 14:54:57 -0500
Subject: Restructure documentation dir

Restructuring the docs dir to make integration with sphinx easier.  man
pages now exist in docs/source/man and the sphinx make files exists in
docs.

Signed-off-by: baude <bbaude@redhat.com>
---
 docs/source/man/podman-info.1.md | 151 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 151 insertions(+)
 create mode 100644 docs/source/man/podman-info.1.md

(limited to 'docs/source/man/podman-info.1.md')

diff --git a/docs/source/man/podman-info.1.md b/docs/source/man/podman-info.1.md
new file mode 100644
index 000000000..9721755ef
--- /dev/null
+++ b/docs/source/man/podman-info.1.md
@@ -0,0 +1,151 @@
+% podman-info(1)
+
+## NAME
+podman\-info - Displays Podman related system information
+
+## SYNOPSIS
+**podman info** [*options*]
+
+**podman system info** [*options*]
+
+## DESCRIPTION
+
+Displays information pertinent to the host, current storage stats, configured container registries, and build of podman.
+
+
+## OPTIONS
+
+**-D**, **--debug**
+
+Show additional information
+
+**-f**, **--format**=*format*
+
+Change output format to "json" or a Go template.
+
+
+## EXAMPLE
+
+Run podman info with plain text response:
+```
+$ podman info
+host:
+  BuildahVersion: 1.4-dev
+  Conmon:
+    package: Unknown
+    path: /usr/libexec/podman/conmon
+    version: 'conmon version 1.12.0-dev, commit: d724f3d54ad2d95b6de741085d4990190ebfd7ff'
+  Distribution:
+    distribution: fedora
+    version: "28"
+  MemFree: 1271083008
+  MemTotal: 33074233344
+  OCIRuntime:
+    package: runc-1.0.0-51.dev.gitfdd8055.fc28.x86_64
+    path: /usr/bin/runc
+    version: 'runc version spec: 1.0.0'
+  SwapFree: 34309664768
+  SwapTotal: 34359734272
+  arch: amd64
+  cpus: 8
+  hostname: localhost.localdomain
+  kernel: 4.18.7-200.fc28.x86_64
+  os: linux
+  uptime: 218h 49m 33.66s (Approximately 9.08 days)
+registries:
+  blocked: null
+  insecure: null
+  search:
+  - quay.io
+  - registry.fedoraproject.org
+  - docker.io
+  - registry.redhat.io
+store:
+  ConfigFile: /etc/containers/storage.conf
+  ContainerStore:
+    number: 37
+  GraphDriverName: overlay
+  GraphOptions:
+  - overlay.mountopt=nodev
+  - overlay.override_kernel_check=true
+  GraphRoot: /var/lib/containers/storage
+  GraphStatus:
+    Backing Filesystem: extfs
+    Native Overlay Diff: "true"
+    Supports d_type: "true"
+  ImageStore:
+    number: 17
+  RunRoot: /var/run/containers/storage
+
+```
+Run podman info with JSON formatted response:
+```
+{
+    "host": {
+        "BuildahVersion": "1.4-dev",
+        "Conmon": {
+            "package": "Unknown",
+            "path": "/usr/libexec/podman/conmon",
+            "version": "conmon version 1.12.0-dev, commit: d724f3d54ad2d95b6de741085d4990190ebfd7ff"
+        },
+        "Distribution": {
+            "distribution": "fedora",
+            "version": "28"
+        },
+        "MemFree": 1204109312,
+        "MemTotal": 33074233344,
+        "OCIRuntime": {
+            "package": "runc-1.0.0-51.dev.gitfdd8055.fc28.x86_64",
+            "path": "/usr/bin/runc",
+            "version": "runc version spec: 1.0.0"
+        },
+        "SwapFree": 34309664768,
+        "SwapTotal": 34359734272,
+        "arch": "amd64",
+        "cpus": 8,
+        "hostname": "localhost.localdomain",
+        "kernel": "4.18.7-200.fc28.x86_64",
+        "os": "linux",
+        "uptime": "218h 50m 35.02s (Approximately 9.08 days)"
+    },
+    "insecure registries": {
+        "registries": []
+    },
+    "registries": {
+        "registries": [
+            "quay.io",
+            "registry.fedoraproject.org",
+            "docker.io",
+            "registry.access.redhat.com"
+        ]
+    },
+    "store": {
+        "ContainerStore": {
+            "number": 37
+        },
+        "GraphDriverName": "overlay",
+        "GraphOptions": [
+            "overlay.mountopt=nodev",
+            "overlay.override_kernel_check=true"
+        ],
+        "GraphRoot": "/var/lib/containers/storage",
+        "GraphStatus": {
+            "Backing Filesystem": "extfs",
+            "Native Overlay Diff": "true",
+            "Supports d_type": "true"
+        },
+        "ImageStore": {
+            "number": 17
+        },
+        "RunRoot": "/var/run/containers/storage"
+    }
+}
+```
+Run podman info and only get the registries information.
+```
+$ podman info --format={{".registries"}}
+map[registries:[docker.io quay.io registry.fedoraproject.org registry.access.redhat.com]]
+```
+
+## SEE ALSO
+podman(1), containers-registries.conf(5), containers-storage.conf(5)
-- 
cgit v1.2.3-54-g00ecf