From 2e22e18afbaba175a0328b0d70ca4d6bb15c441e Mon Sep 17 00:00:00 2001 From: Jhon Honce Date: Mon, 15 Jun 2020 09:06:56 -0700 Subject: Add deprecated message to varlink command * Remove varlink references from the man pages * Fix signature for extractTarFile() Signed-off-by: Jhon Honce --- docs/source/markdown/podman-remote.1.md | 2 +- docs/source/markdown/podman-system-service.1.md | 7 +-- docs/source/markdown/podman-varlink.1.md | 63 ------------------------- docs/source/markdown/podman.1.md | 1 - 4 files changed, 2 insertions(+), 71 deletions(-) delete mode 100644 docs/source/markdown/podman-varlink.1.md (limited to 'docs/source/markdown') diff --git a/docs/source/markdown/podman-remote.1.md b/docs/source/markdown/podman-remote.1.md index a7297f3f2..455631a6e 100644 --- a/docs/source/markdown/podman-remote.1.md +++ b/docs/source/markdown/podman-remote.1.md @@ -17,7 +17,7 @@ Podman uses Buildah(1) internally to create container images. Both tools share i (not container) storage, hence each can use or manipulate images (but not containers) created by the other. -Podman-remote provides a local client interacting with a Podman backend node through a varlink ssh connection. In this context, a Podman node is a Linux system with Podman installed on it and the varlink service activated. Credentials for this session can be passed in using flags, environment variables, or in `podman-remote.conf` +Podman-remote provides a local client interacting with a Podman backend node through a RESTful API tunneled through a ssh connection. In this context, a Podman node is a Linux system with Podman installed on it and the API service activated. Credentials for this session can be passed in using flags, environment variables, or in `podman-remote.conf` **podman [GLOBAL OPTIONS]** diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md index 48e595641..3ae414f7a 100644 --- a/docs/source/markdown/podman-system-service.1.md +++ b/docs/source/markdown/podman-system-service.1.md @@ -31,13 +31,8 @@ Run an API listening for 5 seconds using the default socket. podman system service --timeout 5000 ``` -Run the podman varlink service with an alternate URI and accept the default timeout. -``` -$ podman system service --varlink unix:/tmp/io.podman -``` - ## SEE ALSO -podman(1), podman-varlink(1) +podman(1), podman-system-service(1), podman-system-connection(1) ## HISTORY January 2020, Originally compiled by Brent Baude diff --git a/docs/source/markdown/podman-varlink.1.md b/docs/source/markdown/podman-varlink.1.md deleted file mode 100644 index 0b04d5ba3..000000000 --- a/docs/source/markdown/podman-varlink.1.md +++ /dev/null @@ -1,63 +0,0 @@ -% podman-varlink(1) - -## NAME -podman\-varlink - Runs the varlink backend interface - -## SYNOPSIS -**podman varlink** [*options*] *uri* - -## DESCRIPTION -Starts the varlink service listening on *uri* that allows varlink clients to interact with podman. If no *uri* is provided, a default -URI will be used depending on the user calling the varlink service. The default for the root user is `unix:/run/podman/io.podman`. Regular -users will have a default *uri* of `$XDG_RUNTIME_DIR/podman/io.podman`. For example, `unix:/run/user/1000/podman/io.podman` -The varlink service should generally be done with systemd. See _Configuration_ below. - - -## OPTIONS - -**--help**, **-h** - - Print usage statement - -**--time**, **-t** - -The time until the varlink session expires in _milliseconds_. The default is 1 -second. A value of `0` means no timeout and the session will not expire. - -## EXAMPLES - -Run the podman varlink service accepting all default options. - -``` -$ podman varlink -``` - - -Run the podman varlink service with an alternate URI and accept the default timeout. - -``` -$ podman varlink unix:/tmp/io.podman -``` - -Run the podman varlink service manually with a 5 second timeout. - -``` -$ podman varlink --timeout 5000 -``` - -## CONFIGURATION - -Users of the podman varlink service should enable the _io.podman.socket_ and _io.podman.service_. -This is the preferred method for running the varlink service. - -You can do this via systemctl. - -``` -$ systemctl enable --now io.podman.socket -``` - -## SEE ALSO -podman(1), systemctl(1) - -## HISTORY -April 2018, Originally compiled by Brent Baude diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 8dc486b65..2f338452c 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -207,7 +207,6 @@ the exit codes follow the `chroot` standard, see below: | [podman-unpause(1)](podman-unpause.1.md) | Unpause one or more containers. | | [podman-unshare(1)](podman-unshare.1.md) | Run a command inside of a modified user namespace. | | [podman-untag(1)](podman-untag.1.md) | Removes one or more names from a locally-stored image. | -| [podman-varlink(1)](podman-varlink.1.md) | Runs the varlink backend interface. | | [podman-version(1)](podman-version.1.md) | Display the Podman version information. | | [podman-volume(1)](podman-volume.1.md) | Simple management tool for volumes. | | [podman-wait(1)](podman-wait.1.md) | Wait on one or more containers to stop and print their exit codes. | -- cgit v1.2.3-54-g00ecf