You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
None are required, but the runtime may support options that start with at least one hyphen.
13
-
Global options may take positional arguments (e.g. `--log-level debug`), but the option parsing must be such that `funC <COMMAND>` is unambiguously an invocation of `<COMMAND>` for any `<COMMAND>` that does not start with a hyphen (including commands not specified in this document).
12
+
None are required, but the runtime MAY support options that start with at least one hyphen.
13
+
Global options MAY take positional arguments (e.g. `--log-level debug`), but the option parsing MUST be such that `funC <COMMAND>` is unambiguously an invocation of `<COMMAND>` for any `<COMMAND>` that does not start with a hyphen (including commands not specified in this document).
14
14
15
15
## Commands
16
16
17
17
### version
18
18
19
19
Print the runtime version and exit.
20
20
21
-
**Options* None are required, but the runtime may support options.
21
+
**Options* None are required, but the runtime MAY support options.
22
22
**Standard streams*
23
-
**stdin:* The runtime may not attempt to read from its stdin.
24
-
**stdout:* The runtime must print its name, a space, and its version as the first line to its stdout.
25
-
The name may contain any Unicode characters except a control codes and newlines.
26
-
The runtime may print additional lines its stdout, and the format for those lines is not specified in this document.
27
-
**stderr:* The runtime may print diagnostic messages to stderr, and the format for those lines is not specified in this document.
28
-
**Exit code:* The runtime must exit with zero.
23
+
**stdin:* The runtime MUST NOT attempt to read from its stdin.
24
+
**stdout:* The runtime MUST print its name, a space, and its version as the first line to its stdout.
25
+
The name MAY contain any Unicode characters, but MUST NOT contain control codes or newlines.
26
+
The runtime MAY print additional lines its stdout, and the format for those lines is not specified in this document.
27
+
**stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
28
+
**Exit code:* The runtime MUST exit with zero.
29
29
30
30
Example:
31
31
```sh
@@ -38,19 +38,18 @@ $ echo $?
38
38
39
39
### start
40
40
41
-
Starts a container from a bundle directory.
42
-
It operates by default on the `config.json` and `runtime.json` in the current directory.
41
+
Start a container from a bundle directory.
43
42
44
43
**Options*
45
44
**`--id <ID>`* Set the container ID when creating or joining a container.
46
45
If not set, the runtime is free to pick any ID that is not already in use.
47
46
**`--config <PATH>`* Override `config.json` with an alternative path. The path may not support seeking (e.g. `/dev/fd/3`).
48
47
**`--runtime <PATH>`* Override `runtime.json` with an alternative path. The path may not support seeking (e.g. `/dev/fd/3`).
49
-
**Standard streams:* The runtime must attach its standard streams directly to the application process without inspection.
48
+
**Standard streams:* The runtime MUST attach its standard streams directly to the application process without inspection.
50
49
**Environment variables*
51
50
**`LISTEN_FDS`:* The number of file descriptors passed.
52
-
For example, `LISTEN_FDS=2` would mean passing 3 and 4 (in addition to the [standard streams][standard-streams]) to support [socket activation][systemd-listen-fds].
53
-
**Exit code:* The runtime must exit with the application process's exit code.
51
+
For example, `LISTEN_FDS=2` would mean that the runtime MUST pass file descriptors 3 and 4 to the application process (in addition to the [standard streams][standard-streams]) to support [socket activation][systemd-listen-fds].
52
+
**Exit code:* The runtime MUST exit with the application process's exit code.
0 commit comments