summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-version.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-version.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
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>
Diffstat (limited to 'docs/source/man/podman-version.1.md')
-rw-r--r--docs/source/man/podman-version.1.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/source/man/podman-version.1.md b/docs/source/man/podman-version.1.md
new file mode 100644
index 000000000..4499f6338
--- /dev/null
+++ b/docs/source/man/podman-version.1.md
@@ -0,0 +1,46 @@
+% podman-version(1)
+
+## NAME
+podman\-version - Display the Podman version information
+
+## SYNOPSIS
+**podman version** [*options*]
+
+## DESCRIPTION
+Shows the following information: Version, Go Version, Git Commit, Build Time,
+OS, and Architecture.
+
+## OPTIONS
+
+**--help**, **-h**
+
+Print usage statement
+
+**--format**, **-f**=*format*
+
+Change output format to "json" or a Go template.
+
+## Example
+
+A sample output of the `version` command:
+```
+$ podman version
+Version: 0.11.1
+Go Version: go1.11
+Git Commit: "8967a1d691ed44896b81ad48c863033f23c65eb0-dirty"
+Built: Thu Nov 8 22:35:40 2018
+OS/Arch: linux/amd64
+```
+
+Filtering out only the version:
+```
+$ podman version --format '{{.Version}}'
+0.11.2
+```
+
+## SEE ALSO
+podman(1)
+
+## HISTORY
+November 2018, Added --format flag by Tomas Tomecek <ttomecek@redhat.com>
+July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>