Skip to content
Snippets Groups Projects
Commit 7186cb88 authored by Simon McVittie's avatar Simon McVittie
Browse files

launch-client: Use HTML for definition lists

This works around Gitlab not supporting Pandoc's Markdown extension
(<https://gitlab.com/gitlab-org/gitlab/-/issues/26314

>).

Signed-off-by: default avatarSimon McVittie <smcv@collabora.com>
parent 29855fe0
No related branches found
No related tags found
No related merge requests found
Pipeline #109136 passed
...@@ -55,232 +55,331 @@ This uses **$SHELL** if available in the container, falling back to ...@@ -55,232 +55,331 @@ This uses **$SHELL** if available in the container, falling back to
# OPTIONS # OPTIONS
<dl>
<dt>
**--socket** *PATH*, **--socket** *@ABSTRACT* **--socket** *PATH*, **--socket** *@ABSTRACT*
: Connect to the given `AF_UNIX` socket, which can either be an
absolute path, or `@` followed by an arbitrary string. </dt><dd>
An absolute path indicates a filesystem-based socket, which is
associated with the filesystem and can be shared between filesystem Connect to the given `AF_UNIX` socket, which can either be an
namespaces by bind-mounting. absolute path, or `@` followed by an arbitrary string.
`@` indicates an an abstract socket, which is associated with a An absolute path indicates a filesystem-based socket, which is
network namespace, is shared between all containers that are in associated with the filesystem and can be shared between filesystem
the same network namespace, and cannot be shared across network namespaces by bind-mounting.
namespace boundaries. `@` indicates an an abstract socket, which is associated with a
This option is deprecated: using a bus name on the well-known D-Bus network namespace, is shared between all containers that are in
session bus is preferred. the same network namespace, and cannot be shared across network
namespace boundaries.
This option is deprecated: using a bus name on the well-known D-Bus
session bus is preferred.
</dd>
<dt>
**--dbus-address** *ADDRESS* **--dbus-address** *ADDRESS*
: The same as **--socket**, but the socket is specified in the form
of a D-Bus address. </dt><dd>
This option is deprecated: using a bus name on the well-known D-Bus
session bus is preferred. The same as **--socket**, but the socket is specified in the form
of a D-Bus address.
This option is deprecated: using a bus name on the well-known D-Bus
session bus is preferred.
</dd>
<dt>
**--alongside-steam** **--alongside-steam**
: Attempt to launch the *COMMAND* on behalf of a Steam app or game
that is running inside a Steam Linux Runtime container, so that </dt><dd>
the *COMMAND* is run outside the container in approximately the
same execution environment as the script that launches the Steam client. Attempt to launch the *COMMAND* on behalf of a Steam app or game
The Steam Runtime 1 'scout' library stack that is that is running inside a Steam Linux Runtime container, so that
used to run major components of the Steam client will the *COMMAND* is run outside the container in approximately the
usually **not** be present in the **LD_LIBRARY_PATH** for commands same execution environment as the script that launches the Steam client.
run like this. The Steam Runtime 1 'scout' library stack that is
used to run major components of the Steam client will
This is currently equivalent to usually **not** be present in the **LD_LIBRARY_PATH** for commands
**--bus-name=**_$SRT_LAUNCHER_SERVICE_ALONGSIDE_STEAM_ run like this.
(if that variable is set), followed by
**--bus-name=com.steampowered.PressureVessel.LaunchAlongsideSteam** This is currently equivalent to
(unconditionally) and **--bus-name=**_$SRT_LAUNCHER_SERVICE_ALONGSIDE_STEAM_
**--bus-name=org.freedesktop.portal.Flatpak** (if running inside the (if that variable is set), followed by
Flatpak per-app container for the unofficial Steam Flatpak app). **--bus-name=com.steampowered.PressureVessel.LaunchAlongsideSteam**
It can be combined with other options that select a bus name: (unconditionally) and
in particular it is valid to use **--bus-name=org.freedesktop.portal.Flatpak** (if running inside the
**--alongside-steam --host** Flatpak per-app container for the unofficial Steam Flatpak app).
to run a command in the context of the Steam client if possible or It can be combined with other options that select a bus name:
on the host system otherwise, or in particular it is valid to use
**--host --alongside-steam** **--alongside-steam --host**
to use the opposite fallback sequence. to run a command in the context of the Steam client if possible or
on the host system otherwise, or
Unlike **--host**, if the Steam client was run as a Flatpak or Snap **--host --alongside-steam**
application, the *COMMAND* will be run as part of that same Flatpak to use the opposite fallback sequence.
or Snap application, but possibly in a Flatpak subsandbox environment.
Unlike **--host**, if the Steam client was run as a Flatpak or Snap
The *COMMAND* will run in an unspecified execution environment which application, the *COMMAND* will be run as part of that same Flatpak
will frequently change between different host operating systems and or Snap application, but possibly in a Flatpak subsandbox environment.
over time, so this should only be used to run diagnostic commands
and similar things that are not part of the critical path for a game The *COMMAND* will run in an unspecified execution environment which
to be run successfully. will frequently change between different host operating systems and
Executables which are intended to be run like this should be compiled over time, so this should only be used to run diagnostic commands
against a glibc version that is as old as possible, and should and similar things that are not part of the critical path for a game
either use a relative **DT_RPATH** or **DT_RUNPATH** to find bundled to be run successfully.
dependencies relative to the special token **${ORIGIN}**, or use Executables which are intended to be run like this should be compiled
**dlopen**(3) to tolerate dependencies not being loaded successfully. against a glibc version that is as old as possible, and should
either use a relative **DT_RPATH** or **DT_RUNPATH** to find bundled
Official binary releases of the **pressure-vessel** tools are a good dependencies relative to the special token **${ORIGIN}**, or use
example of what is required to run successfully on an arbitrary host **dlopen**(3) to tolerate dependencies not being loaded successfully.
system: they are compiled in the Steam Runtime 1 'scout'
environment, all required dependencies except for glibc are bundled Official binary releases of the **pressure-vessel** tools are a good
with the pressure-vessel tools and loaded from example of what is required to run successfully on an arbitrary host
**${ORIGIN}/../lib/x86_64-linux-gnu** using a **DT_RPATH**, and the system: they are compiled in the Steam Runtime 1 'scout'
optional **sd-journal**(3) library is loaded using **dlopen**(3). environment, all required dependencies except for glibc are bundled
with the pressure-vessel tools and loaded from
As currently implemented, this feature requires a working D-Bus **${ORIGIN}/../lib/x86_64-linux-gnu** using a **DT_RPATH**, and the
session bus, the same as for **--bus-name**. optional **sd-journal**(3) library is loaded using **dlopen**(3).
As currently implemented, this feature requires a working D-Bus
session bus, the same as for **--bus-name**.
</dd>
<dt>
**--bus-name** *NAME* **--bus-name** *NAME*
: Connect to the well-known D-Bus session bus and send commands to
the given *NAME*, which is normally assumed to be owned by </dt><dd>
**steam-runtime-launcher-service**.
Connect to the well-known D-Bus session bus and send commands to
If used more than once, each *NAME* is tried in sequence and the the given *NAME*, which is normally assumed to be owned by
first that is owned on the session bus will be used. **steam-runtime-launcher-service**.
As a special case, if the *NAME* is If used more than once, each *NAME* is tried in sequence and the
**org.freedesktop.Flatpak**, then it is assumed to be first that is owned on the session bus will be used.
owned by the **flatpak-session-helper** per-user service, and the
*COMMAND* is launched on the host system, similar to the As a special case, if the *NAME* is
**--host** option of **flatpak-spawn**(1). **org.freedesktop.Flatpak**, then it is assumed to be
The **--terminate** option is not allowed in this mode. owned by the **flatpak-session-helper** per-user service, and the
*COMMAND* is launched on the host system, similar to the
As another special case, if the *NAME* is **--host** option of **flatpak-spawn**(1).
**org.freedesktop.portal.Flatpak**, then it is assumed to be The **--terminate** option is not allowed in this mode.
owned by the **flatpak-portal** per-user service, and the
*COMMAND* is launched in a Flatpak sub-sandbox, similar to As another special case, if the *NAME* is
**flatpak-spawn**(1) without the **--host** option. **org.freedesktop.portal.Flatpak**, then it is assumed to be
Most options that alter how the sub-sandbox is created, such as owned by the **flatpak-portal** per-user service, and the
**--sandbox-flag**, are not currently supported. *COMMAND* is launched in a Flatpak sub-sandbox, similar to
As with **org.freedesktop.Flatpak**, the **flatpak-spawn**(1) without the **--host** option.
**--terminate** option is not allowed in this mode. Most options that alter how the sub-sandbox is created, such as
**--sandbox-flag**, are not currently supported.
This option requires a working D-Bus session bus, which is typically As with **org.freedesktop.Flatpak**, the
provided by the **dbus.service** per-user service on systemd systems, **--terminate** option is not allowed in this mode.
or by **dbus-launch**(1) or **dbus-run-session**(1) on non-systemd
systems. This option requires a working D-Bus session bus, which is typically
provided by the **dbus.service** per-user service on systemd systems,
or by **dbus-launch**(1) or **dbus-run-session**(1) on non-systemd
systems.
</dd>
<dt>
**--host** **--host**
: Attempt to launch the *COMMAND* on the host system, similar to the
**--host** option of **flatpak-spawn**(1).
This is currently equivalent to
**--bus-name=org.freedesktop.Flatpak**, and can be combined with
other options that select a bus name, such as **--alongside-steam**.
Similar to **--alongside-steam**, the *COMMAND* will run in an unspecified </dt><dd>
execution environment which will frequently change between different
host operating systems and over time.
See the description of **--alongside-steam** for more details on how to
compile suitable executables.
As currently implemented, this feature requires a working D-Bus Attempt to launch the *COMMAND* on the host system, similar to the
session bus, the same as for **--bus-name**. **--host** option of **flatpak-spawn**(1).
This is currently equivalent to
**--bus-name=org.freedesktop.Flatpak**, and can be combined with
other options that select a bus name, such as **--alongside-steam**.
Similar to **--alongside-steam**, the *COMMAND* will run in an unspecified
execution environment which will frequently change between different
host operating systems and over time.
See the description of **--alongside-steam** for more details on how to
compile suitable executables.
As currently implemented, this feature requires a working D-Bus
session bus, the same as for **--bus-name**.
</dd>
<dt>
**--inside-app** *ID* **--inside-app** *ID*
: Attempt to launch the *COMMAND* inside a pressure-vessel container
that is currently running Steam app ID *ID*.
*ID* may be **0**, for containers that are not running a Steam app.
This is currently equivalent to
**--bus-name=com.steampowered.App**_ID_, and can be combined with
other options that select a bus name, although this is unlikely to be
practically useful.
As currently implemented, this feature requires a working D-Bus </dt><dd>
session bus, the same as for **--bus-name**.
Attempt to launch the *COMMAND* inside a pressure-vessel container
that is currently running Steam app ID *ID*.
*ID* may be **0**, for containers that are not running a Steam app.
This is currently equivalent to
**--bus-name=com.steampowered.App**_ID_, and can be combined with
other options that select a bus name, although this is unlikely to be
practically useful.
As currently implemented, this feature requires a working D-Bus
session bus, the same as for **--bus-name**.
</dd>
<dt>
**--app-path** *PATH*, **--app-path=** **--app-path** *PATH*, **--app-path=**
: When creating a Flatpak subsandbox, mount *PATH* as the `/app` in
the new subsandbox. If *PATH* is specified as the empty string,
place an empty directory at `/app`.
This option is only valid when used with </dt><dd>
**--bus-name=org.freedesktop.portal.Flatpak**, and requires
Flatpak 1.12 or later. When creating a Flatpak subsandbox, mount *PATH* as the `/app` in
the new subsandbox. If *PATH* is specified as the empty string,
place an empty directory at `/app`.
This option is only valid when used with
**--bus-name=org.freedesktop.portal.Flatpak**, and requires
Flatpak 1.12 or later.
</dd>
<dt>
**--clear-env** **--clear-env**
: Run the *COMMAND* in an empty environment, apart from any environment
variables set by **--env** and similar options, and environment </dt><dd>
variables such as `PWD` that are set programmatically (see
**ENVIRONMENT** section, below). Run the *COMMAND* in an empty environment, apart from any environment
If this option is not used, instead it inherits environment variables variables set by **--env** and similar options, and environment
from **steam-runtime-launcher-service**, with **--env** and variables such as `PWD` that are set programmatically (see
similar options overriding or unsetting individual variables. **ENVIRONMENT** section, below).
If this option is not used, instead it inherits environment variables
from **steam-runtime-launcher-service**, with **--env** and
similar options overriding or unsetting individual variables.
</dd>
<dt>
**-c** *SHELL_COMMAND*, **--shell-command** *SHELL_COMMAND* **-c** *SHELL_COMMAND*, **--shell-command** *SHELL_COMMAND*
: Run the *SHELL_COMMAND* using **sh**(1).
If additional arguments are given, the first is used to set **$0** </dt><dd>
in the resulting shell, and the remaining arguments are the
shell's positional parameters **$@**. Run the *SHELL_COMMAND* using **sh**(1).
This is a shortcut for using If additional arguments are given, the first is used to set **$0**
**-- sh -c** *SHELL_COMMAND* [*$0* [*ARGUMENT*...]] in the resulting shell, and the remaining arguments are the
as the command and arguments. shell's positional parameters **$@**.
This is a shortcut for using
**-- sh -c** *SHELL_COMMAND* [*$0* [*ARGUMENT*...]]
as the command and arguments.
</dd>
<dt>
**--directory** *DIR* **--directory** *DIR*
: Arrange for the *COMMAND* to run with *DIR* as its current working
directory.
An empty string (typically written as **--directory=**) results in </dt><dd>
inheriting the current working directory from the service that
will run the *COMMAND*. Arrange for the *COMMAND* to run with *DIR* as its current working
directory.
When using **--alongside-steam**, **--host**, An empty string (typically written as **--directory=**) results in
**--bus-name=org.freedesktop.portal.Flatpak** or inheriting the current working directory from the service that
**--bus-name=org.freedesktop.Flatpak**, will run the *COMMAND*.
the default is to attempt to use the same working directory from
which **steam-runtime-launch-client**(1) was run, similar to the
effect of using **--directory="$(pwd)"** in a shell.
This matches the behaviour of **flatpak-spawn**(1).
Otherwise, the default is to inherit the current working directory When using **--alongside-steam**, **--host**,
from the service, equivalent to **--directory=**. **--bus-name=org.freedesktop.portal.Flatpak** or
**--bus-name=org.freedesktop.Flatpak**,
the default is to attempt to use the same working directory from
which **steam-runtime-launch-client**(1) was run, similar to the
effect of using **--directory="$(pwd)"** in a shell.
This matches the behaviour of **flatpak-spawn**(1).
Otherwise, the default is to inherit the current working directory
from the service, equivalent to **--directory=**.
</dd>
<dt>
**--forward-fd** *FD* **--forward-fd** *FD*
: Arrange for the *COMMAND* to receive file descriptor number *FD*
from the current execution environment.
File descriptors 0, 1 and 2
(standard input, standard output and standard error) are always
forwarded.
If *FD* is a terminal, **steam-runtime-launch-client** will allocate </dt><dd>
a pseudo-terminal (pty) and pass the terminal end of the pty to the
*COMMAND*, forwarding input and output between *FD* and the ptmx Arrange for the *COMMAND* to receive file descriptor number *FD*
end of the pty. from the current execution environment.
File descriptors 0, 1 and 2
(standard input, standard output and standard error) are always
forwarded.
If *FD* is a terminal, **steam-runtime-launch-client** will allocate
a pseudo-terminal (pty) and pass the terminal end of the pty to the
*COMMAND*, forwarding input and output between *FD* and the ptmx
end of the pty.
</dd>
<dt>
**--list** **--list**
: Instead of running a *COMMAND*, list the services that
**steam-runtime-launch-client** could connect to. </dt><dd>
Each line of output is an option that could be passed to
**steam-runtime-launch-client** to select a service. Instead of running a *COMMAND*, list the services that
This uses a heuristic to identify possible targets from their bus **steam-runtime-launch-client** could connect to.
names, so it is possible that not all possible targets are listed. Each line of output is an option that could be passed to
In the current implementation, it lists bus names starting with **steam-runtime-launch-client** to select a service.
**com.steampowered.App**, plus This uses a heuristic to identify possible targets from their bus
**com.steampowered.PressureVessel.LaunchAlongsideSteam** and Flatpak names, so it is possible that not all possible targets are listed.
if available. In the current implementation, it lists bus names starting with
**com.steampowered.App**, plus
As currently implemented, this feature requires a working D-Bus **com.steampowered.PressureVessel.LaunchAlongsideSteam** and Flatpak
session bus, the same as for **--bus-name**. if available.
As currently implemented, this feature requires a working D-Bus
session bus, the same as for **--bus-name**.
</dd>
<dt>
**--share-pids** **--share-pids**
: If used with **--bus-name=org.freedesktop.portal.Flatpak**, use the
same process ID namespace for the new subsandbox as for the calling
process. This requires Flatpak 1.10 or later, running on a host
operating system where **bwrap**(1) is not and does not need to be
setuid root.
When communicating with a different API, this option is ignored. </dt><dd>
If used with **--bus-name=org.freedesktop.portal.Flatpak**, use the
same process ID namespace for the new subsandbox as for the calling
process. This requires Flatpak 1.10 or later, running on a host
operating system where **bwrap**(1) is not and does not need to be
setuid root.
When communicating with a different API, this option is ignored.
</dd>
<dt>
**--terminate** **--terminate**
: Terminate the **steam-runtime-launcher-service** server after the
*COMMAND* finishes running. </dt><dd>
If no *COMMAND* is specified, terminate the server immediately.
This option is not available when communicating with Flatpak. Terminate the **steam-runtime-launcher-service** server after the
*COMMAND* finishes running.
If no *COMMAND* is specified, terminate the server immediately.
This option is not available when communicating with Flatpak.
</dd>
<dt>
**--usr-path** *PATH* **--usr-path** *PATH*
: When creating a Flatpak subsandbox, mount *PATH* as the `/usr` in
the new subsandbox.
This option is only valid when used with </dt><dd>
**--bus-name=org.freedesktop.portal.Flatpak**, and requires
Flatpak 1.12 or later. When creating a Flatpak subsandbox, mount *PATH* as the `/usr` in
the new subsandbox.
This option is only valid when used with
**--bus-name=org.freedesktop.portal.Flatpak**, and requires
Flatpak 1.12 or later.
</dd>
<dt>
**--verbose** **--verbose**
: Be more verbose.
</dt><dd>
Be more verbose.
</dd>
</dl>
# ENVIRONMENT OPTIONS # ENVIRONMENT OPTIONS
...@@ -297,49 +396,94 @@ the **TERM** environment variable is passed through by default, as if ...@@ -297,49 +396,94 @@ the **TERM** environment variable is passed through by default, as if
This behaviour can be overridden by other options that affect **TERM**, This behaviour can be overridden by other options that affect **TERM**,
or disabled with **--inherit-env=TERM**. or disabled with **--inherit-env=TERM**.
<dl>
<dt>
**--env** _VAR=VALUE_ **--env** _VAR=VALUE_
: Set environment variable _VAR_ to _VALUE_.
This is mostly equivalent to using </dt><dd>
**env** _VAR=VALUE_ *COMMAND* *ARGUMENTS...*
as the command. Set environment variable _VAR_ to _VALUE_.
This is mostly equivalent to using
**env** _VAR=VALUE_ *COMMAND* *ARGUMENTS...*
as the command.
</dd>
<dt>
**--env-fd** _FD_ **--env-fd** _FD_
: Parse zero-terminated environment variables from _FD_, and set each
one as if via **--env**. </dt><dd>
The format of _FD_ is the same as the output of `$(env -0)` or the
pseudo-file `/proc/PID/environ`. Parse zero-terminated environment variables from _FD_, and set each
one as if via **--env**.
The format of _FD_ is the same as the output of `$(env -0)` or the
pseudo-file `/proc/PID/environ`.
</dd>
<dt>
**--inherit-env** *VAR* **--inherit-env** *VAR*
: Undo the effect of a previous **--env**, **--unset-env**, **--pass-env**
or similar, returning to the default behaviour of inheriting *VAR* </dt><dd>
from the execution environment of the service that is used to run
the *COMMAND* (unless **--clear-env** was used). Undo the effect of a previous **--env**, **--unset-env**, **--pass-env**
or similar, returning to the default behaviour of inheriting *VAR*
from the execution environment of the service that is used to run
the *COMMAND* (unless **--clear-env** was used).
</dd>
<dt>
**--inherit-env-matching** *WILDCARD* **--inherit-env-matching** *WILDCARD*
: Do the same as for **--inherit-env** for any environment variable
whose name matches *WILDCARD*. </dt><dd>
If this command is run from a shell, the wildcard will usually need
to be quoted, for example **--inherit-env-matching="FOO&#x2a;"**. Do the same as for **--inherit-env** for any environment variable
whose name matches *WILDCARD*.
If this command is run from a shell, the wildcard will usually need
to be quoted, for example **--inherit-env-matching="FOO&#x2a;"**.
</dd>
<dt>
**--pass-env** *VAR* **--pass-env** *VAR*
: If the environment variable *VAR* is set, pass its current value
into the container as if via **--env**. Otherwise, unset it as if </dt><dd>
via **--unset-env**.
If the environment variable *VAR* is set, pass its current value
into the container as if via **--env**. Otherwise, unset it as if
via **--unset-env**.
</dd>
<dt>
**--pass-env-matching** *WILDCARD* **--pass-env-matching** *WILDCARD*
: For each environment variable that is set and has a name matching
the **fnmatch**(3) pattern *WILDCARD*, pass its current value </dt><dd>
into the container as if via **--env**.
For example, **--pass-env-matching=Steam&#x2a;** copies Steam-related For each environment variable that is set and has a name matching
environment variables. the **fnmatch**(3) pattern *WILDCARD*, pass its current value
If this command is run from a shell, the wildcard will usually need into the container as if via **--env**.
to be quoted, for example **--pass-env-matching="Steam&#x2a;"**. For example, **--pass-env-matching=Steam&#x2a;** copies Steam-related
environment variables.
If this command is run from a shell, the wildcard will usually need
to be quoted, for example **--pass-env-matching="Steam&#x2a;"**.
</dd>
<dt>
**--unset-env** *VAR* **--unset-env** *VAR*
: Unset *VAR* when running the command.
This is mostly equivalent to using </dt><dd>
**env -u** *VAR* *COMMAND* *ARGUMENTS...*
as the command. Unset *VAR* when running the command.
This is mostly equivalent to using
**env -u** *VAR* *COMMAND* *ARGUMENTS...*
as the command.
</dd>
</dl>
# ENVIRONMENT # ENVIRONMENT
...@@ -348,53 +492,122 @@ or disabled with **--inherit-env=TERM**. ...@@ -348,53 +492,122 @@ or disabled with **--inherit-env=TERM**.
Some variables will be set programmatically by Some variables will be set programmatically by
**steam-runtime-launcher-service** when the *COMMAND* is launched: **steam-runtime-launcher-service** when the *COMMAND* is launched:
<dl>
<dt>
`MAINPID` `MAINPID`
: If **steam-runtime-launcher-service**(1) was run as a wrapper around a
command (for example as </dt><dd>
**steam-runtime-launcher-service --bus-name=... -- my-game**),
and the initial process of the wrapped command is still running, If **steam-runtime-launcher-service**(1) was run as a wrapper around a
then this variable is set to its process ID (for example, the process command (for example as
ID of **my-game**). Otherwise, this variable is cleared. **steam-runtime-launcher-service --bus-name=... -- my-game**),
The environment options shown above will override this behaviour. and the initial process of the wrapped command is still running,
then this variable is set to its process ID (for example, the process
ID of **my-game**). Otherwise, this variable is cleared.
The environment options shown above will override this behaviour.
</dd>
<dt>
`PWD` `PWD`
: **steam-runtime-launcher-service**(1) sets this to the current working
directory (as specified by **--directory**, or inherited from the </dt><dd>
launcher) for each command executed inside the container,
overriding the environment options shown above. **steam-runtime-launcher-service**(1) sets this to the current working
directory (as specified by **--directory**, or inherited from the
launcher) for each command executed inside the container,
overriding the environment options shown above.
</dd>
</dl>
## Variables read by steam-runtime-launch-client ## Variables read by steam-runtime-launch-client
Some variables affect the behaviour of **steam-runtime-launch-client**: Some variables affect the behaviour of **steam-runtime-launch-client**:
<dl>
<dt>
`DBUS_SESSION_BUS_ADDRESS` `DBUS_SESSION_BUS_ADDRESS`
: Used to contact the well-known D-Bus session bus.
</dt><dd>
Used to contact the well-known D-Bus session bus.
</dd>
<dt>
`PRESSURE_VESSEL_LOG_INFO` (boolean) `PRESSURE_VESSEL_LOG_INFO` (boolean)
: If set to 1, same as `SRT_LOG=info`
</dt><dd>
If set to 1, same as `SRT_LOG=info`
</dd>
<dt>
</dd>
<dt>
`PRESSURE_VESSEL_LOG_WITH_TIMESTAMP` (boolean) `PRESSURE_VESSEL_LOG_WITH_TIMESTAMP` (boolean)
: If set to 1, same as `SRT_LOG=timestamp`
</dt><dd>
If set to 1, same as `SRT_LOG=timestamp`
</dd>
<dt>
`SHELL` `SHELL`
: If set to a non-empty value, it is used as the default shell when
no *COMMAND* is provided. </dt><dd>
If set to a non-empty value, it is used as the default shell when
no *COMMAND* is provided.
</dd>
<dt>
`SRT_LAUNCHER_SERVICE_ALONGSIDE_STEAM` `SRT_LAUNCHER_SERVICE_ALONGSIDE_STEAM`
: If set, it is assumed to be the well-known or unique bus name of a
**steam-runtime-launcher-service**(1) outside the Steam Linux Runtime </dt><dd>
container, used when implementing **--alongside-steam**.
If set, it is assumed to be the well-known or unique bus name of a
**steam-runtime-launcher-service**(1) outside the Steam Linux Runtime
container, used when implementing **--alongside-steam**.
</dd>
<dt>
`SRT_LOG` `SRT_LOG`
: A sequence of tokens separated by colons, spaces or commas
affecting how output is recorded. See source code for details. </dt><dd>
A sequence of tokens separated by colons, spaces or commas
affecting how output is recorded. See source code for details.
</dd>
<dt>
`TERM` `TERM`
: If standard input, standard output or standard error is a terminal,
then this environment variable is passed to the *COMMAND* by default. </dt><dd>
If standard input, standard output or standard error is a terminal,
then this environment variable is passed to the *COMMAND* by default.
</dd>
<dt>
`XDG_RUNTIME_DIR` `XDG_RUNTIME_DIR`
: Used to contact the well-known D-Bus session bus.
</dt><dd>
Used to contact the well-known D-Bus session bus.
</dd>
</dl>
# OUTPUT # OUTPUT
...@@ -408,37 +621,82 @@ on standard error. ...@@ -408,37 +621,82 @@ on standard error.
The exit status is similar to **env**(1): The exit status is similar to **env**(1):
<dl>
<dt>
0 0
: The *COMMAND* exited successfully with status 0,
or there was no *COMMAND* and **--terminate** succeeded. </dt><dd>
The *COMMAND* exited successfully with status 0,
or there was no *COMMAND* and **--terminate** succeeded.
</dd>
<dt>
125 125
: Invalid arguments were given, or **steam-runtime-launch-client** failed
to start. </dt><dd>
Invalid arguments were given, or **steam-runtime-launch-client** failed
to start.
</dd>
<dt>
126 126
: Reserved to indicate inability to launch the *COMMAND*.
This is not currently distinguished from exit status 125. </dt><dd>
Reserved to indicate inability to launch the *COMMAND*.
This is not currently distinguished from exit status 125.
</dd>
<dt>
127 127
: Reserved to indicate that the *COMMAND* was not found.
This is not currently distinguished from exit status 125. </dt><dd>
Reserved to indicate that the *COMMAND* was not found.
This is not currently distinguished from exit status 125.
</dd>
<dt>
255 255
: The *COMMAND* was launched, but its exit status could not be
determined. This happens if the wait-status was neither </dt><dd>
normal exit nor termination by a signal. It also happens if
**steam-runtime-launch-client** was disconnected from the D-Bus The *COMMAND* was launched, but its exit status could not be
session bus or the **--socket** before the exit status could be determined. This happens if the wait-status was neither
determined. normal exit nor termination by a signal. It also happens if
**steam-runtime-launch-client** was disconnected from the D-Bus
session bus or the **--socket** before the exit status could be
determined.
</dd>
<dt>
Any value Any value
: The *COMMAND* exited unsuccessfully with the status indicated.
</dt><dd>
The *COMMAND* exited unsuccessfully with the status indicated.
</dd>
<dt>
128 + *n* 128 + *n*
: The *COMMAND* was killed by signal *n*.
(This is the same encoding used by **bash**(1), **bwrap**(1) and </dt><dd>
**env**(1).)
The *COMMAND* was killed by signal *n*.
(This is the same encoding used by **bash**(1), **bwrap**(1) and
**env**(1).)
</dd>
</dl>
# EXAMPLES # EXAMPLES
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment