Skip to content

Commit 1c3712c

Browse files
committed
Indent option explanations using definition lists (:)
Signed-off-by: herrenP <[email protected]>
1 parent 279c831 commit 1c3712c

12 files changed

+274
-232
lines changed

docs/skopeo-copy.1.md

Lines changed: 67 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -24,221 +24,221 @@ See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name.
2424

2525
**--additional-tag**=_strings_
2626

27-
Additional tags (supports docker-archive).
27+
: Additional tags (supports docker-archive).
2828

2929
**--all**, **-a**
3030

31-
If _source-image_ refers to a list of images, instead of copying just the image which matches the current OS and
32-
architecture (subject to the use of the global --override-os, --override-arch and --override-variant options), attempt to copy all of
33-
the images in the list, and the list itself.
31+
: If _source-image_ refers to a list of images, instead of copying just the image which matches the current OS and
32+
architecture (subject to the use of the global --override-os, --override-arch and --override-variant options), attempt to copy all of
33+
the images in the list, and the list itself.
3434

3535
**--authfile** _path_
3636

37-
Path of the primary registry credentials file. On Linux, the default is ${XDG\_RUNTIME\_DIR}/containers/auth.json.
38-
See **containers-auth.json**(5) for more details about the credential search mechanism and defaults on other platforms.
39-
40-
Use `skopeo login` to manage the credentials.
41-
42-
The default value of this option is read from the `REGISTRY\_AUTH\_FILE` environment variable.
37+
: Path of the primary registry credentials file. On Linux, the default is ${XDG\_RUNTIME\_DIR}/containers/auth.json.
38+
See **containers-auth.json**(5) for more details about the credential search mechanism and defaults on other platforms.
39+
40+
Use `skopeo login` to manage the credentials.
41+
42+
The default value of this option is read from the `REGISTRY\_AUTH\_FILE` environment variable.
4343

4444
**--src-authfile** _path_
4545

46-
Path of the primary registry credentials file for the source registry. Uses path given by `--authfile`, if not provided.
46+
: Path of the primary registry credentials file for the source registry. Uses path given by `--authfile`, if not provided.
4747

4848
**--dest-authfile** _path_
4949

50-
Path of the primary registry credentials file for the destination registry. Uses path given by `--authfile`, if not provided.
50+
: Path of the primary registry credentials file for the destination registry. Uses path given by `--authfile`, if not provided.
5151

5252
**--dest-shared-blob-dir** _directory_
5353

54-
Directory to use to share blobs across OCI repositories.
54+
: Directory to use to share blobs across OCI repositories.
5555

5656
**--digestfile** _path_
5757

58-
After copying the image, write the digest of the resulting image to the file.
58+
: After copying the image, write the digest of the resulting image to the file.
5959

6060
**--preserve-digests**
6161

62-
Preserve the digests during copying. Fail if the digest cannot be preserved.
62+
: Preserve the digests during copying. Fail if the digest cannot be preserved.
6363

64-
This option does not change what will be copied; consider using `--all` at the same time.
64+
This option does not change what will be copied; consider using `--all` at the same time.
6565

6666
**--encrypt-layer** _ints_
6767

68-
*Experimental* the 0-indexed layer indices, with support for negative indexing (e.g. 0 is the first layer, -1 is the last layer)
68+
: *Experimental* the 0-indexed layer indices, with support for negative indexing (e.g. 0 is the first layer, -1 is the last layer)
6969

7070
**--format**, **-f** _manifest-type_
7171

72-
MANIFEST TYPE (oci, v2s1, or v2s2) to use in the destination (default is manifest type of source, with fallbacks)
72+
: MANIFEST TYPE (oci, v2s1, or v2s2) to use in the destination (default is manifest type of source, with fallbacks)
7373

7474
**--help**, **-h**
7575

76-
Print usage statement
76+
: Print usage statement
7777

7878
**--multi-arch** _option_
7979

80-
Control what is copied if _source-image_ refers to a multi-architecture image. Default is system.
80+
: Control what is copied if _source-image_ refers to a multi-architecture image. Default is system.
8181

82-
Options:
83-
- system: Copy only the image that matches the system architecture
84-
- all: Copy the full multi-architecture image
85-
- index-only: Copy only the index
82+
: Options:
83+
- system: Copy only the image that matches the system architecture
84+
- all: Copy the full multi-architecture image
85+
- index-only: Copy only the index
8686

87-
The index-only option usually fails unless the referenced per-architecture images are already present in the destination, or the target registry supports sparse indexes.
87+
The index-only option usually fails unless the referenced per-architecture images are already present in the destination, or the target registry supports sparse indexes.
8888

8989
**--quiet**, **-q**
9090

91-
Suppress output information when copying images.
91+
: Suppress output information when copying images.
9292

9393
**--remove-signatures**
9494

95-
Do not copy signatures, if any, from _source-image_. Necessary when copying a signed image to a destination which does not support signatures.
95+
: Do not copy signatures, if any, from _source-image_. Necessary when copying a signed image to a destination which does not support signatures.
9696

9797
**--sign-by** _key-id_
9898

99-
Add a “simple signing” signature using that key ID for an image name corresponding to _destination-image_
99+
: Add a “simple signing” signature using that key ID for an image name corresponding to _destination-image_
100100

101101
**--sign-by-sigstore** _param-file_
102102

103-
Add a sigstore signature based on the options in the specified containers sigstore signing parameter file, _param-file_.
104-
See containers-sigstore-signing-params.yaml(5) for details about the file format.
103+
: Add a sigstore signature based on the options in the specified containers sigstore signing parameter file, _param-file_.
104+
See containers-sigstore-signing-params.yaml(5) for details about the file format.
105105

106106
**--sign-by-sigstore-private-key** _path_
107107

108-
Add a sigstore signature using a private key at _path_ for an image name corresponding to _destination-image_
108+
: Add a sigstore signature using a private key at _path_ for an image name corresponding to _destination-image_
109109

110110
**--sign-by-sq-fingerprint** _fingerprint_
111111

112-
Add a “simple signing” signature using a Sequoia-PGP key with the specified _fingerprint_.
112+
: Add a “simple signing” signature using a Sequoia-PGP key with the specified _fingerprint_.
113113

114114
**--sign-passphrase-file** _path_
115115

116-
The passphrase to use when signing with `--sign-by`, `--sign-by-sigstore-private-key` or `--sign-by-sq-fingerprint`.
117-
Only the first line will be read. A passphrase stored in a file is of questionable security if other users can read this file. Do not use this option if at all avoidable.
116+
: The passphrase to use when signing with `--sign-by`, `--sign-by-sigstore-private-key` or `--sign-by-sq-fingerprint`.
117+
Only the first line will be read. A passphrase stored in a file is of questionable security if other users can read this file. Do not use this option if at all avoidable.
118118

119119
**--sign-identity** _reference_
120120

121-
The identity to use when signing the image. The identity must be a fully specified docker reference. If the identity is not specified, the target docker reference will be used.
121+
: The identity to use when signing the image. The identity must be a fully specified docker reference. If the identity is not specified, the target docker reference will be used.
122122

123123
**--src-shared-blob-dir** _directory_
124124

125-
Directory to use to share blobs across OCI repositories.
125+
: Directory to use to share blobs across OCI repositories.
126126

127127
**--encryption-key** _protocol:keyfile_
128128

129-
Specifies the encryption protocol, which can be JWE (RFC7516), PGP (RFC4880), and PKCS7 (RFC2315) and the key material required for image encryption. For instance, jwe:/path/to/key.pem or pgp:admin@example.com or pkcs7:/path/to/x509-file.
129+
: Specifies the encryption protocol, which can be JWE (RFC7516), PGP (RFC4880), and PKCS7 (RFC2315) and the key material required for image encryption. For instance, jwe:/path/to/key.pem or pgp:admin@example.com or pkcs7:/path/to/x509-file.
130130

131131
**--decryption-key** _key[:passphrase]_
132132

133-
Key to be used for decryption of images. Key can point to keys and/or certificates. Decryption will be tried with all keys. If the key is protected by a passphrase, it is required to be passed in the argument and omitted otherwise.
133+
: Key to be used for decryption of images. Key can point to keys and/or certificates. Decryption will be tried with all keys. If the key is protected by a passphrase, it is required to be passed in the argument and omitted otherwise.
134134

135135
**--src-creds** _username[:password]_
136136

137-
Credentials for accessing the source registry.
137+
: Credentials for accessing the source registry.
138138

139139
**--dest-compress**
140140

141-
Compress tarball image layers when saving to directory using the 'dir' transport. (default is same compression type as source).
141+
: Compress tarball image layers when saving to directory using the 'dir' transport. (default is same compression type as source).
142142

143143
**--dest-decompress**
144144

145-
Decompress tarball image layers when saving to directory using the 'dir' transport. (default is same compression type as source).
145+
: Decompress tarball image layers when saving to directory using the 'dir' transport. (default is same compression type as source).
146146

147147
**--dest-oci-accept-uncompressed-layers**
148148

149-
Allow uncompressed image layers when saving to an OCI image using the 'oci' transport. (default is to compress things that aren't compressed).
149+
: Allow uncompressed image layers when saving to an OCI image using the 'oci' transport. (default is to compress things that aren't compressed).
150150

151151
**--dest-creds** _username[:password]_
152152

153-
Credentials for accessing the destination registry.
153+
: Credentials for accessing the destination registry.
154154

155155
**--src-cert-dir** _path_
156156

157-
Use certificates at _path_ (*.crt, *.cert, *.key) to connect to the source registry or daemon.
157+
: Use certificates at _path_ (*.crt, *.cert, *.key) to connect to the source registry or daemon.
158158

159159
**--src-no-creds**
160160

161-
Access the registry anonymously.
161+
: Access the registry anonymously.
162162

163163
**--src-tls-verify**=_bool_
164164

165-
Require HTTPS and verify certificates when talking to container source registry or daemon. Default to source registry setting.
165+
: Require HTTPS and verify certificates when talking to container source registry or daemon. Default to source registry setting.
166166

167167
**--dest-cert-dir** _path_
168168

169-
Use certificates at _path_ (*.crt, *.cert, *.key) to connect to the destination registry or daemon.
169+
: Use certificates at _path_ (*.crt, *.cert, *.key) to connect to the destination registry or daemon.
170170

171171
**--dest-no-creds**
172172

173-
Access the registry anonymously.
173+
: Access the registry anonymously.
174174

175175
**--dest-tls-verify**=_bool_
176176

177-
Require HTTPS and verify certificates when talking to container destination registry or daemon. Default to destination registry setting.
177+
: Require HTTPS and verify certificates when talking to container destination registry or daemon. Default to destination registry setting.
178178

179179
**--src-daemon-host** _host_
180180

181-
Copy from docker daemon at _host_. If _host_ starts with `tcp://`, HTTPS is enabled by default. To use plain HTTP, use the form `http://` (default is `unix:///var/run/docker.sock`).
181+
: Copy from docker daemon at _host_. If _host_ starts with `tcp://`, HTTPS is enabled by default. To use plain HTTP, use the form `http://` (default is `unix:///var/run/docker.sock`).
182182

183183
**--dest-daemon-host** _host_
184184

185-
Copy to docker daemon at _host_. If _host_ starts with `tcp://`, HTTPS is enabled by default. To use plain HTTP, use the form `http://` (default is `unix:///var/run/docker.sock`).
185+
: Copy to docker daemon at _host_. If _host_ starts with `tcp://`, HTTPS is enabled by default. To use plain HTTP, use the form `http://` (default is `unix:///var/run/docker.sock`).
186186

187-
Existing signatures, if any, are preserved as well.
187+
Existing signatures, if any, are preserved as well.
188188

189189
**--dest-compress-format** _format_
190190

191-
Specifies the compression format to use. Supported values are: `gzip`, `zstd` and `zstd:chunked`.
192-
`zstd:chunked` is incompatible with encrypting images,
193-
and will be treated as `zstd` with a warning in that case.
191+
: Specifies the compression format to use. Supported values are: `gzip`, `zstd` and `zstd:chunked`.
192+
`zstd:chunked` is incompatible with encrypting images,
193+
and will be treated as `zstd` with a warning in that case.
194194

195195
**--dest-compress-level** _format_
196196

197-
Specifies the compression level to use. The value is specific to the compression algorithm used, e.g. for zstd the accepted values are in the range 1-20 (inclusive), while for gzip it is 1-9 (inclusive).
197+
: Specifies the compression level to use. The value is specific to the compression algorithm used, e.g. for zstd the accepted values are in the range 1-20 (inclusive), while for gzip it is 1-9 (inclusive).
198198

199199
**--dest-force-compress-format**
200200

201-
Ensures that the compression algorithm set in --dest-compress-format is used exclusively.
201+
: Ensures that the compression algorithm set in --dest-compress-format is used exclusively.
202202

203203
**--src-registry-token** _token_
204204

205-
Bearer token for accessing the source registry.
205+
: Bearer token for accessing the source registry.
206206

207207
**--dest-registry-token** _token_
208208

209-
Bearer token for accessing the destination registry.
209+
: Bearer token for accessing the destination registry.
210210

211211
**--dest-precompute-digests**
212212

213-
Precompute digests to ensure layers are not uploaded that already exist on the destination registry. Layers with initially unknown digests (ex. compressing "on the fly") will be temporarily streamed to disk.
213+
: Precompute digests to ensure layers are not uploaded that already exist on the destination registry. Layers with initially unknown digests (ex. compressing "on the fly") will be temporarily streamed to disk.
214214

215215
**--retry-times**
216216

217-
The number of times to retry.
217+
: The number of times to retry.
218218

219219
**--retry-delay**
220220

221-
Fixed delay between retries. If not set (or set to 0s), retry wait time will be exponentially increased based on the number of failed attempts.
221+
: Fixed delay between retries. If not set (or set to 0s), retry wait time will be exponentially increased based on the number of failed attempts.
222222

223223
**--src-username**
224224

225-
The username to access the source registry.
225+
: The username to access the source registry.
226226

227227
**--src-password**
228228

229-
The password to access the source registry.
229+
: The password to access the source registry.
230230

231231
**--dest-username**
232232

233-
The username to access the destination registry.
233+
: The username to access the destination registry.
234234

235235
**--dest-password**
236236

237-
The password to access the destination registry.
237+
: The password to access the destination registry.
238238

239239
**--image-parallel-copies** _n_
240240

241-
Maximum number of image layers to be copied (pulled/pushed) simultaneously. Not setting this field will fall back to containers/image defaults.
241+
: Maximum number of image layers to be copied (pulled/pushed) simultaneously. Not setting this field will fall back to containers/image defaults.
242242

243243
## EXAMPLES
244244

docs/skopeo-delete.1.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,62 +35,62 @@ See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name.
3535

3636
**--authfile** _path_
3737

38-
Path of the primary registry credentials file. On Linux, the default is ${XDG\_RUNTIME\_DIR}/containers/auth.json.
39-
See **containers-auth.json**(5) for more details about the credential search mechanism and defaults on other platforms.
38+
: Path of the primary registry credentials file. On Linux, the default is ${XDG\_RUNTIME\_DIR}/containers/auth.json.
39+
See **containers-auth.json**(5) for more details about the credential search mechanism and defaults on other platforms.
4040

41-
Use `skopeo login` to manage the credentials.
41+
Use `skopeo login` to manage the credentials.
4242

43-
The default value of this option is read from the `REGISTRY\_AUTH\_FILE` environment variable.
43+
The default value of this option is read from the `REGISTRY\_AUTH\_FILE` environment variable.
4444

4545
**--creds** _username[:password]_
4646

47-
Credentials for accessing the registry.
47+
: Credentials for accessing the registry.
4848

4949
**--cert-dir** _path_
5050

51-
Use certificates at _path_ (*.crt, *.cert, *.key) to connect to the registry.
51+
: Use certificates at _path_ (*.crt, *.cert, *.key) to connect to the registry.
5252

5353
**--daemon-host** _host_
5454

55-
Use docker daemon host at _host_ (`docker-daemon:` transport only)
55+
: Use docker daemon host at _host_ (`docker-daemon:` transport only)
5656

5757
**--help**, **-h**
5858

59-
Print usage statement
59+
: Print usage statement
6060

6161
**--no-creds**
6262

63-
Access the registry anonymously.
63+
: Access the registry anonymously.
6464

65-
Additionally, the registry must allow deletions by setting `REGISTRY_STORAGE_DELETE_ENABLED=true` for the registry daemon.
65+
Additionally, the registry must allow deletions by setting `REGISTRY_STORAGE_DELETE_ENABLED=true` for the registry daemon.
6666

6767
**--registry-token** _token_
6868

69-
Bearer token for accessing the registry.
69+
: Bearer token for accessing the registry.
7070

7171
**--retry-times**
7272

73-
The number of times to retry.
73+
: The number of times to retry.
7474

7575
**--retry-delay**
7676

77-
Fixed delay between retries. If not set (or set to 0s), retry wait time will be exponentially increased based on the number of failed attempts.
77+
: Fixed delay between retries. If not set (or set to 0s), retry wait time will be exponentially increased based on the number of failed attempts.
7878

7979
**--shared-blob-dir** _directory_
8080

81-
Directory to use to share blobs across OCI repositories.
81+
: Directory to use to share blobs across OCI repositories.
8282

8383
**--tls-verify**=_bool_
8484

85-
Require HTTPS and verify certificates when talking to the container registry or daemon. Default to registry.conf setting.
85+
: Require HTTPS and verify certificates when talking to the container registry or daemon. Default to registry.conf setting.
8686

8787
**--username**
8888

89-
The username to access the registry.
89+
: The username to access the registry.
9090

9191
**--password**
9292

93-
The password to access the registry.
93+
: The password to access the registry.
9494

9595
## EXAMPLES
9696

docs/skopeo-generate-sigstore-key.1.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name.
2121

2222
**--help**, **-h**
2323

24-
Print usage statement
24+
: Print usage statement
2525

2626
**--output-prefix** _prefix_
2727

28-
Mandatory.
29-
Path prefix for the output keys (_prefix_**.private** and _prefix_**.pub**).
28+
: Mandatory.
29+
Path prefix for the output keys (_prefix_**.private** and _prefix_**.pub**).
3030

3131
**--passphrase-file** _path_
3232

33-
The passphare to use to encrypt the private key.
34-
Only the first line will be read.
35-
A passphrase stored in a file is of questionable security if other users can read this file.
36-
Do not use this option if at all avoidable.
33+
: The passphare to use to encrypt the private key.
34+
Only the first line will be read.
35+
A passphrase stored in a file is of questionable security if other users can read this file.
36+
Do not use this option if at all avoidable.
3737

3838
## EXAMPLES
3939

0 commit comments

Comments
 (0)