diff --git a/docs/reference/myst-syntax-reference.md b/docs/reference/myst-syntax-reference.md index 29dea71e..288e3680 100644 --- a/docs/reference/myst-syntax-reference.md +++ b/docs/reference/myst-syntax-reference.md @@ -192,8 +192,17 @@ To show a terminal view, use the following directive: Input is specified as the `:input:` option (or prefixed with `:input:` as part of the main content of the directive). Output is the main content of the directive. -To override the prompt (`user@host:~$` by default), specify the `:user:` and/or `:host:` options. -To make the terminal scroll horizontally instead of wrapping long lines, add `:scroll:`. +To customize the prompt (`user@host:~$` by default), specify any of the following options: + +* `:user:` +* `:host:` +* `:dir:` + +To add a button that copies the command specified in `:input:`, include the `:copy:` option. + +To make the terminal scroll horizontally instead of wrapping long lines, include the `:scroll:` option. + +For more details, refer to the [`sphinx-terminal` README](https://github.com/canonical/sphinx-terminal/blob/main/README.md). ## Links diff --git a/docs/reference/rst-syntax-reference.rst b/docs/reference/rst-syntax-reference.rst index 7f364a2f..62c2e971 100644 --- a/docs/reference/rst-syntax-reference.rst +++ b/docs/reference/rst-syntax-reference.rst @@ -173,8 +173,17 @@ To include a terminal view, use the following directive: Input is specified as the ``:input:`` option (or prefixed with ``:input:`` as part of the main content of the directive). Output is the main content of the directive. -To override the prompt (``user@host:~$`` by default), specify the ``:user:`` and/or ``:host:`` options. -To make the terminal scroll horizontally instead of wrapping long lines, add ``:scroll:``. +To customize the prompt (``user@host:~$`` by default), specify any of the following options: + +* ``:user:`` +* ``:host:`` +* ``:dir:`` + +To add a button that copies the command specified in ``:input:``, include the ``:copy:`` option. + +To make the terminal scroll horizontally instead of wrapping long lines, include the ``:scroll:`` option. + +For more details, refer to the `sphinx-terminal README `_. Links -----