Skip to content

Commit 8d39ebf

Browse files
committed
[#77829] documentation: source: Add shell path
Signed-off-by: Anna Roszkiewicz <aroszkiewicz@antmicro.com>
1 parent dc220df commit 8d39ebf

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

documentation/source/rdfm_linux_device_client.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ To connect to the device, [`rdfm-mgmt`](./rdfm_manager.md) can be used to reques
4242
rdfm-mgmt devices shell <device-identifier>
4343
```
4444

45+
The shell to spawn can be selected via the [ShellPath](#shellpath-string) configuration key.
46+
If not set, the path to shell will be read from the `$SHELL` environment variable.
47+
Finally, if neither yields an available path, a list of default shell paths such as `/usr/bin/bash` or `/usr/bin/sh` will be checked.
48+
4549
By default, a maximum of 5 concurrent shell sessions can be opened.
4650
This limit can be configured via the [ShellConcurrentMaxCount](#shellconcurrentmaxcount-int) configuration key.
4751
Further shell session requests will be rejected by the client.
@@ -197,6 +201,11 @@ True by default.
197201
Specifies how many concurrent shell sessions can be spawned.
198202
`5` by default.
199203

204+
#### ShellPath `string`
205+
206+
Allows choosing which shell to spawn by specifying the path.
207+
If not set, `$SHELL` environment variable or a list of default shell paths will be used to find an available shell.
208+
200209
#### FileSystemEnable `bool`
201210

202211
Allows enabling/disabling filesystem functionality.

0 commit comments

Comments
 (0)