From 8f346c30c3e3b79830ffe2310074867a1fd88846 Mon Sep 17 00:00:00 2001
From: Daniel J Walsh <dwalsh@redhat.com>
Date: Sun, 9 Aug 2020 09:27:22 -0400
Subject: Add missing pages for docs.podman.io
Lots of references to man pages missing from docs.podman.io
Also fix sort order in man pages and other documents.
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
---
docs/source/Commands.rst | 8 +++++++-
docs/source/connection.rst | 12 ++++++++++++
docs/source/image.rst | 10 ++++++++++
docs/source/index.rst | 1 +
docs/source/managecontainers.rst | 2 +-
docs/source/manifest.rst | 14 ++++++++++++++
docs/source/markdown/podman-image.1.md | 6 +++---
docs/source/markdown/podman-system-connection.1.md | 14 +++++++-------
docs/source/system.rst | 4 ++++
9 files changed, 59 insertions(+), 12 deletions(-)
create mode 100644 docs/source/connection.rst
create mode 100644 docs/source/manifest.rst
(limited to 'docs')
diff --git a/docs/source/Commands.rst b/docs/source/Commands.rst
index aba29bd82..a3ff24e89 100644
--- a/docs/source/Commands.rst
+++ b/docs/source/Commands.rst
@@ -6,11 +6,13 @@ Commands
:doc:`attach <markdown/podman-attach.1>` Attach to a running container
+:doc:`auto-update <markdown/podman-auto-update.1>` Auto update containers according to their auto-update policy
+
:doc:`build <markdown/podman-build.1>` Build an image using instructions from Containerfiles
:doc:`commit <markdown/podman-commit.1>` Create new image based on the changed container
-:doc:`containers <managecontainers>` Manage Containers
+:doc:`container <managecontainers>` Manage Containers
:doc:`cp <markdown/podman-cp.1>` Copy files/folders between a container and the local filesystem
@@ -52,6 +54,8 @@ Commands
:doc:`logs <markdown/podman-logs.1>` Fetch the logs of a container
+:doc:`manifest <manifest>` Create and manipulate manifest lists and image indexes
+
:doc:`mount <markdown/podman-mount.1>` Mount a working container's root filesystem
:doc:`network <network>` Manage Networks
@@ -100,6 +104,8 @@ Commands
:doc:`unshare <markdown/podman-unshare.1>` Run a command in a modified user namespace
+:doc:`untag <markdown/podman-untag.1>` Removes one or more names from a locally-stored image
+
:doc:`version <markdown/podman-version.1>` Display the Podman Version Information
:doc:`volume <volume>` Manage volumes
diff --git a/docs/source/connection.rst b/docs/source/connection.rst
new file mode 100644
index 000000000..64eb18c57
--- /dev/null
+++ b/docs/source/connection.rst
@@ -0,0 +1,12 @@
+Manage the destination(s) for Podman service(s)
+=================
+
+:doc:`add <markdown/podman-system-connection-add.1>` Record destination for the Podman service
+
+:doc:`default <markdown/podman-system-connection-default.1>` Set named destination as default for the Podman service
+
+:doc:`list <markdown/podman-system-connection-list.1>` List the destination for the Podman service(s)
+
+:doc:`remove <markdown/podman-system-connection-remove.1>` Delete named destination
+
+:doc:`rename <markdown/podman-system-connection-rename.1>` Rename the destination for Podman service
diff --git a/docs/source/image.rst b/docs/source/image.rst
index a8c6171e1..fe3a7aa3b 100644
--- a/docs/source/image.rst
+++ b/docs/source/image.rst
@@ -4,6 +4,8 @@ Image
:doc:`build <markdown/podman-build.1>` Build an image using instructions from Containerfiles
+:doc:`diff <markdown/podman-image-diff.1>` Inspect changes on an image's filesystem
+
:doc:`exists <markdown/podman-image-exists.1>` Check if an image exists in local storage
:doc:`history <markdown/podman-history.1>` Show history of a specified image
@@ -16,6 +18,8 @@ Image
:doc:`load <markdown/podman-load.1>` Load an image from container archive
+:doc:`mount <markdown/podman-images-mount.1>` Mount an image's root filesystem.
+
:doc:`prune <markdown/podman-image-prune.1>` Remove unused images
:doc:`pull <markdown/podman-pull.1>` Pull an image from a registry
@@ -26,6 +30,8 @@ Image
:doc:`save <markdown/podman-save.1>` Save image to an archive
+:doc:`search <markdown/podman-search.1>` Search a registry for an image
+
:doc:`sign <markdown/podman-image-sign.1>` Sign an image
:doc:`tag <markdown/podman-tag.1>` Add an additional name to a local image
@@ -33,3 +39,7 @@ Image
:doc:`tree <markdown/podman-image-tree.1>` Prints layer hierarchy of an image in a tree format
:doc:`trust <markdown/podman-image-trust.1>` Manage container image trust policy
+
+:doc:`untag <markdown/podman-untag.1>` Removes one or more names from a locally-stored image
+
+:doc:`unmount <markdown/podman-unmount.1>` Unmount an image's root filesystem
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 715ca2744..9a1381080 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -15,6 +15,7 @@ If you are completely new to containers, we recommend that you check out the :do
:caption: Contents:
Introduction
+ :doc:`<markdown/podman.1>` Simple management tool for pods, containers and images
Commands
Reference
Tutorials
diff --git a/docs/source/managecontainers.rst b/docs/source/managecontainers.rst
index 5c5a83a82..2e787c9e9 100644
--- a/docs/source/managecontainers.rst
+++ b/docs/source/managecontainers.rst
@@ -57,7 +57,7 @@ Manage Containers
:doc:`top <markdown/podman-top.1>` Display the running processes of a container
-:doc:`umount <markdown/podman-umount.1>` Unmounts working container's root filesystem
+:doc:`unmount <markdown/podman-unmount.1>` Unmounts working container's root filesystem
:doc:`unpause <markdown/podman-unpause.1>` Unpause the processes in one or more containers
diff --git a/docs/source/manifest.rst b/docs/source/manifest.rst
new file mode 100644
index 000000000..c63c28502
--- /dev/null
+++ b/docs/source/manifest.rst
@@ -0,0 +1,14 @@
+Create and manipulate manifest lists and image indexes
+=================
+
+:doc:`add <markdown/podman-manifest-add.1>` Add an image to a manifest list or image index
+
+:doc:`annotate <markdown/podman-manifest-annotate.1>` Add or update information about an entry in a manifest list or image index
+
+:doc:`create <markdown/podman-manifest-create.1>` Create a manifest list or image index
+
+:doc:`inspect <markdown/podman-manifest-inspect.1>` Display a manifest list or image index
+
+:doc:`push <markdown/podman-manifest-push.1>` Push a manifest list or image index to a registry
+
+:doc:`remove <markdown/podman-manifest-remove.1>` Remove an image from a manifest list or image index
diff --git a/docs/source/markdown/podman-image.1.md b/docs/source/markdown/podman-image.1.md
index 55e95d032..bbf5f6d84 100644
--- a/docs/source/markdown/podman-image.1.md
+++ b/docs/source/markdown/podman-image.1.md
@@ -20,8 +20,8 @@ The image command allows you to manage images
| import | [podman-import(1)](podman-import.1.md) | Import a tarball and save it as a filesystem image. |
| inspect | [podman-inspect(1)](podman-inspect.1.md) | Display a image or image's configuration. |
| list | [podman-images(1)](podman-images.1.md) | List the container images on the system.(alias ls) |
-| mount | [podman-image-mount(1)](podman-image-mount.1.md) | Mount an image's root filesystem. |
| load | [podman-load(1)](podman-load.1.md) | Load an image from the docker archive. |
+| mount | [podman-image-mount(1)](podman-image-mount.1.md) | Mount an image's root filesystem. |
| prune | [podman-image-prune(1)](podman-image-prune.1.md) | Remove all unused images from the local store. |
| pull | [podman-pull(1)](podman-pull.1.md) | Pull an image from a registry. |
| push | [podman-push(1)](podman-push.1.md) | Push an image from local storage to elsewhere. |
@@ -30,10 +30,10 @@ The image command allows you to manage images
| search | [podman-search(1)](podman-search.1.md) | Search a registry for an image. |
| sign | [podman-image-sign(1)](podman-image-sign.1.md) | Create a signature for an image. |
| tag | [podman-tag(1)](podman-tag.1.md) | Add an additional name to a local image. |
-| untag | [podman-untag(1)](podman-untag.1.md) | Removes one or more names from a locally-stored image. |
-| unmount | [podman-image-unmount(1)](podman-image-unmount.1.md) | Unmount an image's root filesystem. |
| tree | [podman-image-tree(1)](podman-image-tree.1.md) | Prints layer hierarchy of an image in a tree format. |
| trust | [podman-image-trust(1)](podman-image-trust.1.md) | Manage container registry image trust policy. |
+| unmount | [podman-image-unmount(1)](podman-image-unmount.1.md) | Unmount an image's root filesystem. |
+| untag | [podman-untag(1)](podman-untag.1.md) | Removes one or more names from a locally-stored image. |
## SEE ALSO
podman
diff --git a/docs/source/markdown/podman-system-connection.1.md b/docs/source/markdown/podman-system-connection.1.md
index 86199c6b9..0673aaee1 100644
--- a/docs/source/markdown/podman-system-connection.1.md
+++ b/docs/source/markdown/podman-system-connection.1.md
@@ -13,13 +13,13 @@ The user will be prompted for the ssh login password or key file pass phrase as
## COMMANDS
-| Command | Man Page | Description |
-| ------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- |
-| add | [podman-system-connection-add(1)](podman-system-connection-add.1.md) | Record destination for the Podman service |
-| default | [podman-system-connection-default(1)](podman-system-connection-default.1.md) | Set named destination as default for the Podman service |
-| list | [podman-system-connection-list(1)](podman-system-connection-list.1.md) | List the destination for the Podman service(s) |
-| remove | [podman-system-connection-remove(1)](podman-system-connection-remove.1.md) | Delete named destination |
-| rename | [podman-system-connection-rename(1)](podman-system-connection-rename.1.md) | Rename the destination for Podman service |
+| Command | Man Page | Description |
+| -------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------- |
+| add | [podman-system-connection\-add(1)](podman-system-connection-add.1.md) | Record destination for the Podman service |
+| default | [podman-system-connection\-default(1)](podman-system-connection-default.1.md) | Set named destination as default for the Podman service |
+| list | [podman-system-connection\-list(1)](podman-system-connection-list.1.md) | List the destination for the Podman service(s) |
+| remove | [podman-system-connection\-remove(1)](podman-system-connection-remove.1.md) | Delete named destination |
+| rename | [podman-system-connection\-rename(1)](podman-system-connection-rename.1.md) | Rename the destination for Podman service |
## EXAMPLE
```
diff --git a/docs/source/system.rst b/docs/source/system.rst
index 2d93a1d6d..e3dfa9d01 100644
--- a/docs/source/system.rst
+++ b/docs/source/system.rst
@@ -1,6 +1,8 @@
System
======
+:doc:`connection <markdown/podman-system-conection.1>` Manage the destination(s) for Podman service(s)
+
:doc:`df <markdown/podman-system-df.1>` Show podman disk usage
:doc:`info <markdown/podman-info.1>` Display podman system information
@@ -12,3 +14,5 @@ System
:doc:`renumber <markdown/podman-system-renumber.1>` Migrate lock numbers
:doc:`reset <markdown/podman-system-reset.1>` Reset podman storage
+
+:doc:`service <markdown/podman-system-service.1>` Run an API service
--
cgit v1.2.3-54-g00ecf