Skip to content

Enhance documentation for CLI$Prompt variable #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sijnstra wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Enhance documentation for CLI$Prompt variable #84

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab050f7
Enhance documentation for CLI$Prompt variable
sijnstra May 10, 2026
88b282f
Clarify prompt color mode requirements
sijnstra May 10, 2026
6d6dfb3
Clarify prompt change behavior in documentation
sijnstra May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/mos/System-Variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,15 @@ The command prompt that the MOS CLI displays is defined using the variable named

If you unset the `CLI$Prompt` variable, the system will revert to displaying the default prompt which is `*`.

For example, to set your prompt to be written in yellow on black, returning to white on black for your commands, you can add the following line to your [boot script](../MOS.md#boot-script):

```
setmacro CLI$Prompt <17><128><17><11><Current$Dir> *<17><15>
```

Note that the above prompt change relies on being in default colours, in 16 or 64 colour modes. In 2 or 4 colour modes the prompt will appear to be white on black. It works by taking advantage of the GSTrans mechanism interpreting the `<123>` entries as literal characters to send. This means the the first part of the new prompt is the equivalent of `vdu 17 128 17 11`, and after the `*`, the ending is the equivalent of `vdu 17 15`.


### `CLI$AutoPaged` {#autopaged}

Setting a variable `CLI$AutoPaged` to any value will enable the auto-paging feature of the CLI, if you are using VDP 2.14.0 or later by [temporarily enabling paged mode](../vdp/System-Commands.md#vdu-23-0-9a). By default this variable is not set.
Expand Down