diff --git a/runtime.md b/runtime.md index 411df9f..6c0ff6a 100644 --- a/runtime.md +++ b/runtime.md @@ -67,84 +67,6 @@ $ echo $? 42 ``` -### exec - -Runs a secondary process in the given container. - -* *Options* - * *`--process `* Override `process.json` with an alternative path. The path may not support seeking (e.g. `/dev/fd/3`). -* *Arguments* - * *``* The container ID to join. -* *Standard streams:* The runtime must attach its standard streams directly to the application process without inspection. -* *Exit code:* The runtime must exit with the application process's exit code. - -If the main application (launched by `start`) dies, all other processes in its container will be killed [TODO: link to lifecycle docs explaining this]. - -Example: -```sh -# in a directory with a process.json that echos "goodbye" and exits 43 -$ funC exec hello-1 -goodbye -$ echo $? -43 -``` - -### pause - -Pause all processes in a container. - -* *Options* - * *`--wait`* Block until the process is completely paused. - Otherwise return immediately after initiating the pause, which may happen before the pause is complete. -* *Arguments* - * *``* The container ID to join. -* *Exit code:* 0 on success, non-zero on error. - -Example: -```sh -$ funC pause --wait hello-1 -$ echo $? -0 -``` - -### resume - -Unpause all processes in a container. - -* *Options* - * *`--wait`* Block until the process is completely unpaused. - Otherwise return immediately after initiating the unpause, which may happen before the unpause is complete. -* *Arguments* - * *``* The container ID to join. -* *Exit code:* 0 on success, non-zero on error. - -Example: -```sh -$ funC resume hello-1 -$ echo $? -0 -``` - -### signal - -Sends a signal to the container. - -* *Options* - * *`--signal `* The signal to send. - This must be one of the valid POSIX signals, although runtimes on non-POSIX systems must translate the POSIX name to their platorm's analogous signal. - Defaults to TERM. -* *Arguments* - * *``* The container ID to join. -* *Exit code:* 0 on success, non-zero on error. - A 0 exit status does not imply the process has exited (as it may have caught the signal). - -Example: -```sh -$ funC signal --signal KILL hello-1 -$ echo $? -0 -``` - [posix-encoding]: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap06.html#tag_06_02 [posix-lang]: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html#tag_08_02 [posix-locale-encoding: http://www.unicode.org/reports/tr35/#Bundle_vs_Item_Lookup