summaryrefslogtreecommitdiff
path: root/docs/podman-top.1.md
Commit message (Collapse)AuthorAge
* hide --latest on the remote-clientbaude2019-02-22
| | | | | | | | in the case of the remote-client, it was decided to hide the latest flag to avoid confusion for end-users on what the "last" container, volume, or pod are. Signed-off-by: baude <bbaude@redhat.com>
* docs: consistent format for exampleValentin Rothberg2018-08-30
| | | | | | | | | | All bash examples are now placed in a code section (```). The PS1 prompt is set to `$`. Signed-off-by: Valentin Rothberg <vrothberg@suse.com> Closes: #1375 Approved by: rhatdan
* docs: make HISTORY consistentValentin Rothberg2018-08-30
| | | | | | | | | | | - second heading - consistent mail addresses <user@domain.com> - change order with latest changes first Signed-off-by: Valentin Rothberg <vrothberg@suse.com> Closes: #1375 Approved by: rhatdan
* vendor latest containers/psgoValentin Rothberg2018-07-26
| | | | | | | Signed-off-by: Valentin Rothberg <vrothberg@suse.com> Closes: #1162 Approved by: rhatdan
* Vendor in latest containers/psgo codeDaniel J Walsh2018-07-24
| | | | | | | | | Fixes spaces and sorting on capabilties and Descriptors Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #1148 Approved by: vrothberg
* Add format descriptors infor to podman topDaniel J Walsh2018-07-23
| | | | | | | | | | Trying to play with podman top, I had a hard time finding info on format options. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #1134 Approved by: umohnani8
* docs/podman-top: fix typo and whitespaceValentin Rothberg2018-07-23
| | | | | | | Signed-off-by: Valentin Rothberg <vrothberg@suse.com> Closes: #1131 Approved by: mheon
* podman-top: use containers/psgoValentin Rothberg2018-07-19
| | | | | | | | | | | | | | | | | Use github.com/containers/psgo instead of execing `ps (1)`. The psgo library enables a much more flexible interface with respect to which data to be printed (e.g., capabilities, seccomp mode, PID, PCPU, etc.) while the output can be parsed reliably. The library does not use ps (1) but parses /proc and /dev instead. To list the processes of a given container, psgo will join the mount namespace of the given container and extract all data from there. Notice that this commit breaks compatibility with docker-top. Signed-off-by: Valentin Rothberg <vrothberg@suse.com> Closes: #1113 Approved by: rhatdan
* docs: Follow man-pages(7) suggestions for SYNOPSISW. Trevor King2018-07-04
| | | | | | | | | | | | | | | | | | | | | | | man-pages(7) has [1]: > For commands, this shows the syntax of the command and its arguments > (including options); boldface is used for as-is text and italics are > used to indicate replaceable arguments. Brackets ([]) surround > optional arguments, vertical bars (|) separate choices, and ellipses > (...) can be repeated. I've adjusted our SYNOPSIS entries to match that formatting, and generally tried to make them more consistent with the precedent set by the man-pages project. Outside of the SYNOPSIS entry, I prefer using backticks for literals, although in some places I've left the ** bolding to keep things visually similar to a nearby SYNOPSIS entry. [1]: http://man7.org/linux/man-pages/man7/man-pages.7.html Signed-off-by: W. Trevor King <wking@tremily.us> Closes: #1027 Approved by: rhatdan
* Doc changes to fix alignment on most of the docsumohnani82018-06-14
| | | | | | | | | | Went through the docs and fixed the alignment so they all match up and look readable when doing 'man podman [command]" Signed-off-by: umohnani8 <umohnani@redhat.com> Closes: #943 Approved by: rhatdan
* Cleanup man pagesDaniel J Walsh2018-05-30
| | | | | | | | | | Format md files to work properly when converted to man pages. Add sed command to cleanup table in podman man page. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #842 Approved by: mheon
* Modify man pages so they compile correctly in mandbDaniel J Walsh2018-04-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This fixes an issue where if you did man -k podman-run podman-run (1) - (unknown subject) Now you will see man -k podman-run podman-run (1) - Run a command in a new container More importantly man -k containers | grep podman podman (1) - Simple management tool for containers and images podman-kill (1) - Kills one or more containers with a signal podman-pause (1) - Pause one or more containers podman-ps (1) - Prints out information about containers podman-rm (1) - Remove one or more containers podman-start (1) - Start one or more containers podman-stats (1) - Display a live stream of 1 or more containers' resource usage statistics podman-stop (1) - Stop one or more containers podman-unpause (1) - Unpause one or more containers podman-wait (1) - Waits on one or more containers to stop and prints exit code Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #676 Approved by: mheon
* docs: podman-top: fix nonworking exampleEd Santiago2018-03-06
| | | | | | | | | | | | | | | | | | (minor) One example in the podman-top man page results in an error when actually invoked: unable to find PID field in ps output. try a different set of ps arguments Cause: commit 6cb1c31d (PR #400) has to check PIDs in order to filter those in the container. Solution: add 'pid' to the list of requested output fields in the sample command. Signed-off-by: Ed Santiago <santiago@redhat.com> Closes: #457 Approved by: rhatdan
* Deprecate --format for podman topbaude2018-02-05
| | | | | | | | | | | | | | | | | | | Issue #169 describes a common failure when running podman top where if the commands inside the container container a space in them, podman will panic. This was occuring because we take the output from ps and attempt to format it nicely for output and things like JSON. Given that this cannot be predicted or dealt with programatically, the decision was made to deprecate the format switch and simply output what ps provides us. Migrated top integration tests to ginkgo. Resolves Issue: https://github.com/projectatomic/libpod/issues/169 Signed-off-by: baude <bbaude@redhat.com> Closes: #291 Approved by: rhatdan
* Shortcut for most recent containerbaude2018-01-08
| | | | | | | | | | | | It is desirable to have a shortcut for the most recently created container. We can now use "**latest" to represent the most recent container instead of its container ID or name. For example: Signed-off-by: baude <bbaude@redhat.com> Closes: #179 Approved by: baude
* Rename all references to kpod to podmanDaniel J Walsh2017-12-18
The decision is in, kpod is going to be named podman. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #145 Approved by: umohnani8