opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-05-18 07:36:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix remote docs

Browse Source 
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>
This commit is contained in:
Ashley Cui
2020-06-18 12:01:08 -04:00
parent e6b9b3ab22
commit 4dc934080b
3 changed files with 21 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/remote-docs.sh
View File

@ -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

11
docs/source/markdown/podman-remote.1.md
View File

@ -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)`

57
docs/source/markdown/podman-remote.conf.5.md
View File

@ -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>