File: sopv-version.1.ronn

package info (click to toggle)
stateless-openpgp-docs 13.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 380 kB
  • sloc: sh: 951; ansic: 279; makefile: 49; python: 36
file content (67 lines) | stat: -rw-r--r-- 2,277 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
sopv-version(1) -- Get sopv version, build, and compatibility information
=========================================================================

## SYNOPSIS

`sopv` [`--debug`] `version` [`--backend`\|`--extended`\|`--sop-spec`\|`--sopv`]

## DESCRIPTION

`sopv version` emits version, build, and compatibility information about the specific implementation of `sopv`.

With no options supplied, `sopv version` produces a single line of text to standard output and exits 0.

The line of output is separated by whitespace into two fields.
The first field is the name of the `sopv` implementation and the second field is the version number.

## EXAMPLES

```
$ sopv version
ExampleSop 5.2.3
$ sopv version --sopv
1.1
$
```

## OPTIONS

At most one of the following options is allowed.

 * `--backend`:
   Emit a single line describing the primary backend of the tool and its version information.

 * `--extended`:
   Emit multiple lines of arbitrary build and configuration information.
   The first line of output will be the same as the line emitted when running `sopv version` with no options.
   This information is always useful when submitting a bug report about any `sopv` implementation.

 * `--sop-spec`:
   Indicate the targeted version of the sop [internet-draft][draft-dkg-openpgp-stateless-cli].
   If the output begins with a `~`, it indicates that the targeted draft is incomplete.

 * `--sopv`:
   Indicate the level of compliance with `sopv`.
   If no level of `sopv` is fully supported, this will fail with `UNSUPPORTED_OPTION`.
   Otherwise, it will emit a level to standard output, like "1.0\n" or "1.1\n".
   See the VERSION HISTORY section of sopv(1) for more details.

## RETURN CODE

`sopv version` returns 0 to to indicate success.

If the implementation does not understand one of the variants, it will return the non-zero code for `UNSUPPORTED_OPTION`.

## AUTHOR

This manual page was written by Daniel Kahn Gillmor.
Your implementation of `sopv` is likely written by someone else in alignment with the SOP specification.
Please run `sopv version` to learn more about your implementation.

## SEE ALSO

sopv(1),
sopv-verify(1),
sopv-inline-verify(1),
[Stateless OpenPGP Command Line Interface][draft-dkg-openpgp-stateless-cli],
[RFC 9580][RFC9580]