podman/docs/podman-diff.1.md at 0066374fc3f69bbfd9ed08986115049d9a39b1f8

mirror of https://github.com/containers/podman synced 2024-10-21 09:45:32 +00:00

W. Trevor King f2462ca59e docs: Follow man-pages(7) suggestions for SYNOPSIS

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

2018-07-04 09:40:37 +00:00

796 B

Raw Blame History

% podman-diff "1"

NAME

podman-diff - Inspect changes on a container or image's filesystem

SYNOPSIS

podman diff [options] name

DESCRIPTION

Displays changes on a container or image's filesystem. The container or image will be compared to its parent layer

OPTIONS

--format

Alter the output into a different format. The only valid format for diff is json.

EXAMPLE

# podman diff redis:alpine
C /usr
C /usr/local
C /usr/local/bin
A /usr/local/bin/docker-entrypoint.sh

# podman diff --format json redis:alpine
{
  "changed": [
    "/usr",
    "/usr/local",
    "/usr/local/bin"
  ],
  "added": [
    "/usr/local/bin/docker-entrypoint.sh"
  ]
}

HISTORY

August 2017, Originally compiled by Ryan Cole rycole@redhat.com

796 B Raw Blame History