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
Copy file name to clipboardExpand all lines: command-line-interface.md
+4-27Lines changed: 4 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,33 +18,10 @@ If the runtime is invoked with an unrecognized command, it MUST exit with a nonz
18
18
## Character encodings
19
19
20
20
This API specification does not cover character encodings, but runtimes SHOULD conform to their native operating system.
21
-
For example, POSIX systems define [`LANG` and related environment variables][posix-lang] for [declaring][posix-locale-encoding][locale-specific character encodings][posix-encoding], so a runtime in an `en_US.UTF-8` locale SHOULD write its [version](#version) to stdout in [UTF-8][].
21
+
For example, POSIX systems define [`LANG` and related environment variables][posix-lang] for [declaring][posix-locale-encoding][locale-specific character encodings][posix-encoding], so a runtime in an `en_US.UTF-8` locale SHOULD write its [state](#state) to stdout in [UTF-8][].
22
22
23
23
## Commands
24
24
25
-
### version
26
-
27
-
Print the runtime version and exit.
28
-
29
-
**Options* None are required, but the runtime MAY support options.
30
-
**Standard streams*
31
-
**stdin:* The runtime MUST NOT attempt to read from its stdin.
32
-
**stdout:* The runtime MUST print its name, a space, and its version as the first line to its stdout.
33
-
The name MAY contain any Unicode characters, but MUST NOT contain control codes or newlines.
34
-
The runtime MAY print additional lines to its stdout, and the format for those lines is not specified in this document.
35
-
**stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
36
-
**Exit code:* The runtime MUST exit with zero.
37
-
38
-
#### Example
39
-
40
-
```
41
-
$ funC version
42
-
funC 1.0.0
43
-
Built for x86_64-pc-linux-gnu
44
-
$ echo $?
45
-
0
46
-
```
47
-
48
25
### create
49
26
50
27
[Create][create] a container from a [bundle directory][bundle].
@@ -89,7 +66,7 @@ If you call `start` from a shell using a separate terminal, the container output
89
66
90
67
#### Container process exit
91
68
92
-
The [example's](#example-1)`block-on-exit-and-collect-exit-code` is platform-specific magic that is not specified in this document.
69
+
The [example's](#example)`block-on-exit-and-collect-exit-code` is platform-specific magic that is not specified in this document.
93
70
On Linux, it might involve an ancestor process which had set [`PR_SET_CHILD_SUBREAPER`][prctl.2] and collected the container PID [from the state][state], or a process that was [ptracing][ptrace.2] the container process for [`exit_group`][exit_group.2], although both of those race against the container process exiting before the watcher is monitoring.
94
71
95
72
### start
@@ -105,7 +82,7 @@ This command SHOULD exit as quickly as possible after triggering the execution,
105
82
**stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
106
83
**Exit code:* Zero if the container was successfully started and non-zero on errors.
107
84
108
-
See [create](#example-1) for an example.
85
+
See [create](#example) for an example.
109
86
110
87
### state
111
88
@@ -184,7 +161,7 @@ $ echo $?
184
161
**stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
185
162
**Exit code:* Zero if the container was successfully deleted and non-zero on errors.
0 commit comments