summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAshley Cui <acui@redhat.com>2020-06-18 12:01:08 -0400
committerAshley Cui <acui@redhat.com>2020-06-18 12:13:46 -0400
commit4dc934080b551b305d7e0e214d442f675f0f897c (patch)
treee11030ff7429861729bf530b1589700a09c5f82c /docs
parente6b9b3ab227729e72f52ddab94c024174ab8a442 (diff)
downloadpodman-4dc934080b551b305d7e0e214d442f675f0f897c.tar.gz
podman-4dc934080b551b305d7e0e214d442f675f0f897c.tar.bz2
podman-4dc934080b551b305d7e0e214d442f675f0f897c.zip
Fix remote docs
Fix renaming bug in remote-docs.sh Remove mentions of 'remote' in windows and mac dos Remove podman-remote.conf.5 Signed-off-by: Ashley Cui <acui@redhat.com>
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/remote-docs.sh26
-rw-r--r--docs/source/markdown/podman-remote.1.md11
-rw-r--r--docs/source/markdown/podman-remote.conf.5.md57
3 files changed, 21 insertions, 73 deletions
diff --git a/docs/remote-docs.sh b/docs/remote-docs.sh
index 1440b0926..4774b94a3 100755
--- a/docs/remote-docs.sh
+++ b/docs/remote-docs.sh
@@ -79,11 +79,6 @@ function pub_pages() {
$publisher $f
done
- # rename podman-remote.ext to podman.ext and copy
- local remote=$(echo $TARGET/podman-remote.*)
- local ext=${remote##*.}
- cp -f $remote $TARGET/podman.$ext
-
for c in "container" "image" "pod" "volume" ""; do
local cmd=${c:+-$c}
for s in $($PODMAN $c --help | sed -n '/^Available Commands:/,/^Flags:/p' | sed -e '1d;$d' -e '/^$/d' | awk '{print $1}'); do
@@ -92,6 +87,26 @@ function pub_pages() {
done
}
+## rename renames podman-remote.ext to podman.ext, and fixes up contents to reflect change
+function rename (){
+ if [[ "$PLATFORM" != linux ]]; then
+ local remote=$(echo $TARGET/podman-remote.*)
+ local ext=${remote##*.}
+ mv $remote $TARGET/podman.$ext
+
+ $(sed -i "s/podman\\\*-remote/podman/g" $TARGET/podman.$ext)
+ $(sed -i "s/A\ remote\ CLI\ for\ Podman\:\ //g" $TARGET/podman.$ext)
+ case $PLATFORM in
+ darwin|linux)
+ $(sed -i "s/Podman\\\*-remote/Podman\ for\ Mac/g" $TARGET/podman.$ext)
+ ;;
+ windows)
+ $(sed -i "s/Podman\\\*-remote/Podman\ for\ Windows/g" $TARGET/podman.$ext)
+ ;;
+ esac
+ fi
+}
+
## walk the SOURCES for markdown sources
mkdir -p $TARGET
for s in $SOURCES; do
@@ -101,3 +116,4 @@ for s in $SOURCES; do
echo >&2 "Warning: $s does not exist"
fi
done
+rename
diff --git a/docs/source/markdown/podman-remote.1.md b/docs/source/markdown/podman-remote.1.md
index 455631a6e..0d7be1e5d 100644
--- a/docs/source/markdown/podman-remote.1.md
+++ b/docs/source/markdown/podman-remote.1.md
@@ -132,14 +132,3 @@ the exit codes follow the `chroot` standard, see below:
| [podman-unpause(1)](podman-unpause.1.md) | Unpause one or more containers. |
| [podman-version(1)](podman-version.1.md) | Display the Podman version information. |
| [podman-volume(1)](podman-volume.1.md) | Manage Volumes. |
-
-## FILES
-
-**podman-remote.conf** (`$HOME/.config/containers/podman-remote.conf`)
-
- The podman-remote.conf file is the default configuration file for the podman
- remote client. It is in the TOML format. It is primarily used to keep track
- of the user's remote connections.
-
-## SEE ALSO
-`podman-remote.conf(5)`
diff --git a/docs/source/markdown/podman-remote.conf.5.md b/docs/source/markdown/podman-remote.conf.5.md
deleted file mode 100644
index e9cc05989..000000000
--- a/docs/source/markdown/podman-remote.conf.5.md
+++ /dev/null
@@ -1,57 +0,0 @@
-% podman-remote.conf(5)
-
-## NAME
-podman-remote.conf - configuration file for the podman remote client
-
-## DESCRIPTION
-The libpod.conf file is the default configuration file for all tools using
-libpod to manage containers.
-
-The podman-remote.conf file is the default configuration file for the podman
-remote client. It is in the TOML format. It is primarily used to keep track
-of the user's remote connections.
-
-## CONNECTION OPTIONS
-**destination** = ""
- The hostname or IP address of the remote system
-
-**username** = ""
- The username to use when connecting to the remote system
-
-**default** = bool
- Denotes whether the connection is the default connection for the user. The default connection
- is used when the user does not specify a destination or connection name to `podman`.
-
-**port** = int
- Use an alternative port for the ssh connections. The default port is 22.
-
-**identity_file** = ""
- Use an alternative location for the ssh private key
-
-**ignore_hosts** = bool
- Don't match the remote ssh host key with known hosts
-
-
-## EXAMPLE
-
-The following example depicts a configuration file with two connections. One of the connections
-is designated as the default connection.
-```
-[connections]
- [connections.host1]
- destination = "host1"
- username = "homer"
- default = true
-
- [connections.host2]
- destination = "192.168.122.133"
- username = "fedora"
- port = 2222
-```
-
-## FILES
- `/$HOME/.config/containers/podman-remote.conf`, default location for the podman remote
-configuration file
-
-## HISTORY
-May 2019, Originally compiled by Brent Baude<bbaude@redhat.com>