From 30ecd8f040852e8e6b4cdbd11775f5675ccabbd8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miloslav=20Trma=C4=8D?= Date: Mon, 20 Mar 2023 21:12:51 +0100 Subject: [PATCH] Cross-link the top-level and subcommand option lists MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ... primarily to make the top-level options more discoverable. Signed-off-by: Miloslav Trmač --- docs/skopeo-copy.1.md | 2 ++ docs/skopeo-delete.1.md | 2 ++ docs/skopeo-generate-sigstore-key.1.md | 2 ++ docs/skopeo-inspect.1.md | 2 ++ docs/skopeo-list-tags.1.md | 2 ++ docs/skopeo-login.1.md | 2 ++ docs/skopeo-logout.1.md | 2 ++ docs/skopeo-standalone-sign.1.md | 2 ++ docs/skopeo-standalone-verify.1.md | 2 ++ docs/skopeo-sync.1.md | 3 +++ docs/skopeo.1.md | 3 +++ 11 files changed, 24 insertions(+) diff --git a/docs/skopeo-copy.1.md b/docs/skopeo-copy.1.md index 430aebf4..e393a13e 100644 --- a/docs/skopeo-copy.1.md +++ b/docs/skopeo-copy.1.md @@ -20,6 +20,8 @@ automatically inherit any parts of the source name. ## OPTIONS +See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name. + **--additional-tag**=_strings_ Additional tags (supports docker-archive). diff --git a/docs/skopeo-delete.1.md b/docs/skopeo-delete.1.md index 9faa05e1..30f5456e 100644 --- a/docs/skopeo-delete.1.md +++ b/docs/skopeo-delete.1.md @@ -31,6 +31,8 @@ $ docker exec -it registry /usr/bin/registry garbage-collect /etc/docker-distrib ## OPTIONS +See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name. + **--authfile** _path_ Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `skopeo login`. diff --git a/docs/skopeo-generate-sigstore-key.1.md b/docs/skopeo-generate-sigstore-key.1.md index 167e692c..aad9d51e 100644 --- a/docs/skopeo-generate-sigstore-key.1.md +++ b/docs/skopeo-generate-sigstore-key.1.md @@ -17,6 +17,8 @@ The private key is written to _prefix_**.pub** . ## OPTIONS +See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name. + **--help**, **-h** Print usage statement diff --git a/docs/skopeo-inspect.1.md b/docs/skopeo-inspect.1.md index 777c8f02..0c8a50df 100644 --- a/docs/skopeo-inspect.1.md +++ b/docs/skopeo-inspect.1.md @@ -17,6 +17,8 @@ To see values for a different architecture/OS, use the **--override-os** / **--o ## OPTIONS +See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name. + **--authfile** _path_ Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `skopeo login`. diff --git a/docs/skopeo-list-tags.1.md b/docs/skopeo-list-tags.1.md index 8aa51d53..203eb5ca 100644 --- a/docs/skopeo-list-tags.1.md +++ b/docs/skopeo-list-tags.1.md @@ -12,6 +12,8 @@ Return a list of tags from _source-image_ in a registry or a local docker-archiv ## OPTIONS +See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name. + **--authfile** _path_ Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `skopeo login`. diff --git a/docs/skopeo-login.1.md b/docs/skopeo-login.1.md index 25aaf685..e4bd260b 100644 --- a/docs/skopeo-login.1.md +++ b/docs/skopeo-login.1.md @@ -15,6 +15,8 @@ flag. The default path used is **${XDG\_RUNTIME\_DIR}/containers/auth.json**. ## OPTIONS +See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name. + **--password**, **-p**=*password* Password for registry diff --git a/docs/skopeo-logout.1.md b/docs/skopeo-logout.1.md index 4ec75370..045b9fde 100644 --- a/docs/skopeo-logout.1.md +++ b/docs/skopeo-logout.1.md @@ -14,6 +14,8 @@ All the cached credentials can be removed by setting the **all** flag. ## OPTIONS +See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name. + **--authfile**=*path* Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json diff --git a/docs/skopeo-standalone-sign.1.md b/docs/skopeo-standalone-sign.1.md index df09292a..60ab6019 100644 --- a/docs/skopeo-standalone-sign.1.md +++ b/docs/skopeo-standalone-sign.1.md @@ -17,6 +17,8 @@ This is primarily a debugging tool, useful for special cases, and usually should ## OPTIONS +See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name. + **--help**, **-h** Print usage statement diff --git a/docs/skopeo-standalone-verify.1.md b/docs/skopeo-standalone-verify.1.md index d9c63a0d..2be3e1cc 100644 --- a/docs/skopeo-standalone-verify.1.md +++ b/docs/skopeo-standalone-verify.1.md @@ -24,6 +24,8 @@ as per containers-policy.json(5). ## OPTIONS +See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name. + **--help**, **-h** Print usage statement diff --git a/docs/skopeo-sync.1.md b/docs/skopeo-sync.1.md index 0be8de03..d3a2547f 100644 --- a/docs/skopeo-sync.1.md +++ b/docs/skopeo-sync.1.md @@ -29,6 +29,9 @@ When the `--scoped` option is specified, images are prefixed with the source ima name can be stored at _destination_. ## OPTIONS + +See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name. + **--all**, **-a** If one of the images in __src__ refers to a list of images, instead of copying just the image which matches the current OS and architecture (subject to the use of the global --override-os, --override-arch and --override-variant options), attempt to copy all of diff --git a/docs/skopeo.1.md b/docs/skopeo.1.md index 77012b94..77f07e8b 100644 --- a/docs/skopeo.1.md +++ b/docs/skopeo.1.md @@ -51,6 +51,9 @@ See [containers-transports(5)](https://github.com/containers/image/blob/main/doc ## OPTIONS +These options should be placed before the subcommand name. +Individual subcommands have their own options. + **--command-timeout** _duration_ Timeout for the command execution.