Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
3a7d0cb
Scaffold the Dyalog Configuration Guide subsite
abrudz Jul 28, 2026
4f70cc7
Add Introduction and How to Set Configuration Parameters section
abrudz Jul 28, 2026
cba926b
Migrate configuration parameters into the Configuration Guide
abrudz Jul 28, 2026
18f58b5
Apply configuration-parameter template to Session log and buffers
abrudz Jul 28, 2026
41d265f
Apply template to workspace-default configuration parameters
abrudz Jul 28, 2026
a68c8ae
Apply template to editor configuration parameters
abrudz Jul 28, 2026
d9e4e41
Apply template to tracer configuration parameters
abrudz Jul 28, 2026
3061b33
Apply template to edit and SM window geometry parameters
abrudz Jul 28, 2026
01e4c48
Apply template to session-appearance configuration parameters
abrudz Jul 28, 2026
17c444f
Apply template to keyboard and input configuration parameters
abrudz Jul 29, 2026
0bc2937
Apply template to startup and workspace-loading parameters
abrudz Jul 29, 2026
eeb6892
Apply template to interpreter runtime configuration parameters
abrudz Jul 29, 2026
e472eeb
Apply template to location, help, and URL configuration parameters
abrudz Jul 29, 2026
9ef9d1f
Apply template to file, interop, and diagnostic parameters
abrudz Jul 29, 2026
220df8d
Apply template to AutoComplete configuration parameters
abrudz Jul 29, 2026
78fb2c5
Apply template to ValueTips, event-log, and miscellaneous parameters
abrudz Jul 29, 2026
e1913c9
Apply template to remaining configuration parameters
abrudz Jul 29, 2026
f47c914
Rewrite Configuration Parameters landing page cross-platform
abrudz Jul 29, 2026
a9794b6
Add Configuration Parameters by Category listing
abrudz Jul 29, 2026
e1d6953
Integrate Dyalog Configuration Guide onto current main
abrudz Jul 29, 2026
f805961
Clean up the How to Set parameter lists
abrudz Jul 29, 2026
99c913a
Fix cross-guide links left broken by the parameter migration
abrudz Jul 29, 2026
d50a75e
Add UNIX-only configuration parameters to the guide
abrudz Jul 29, 2026
2d61e4f
Add remaining per-OS notes for shared parameters
abrudz Jul 29, 2026
f1243b3
Trim the OS guides to reference the Configuration Guide
abrudz Jul 29, 2026
41ee1df
Show the tab case for unescaped back-slashes in file names
abrudz Jul 29, 2026
1ca08a5
Merge remote-tracking branch 'origin/main' into 719-configuration-guide
abrudz Jul 29, 2026
5a8c92b
Document the deprecated component file changes for 21.0
abrudz Jul 29, 2026
7821234
Reference DYALOG_S32_SUPPORTED from the tie functions
abrudz Jul 29, 2026
523613f
Absorb the deprecated component file changes into the Configuration G…
abrudz Jul 29, 2026
e26b73f
Document the Session layout file and the Layout menu
abrudz Jul 30, 2026
94a4b28
Correct the default path and extension rule for LAYOUT_FILE
abrudz Jul 30, 2026
0ef38a5
Remove SingleTrace and correct how the Layout menu items are driven
abrudz Jul 30, 2026
fc40a6c
Absorb the Session layout file changes into the Configuration Guide
abrudz Jul 30, 2026
b74e29b
Show the Documents folder name as it actually varies
abrudz Jul 30, 2026
b8ecdbf
Absorb the Documents folder name correction into the Configuration Guide
abrudz Jul 30, 2026
fde01b1
Correct the external variable and small-span switches
abrudz Jul 31, 2026
df480a0
Absorb the external variable and small-span corrections
abrudz Jul 31, 2026
5812b32
Generalise configuration-setting substitution in the guide
abrudz Aug 10, 2026
cd502d1
Add DYALOG_INITSESSION to the configuration guide
abrudz Aug 11, 2026
f8b7c39
Cross-link and expand DYALOG_SERIALFILE in the configuration guide
abrudz Aug 11, 2026
be26329
Correct AplCoreName behaviour for multiple wild-cards
abrudz Aug 11, 2026
132ed77
Do not link cross-platform DYALOG_SERIAL to the non-Windows DYALOG_SE…
abrudz Aug 11, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AddClassHeaders

What the Tracer displays when tracing the execution of a function defined in a script.

Valid values are:

- `0` : the entire script is shown in the Trace window
- `1` : only the first line of the script and the function being traced are shown

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# APL_CODE_E_MAGNITUDE

The magnitude at or above which numbers in function bodies are descanned (written out as their character representation, for example by `⎕CR`) in exponential format. This controls whether large integers appear as, for example, `1E21` or `1000000000000000000000`, which affects the readability of code and the stability of its character representation across versions.

Valid values are:

- `0` : numbers are descanned and displayed normally (the default)
- `¯1` : numbers greater than or equal to 10<sup>17</sup> use exponential format, as in Version 12.1
- an integer from `2` to `34` : numbers greater than or equal to 10<sup>value</sup> use exponential format

Default is `0`. The effect of any other value is undefined.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# APL_COMPLEX_AS_V12

!!! Legacy "Legacy"
This configuration parameter eases the transition of older code to currently supported versions of Dyalog. It is intended to be removed in a future release.

Whether code developed with Version 12.1 or earlier keeps its original behaviour with respect to complex numbers.

Valid values are:

- `1` : Version 12.1 behaviour is retained. Power (`*`) and logarithm (`⍟`) do not produce complex results from non-complex arguments; `⎕VFI` does not honour `J`/`j`; and `¯4○Y` is evaluated as `(¯1+Y*2)*0.5`. In addition, objects containing complex numbers cannot be transferred to or from component files, TCP/IP (Conga), or auxiliary processors, nor used as an argument to Serialise/Deserialise Array (`220⌶`); a `DOMAIN ERROR` is issued instead.
- any other value, or unset : code developed with Version 12.1 or earlier may now generate complex numbers

This does not prevent the generation and use of complex numbers through newer features, such as complex-number literals.
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# APL_FAST_FCHK

Whether `⎕FCHK` is optimised so that it can reliably determine that a component file was properly untied and so need not be checked (this can be overridden with the `⎕FCHK` `force` option). The optimisation has a performance cost on `⎕FUNTIE`, so it is best switched off in applications that frequently tie and untie files. It affects only component files with journaling enabled.

Valid values are:

- `0` : do not optimise `⎕FCHK` (optimise `⎕FUNTIE` instead)
- `1` : optimise `⎕FCHK`

Default is `0` on all platforms. On Microsoft Windows, setting the value `1` has no effect.
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# APL_FCREATE_PROPS_C

The default checksum level for newly-created component files.

Valid values are a checksum level.

Default is `1`.

!!! Info "Information"
Component files that have both journalling and checksum properties set to `0` have been deprecated, and it is no longer possible to create files with this combination of properties.

Related parameters: [APL_FCREATE_PROPS_J](apl-fcreate-props-j.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# APL_FCREATE_PROPS_J

The default journaling level for newly-created component files.

Valid values are a journaling level.

Default is `1`.

!!! Info "Information"
Component files that have both journalling and checksum properties set to `0` have been deprecated, and it is no longer possible to create files with this combination of properties.

Related parameters: [APL_FCREATE_PROPS_C](apl-fcreate-props-c.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# APL_MAX_THREADS

The maximum number of system threads used for parallel execution.

Valid values are an integer from `1` to `64`.

Default is `1`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# APL_TextInAplCore

Whether certain information is written to an *aplcore* file when a [system error](../../../programming-reference-guide/error-messages/system-errors) occurs.

Valid values are:

- `0` : the information is omitted
- `1` : the information is included

Default is `1` (the interpreter's own default is `0`, but on UNIX and macOS the supplied startup script sets it to `1`).

Related parameters: [AplCoreName](aplcorename.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# APLAN_FOR_EDITOR

Whether new **Edit** windows containing arrays open using [array notation](../../../programming-reference-guide/introduction/arrays/array-notation/) when possible.

Valid values are:

- `0` : arrays open in the usual display form
- `1` : arrays open using array notation; [`⎕PP`](../../../language-reference-guide/system-functions/pp) does not then apply to numbers shown in the editor

Default is `0`.

The setting can be toggled with the `]APLAN.Editor` user command. In Ride and the Microsoft Windows IDE, an open **Edit** window's mode can be toggled with the ![array notation](../img/object_arraynotation.png){width=20 height=20 vertical-align:text-bottom} icon in the editor's toolbar.

Related parameters: [APLAN_FOR_OUTPUT](aplan-for-output.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# APLAN_FOR_OUTPUT

Whether Session output uses [array notation](../../../programming-reference-guide/introduction/arrays/array-notation/) when possible.

Valid values are:

- `0` : Session output uses the usual display form
- `1` : Session output uses array notation; [`⎕PP`](../../../language-reference-guide/system-functions/pp) does not then apply to numeric Session output

Default is `0`.

The setting can be toggled with the `]APLAN.Output` user command. In the Microsoft Windows IDE it can also be toggled with the ![array notation](../img/session_arraynotation.png){width=20 height=20 vertical-align:text-bottom} icon in the Session toolbar.

Related parameters: [APLAN_FOR_EDITOR](aplan-for-editor.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AplCoreName

The directory and name of the file in which an *aplcore* is saved. An optional wild-card character (`*`) is replaced by a number when the file is written; only one `*` can be used. If there is more than one `*`, the setting is ignored and the aplcore is named `aplcore`. Dyalog terminates with an exit code of `3` when an aplcore is generated.

Valid values are a file path, optionally containing a single `*`.

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

Related parameters: [MaxAplCores](maxaplcores.md) (including how to prevent aplcore files being generated).

See also [aplcore Parameters](../../../language-reference-guide/primitive-operators/i-beam/aplcore-parameters).
14 changes: 14 additions & 0 deletions dyalog-configuration-guide/docs/configuration-parameters/aplk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# APLK

!!! Info "Information"
This configuration parameter is only relevant when using the Classic edition of Dyalog.

The name of the Input Translate Table, which defines the keyboard layout. The keyboard list in the Configuration dialog shows every `.DIN` file in the directory given by [`APLKeys`](aplkeys.md); any of the supplied tables can be chosen, and you can add your own. The `FILE.DIN` table is intended for input from file and should not normally be chosen as a keyboard table.

Valid values are the name of a `.DIN` input translate table.

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

Related parameters: [APLKeys](aplkeys.md).

See also the [Input tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-input-tab-classic-edition-only) of the Windows Configuration Dialog.
11 changes: 11 additions & 0 deletions dyalog-configuration-guide/docs/configuration-parameters/aplk0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# APLK0

!!! Info "Information"
This configuration parameter is only relevant when using the Classic edition of Dyalog on the UNIX and macOS operating systems.

An input translate table that overrides [`APLK`](aplk.md), if set. It takes precedence over the table implied by the terminal type.

Valid values are the name of a `.din` input translate table.
<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

Related parameters: [APLK](aplk.md), [APLKeys](aplkeys.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# APLKeys

!!! Info "Information"
This configuration parameter is only relevant when using the Classic edition of Dyalog.

A search path for the Input Translate Table, useful when configuring a run-time application. Directory paths use the operating system's conventions and are separated by `;` (Windows) or `:` (UNIX and macOS).

Valid values are a list of directory paths.

Default is the `aplkeys` sub-directory of the Dyalog installation directory (given by [`Dyalog`](dyalog.md)).

On UNIX and macOS, if this parameter is unset the search path defaults to the directory given by [`Dyalog`](dyalog.md); if that is also unset, it defaults to `/usr/dyalog`.
<!-- REVIEW(default): reconcile the Microsoft Windows default (aplkeys sub-directory) with the UNIX and macOS default (the Dyalog directory, else /usr/dyalog). -->

Related parameters: [APLK](aplk.md), [Dyalog](dyalog.md).

See also the [Input tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-input-tab-classic-edition-only) of the Windows Configuration Dialog.
10 changes: 10 additions & 0 deletions dyalog-configuration-guide/docs/configuration-parameters/aplnid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# aplnid

The *user number* used by the component file system to control file sharing and security. When a user creates a component file, their user number is recorded in the file to identify them as its owner.

Valid values, and how the user number is obtained, depend on the operating system:

- Microsoft Windows: **aplnid** is an integer from `0` to `65535`. To share component files or external variables across a network, each user must have a unique **aplnid**. A value of `0` causes the user to bypass APL's access-control-matrix mechanism.
- UNIX and macOS: the user number is obtained from the operating system (UID) and **aplnid** is not used. If the user is `root`, APL's access-control mechanism is ignored.

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# APLSTATUSFD

!!! Info "Information"
This configuration parameter is only relevant on the UNIX and macOS operating systems.

The number of the output stream (file descriptor) on which messages for the Status window are written. Setting it allows this output to be redirected when Dyalog is started.

Valid values are a file descriptor number.

Default is unset, in which case the output appears in the same terminal window as the Session (although it is not part of the Session, and can be cleared with the Screen Redraw command key, often `Ctrl+L`).
15 changes: 15 additions & 0 deletions dyalog-configuration-guide/docs/configuration-parameters/aplt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# APLT

!!! Info "Information"
This configuration parameter is only relevant when using the Classic edition of Dyalog.

The name of the Output Translate Table.

Valid values are the name of an output translate table.

Default is `WIN.DOT` on Microsoft Windows, where there is rarely a need to alter it.
<!-- REVIEW(default): confirm the default on UNIX and macOS. -->

Related parameters: [APLTrans](apltrans.md).

See also the [Output tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-output-tab-classic-edition-only) of the Windows Configuration Dialog.
11 changes: 11 additions & 0 deletions dyalog-configuration-guide/docs/configuration-parameters/apltn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# APLTn

!!! Info "Information"
This configuration parameter is only relevant when using the Classic edition of Dyalog on the UNIX and macOS operating systems.

An output translate table that overrides [`APLT`](aplt.md), if set. The name ends with a digit (for example `APLT0`), so that more than one can be defined. It takes precedence over the table implied by the terminal type.

Valid values are the name of an output translate table.
<!-- REVIEW(default): default value not present in the migrated source; confirm the naming convention. -->

Related parameters: [APLT](aplt.md), [APLTrans](apltrans.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# APLTrans

!!! Info "Information"
This configuration parameter is only relevant when using the Classic edition of Dyalog.

A search path for the Output Translate Table, useful when configuring a run-time application. Directory paths use the operating system's conventions and are separated by `;` (Windows) or `:` (UNIX and macOS).

Valid values are a list of directory paths.

Default is the `apltrans` sub-directory of the Dyalog installation directory (given by [`Dyalog`](dyalog.md)).

On UNIX and macOS, if this parameter is unset the search path defaults to the directory given by [`Dyalog`](dyalog.md); if that is also unset, it defaults to `/usr/dyalog`.
<!-- REVIEW(default): reconcile the Microsoft Windows default (apltrans sub-directory) with the UNIX and macOS default (the Dyalog directory, else /usr/dyalog). -->

Related parameters: [APLT](aplt.md), [Dyalog](dyalog.md).

See also the [Output tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-output-tab-classic-edition-only) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Auto_PW

Whether the value of [`⎕PW`](../../../language-reference-guide/system-functions/pw) is derived automatically from the current width of the Session (Windows) or terminal (UNIX and macOS) window.

Valid values are:

- `0` : `⎕PW` is independent of the window width
- `1` : `⎕PW` changes whenever the window is resized, reflecting the number of characters that fit on one line

Default depends on operating system:

- Microsoft Windows: `0`
- UNIX and macOS: when unset, behaves as `1` (`⎕PW` tracks the terminal width, updated when the interpreter next checks for input)

Related parameters: [Default_PW](default-pw.md).

See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AutoComplete/CancelKey1

The first of two possible keys that cancel (hide) the AutoComplete suggestion box.

Valid values are a key code.

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

Related parameters: [AutoComplete/CancelKey2](cancelkey2.md).

See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AutoComplete/CancelKey2

The second of two possible keys that cancel (hide) the AutoComplete suggestion box.

Valid values are a key code.

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

Related parameters: [AutoComplete/CancelKey1](cancelkey1.md).

See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AutoComplete/Cols

The maximum number of columns (width) in the AutoComplete pop-up suggestion box.

Valid values are a positive integer.

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

Related parameters: [AutoComplete/Rows](rows.md).

See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# AutoComplete/CommonKey1

The key that auto-completes the *common prefix*: the longest string of leading characters of the currently selected name that is shared by at least one other name in the AutoComplete suggestion box.

Valid values are a key code.

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AutoComplete/CompleteKey1

The first of two possible keys that select the current option from the AutoComplete suggestion box.

Valid values are a key code.

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

Related parameters: [AutoComplete/CompleteKey2](completekey2.md).

See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AutoComplete/CompleteKey2

The second of two possible keys that select the current option from the AutoComplete suggestion box.

Valid values are a key code.

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

Related parameters: [AutoComplete/CompleteKey1](completekey1.md).

See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AutoComplete/Enabled

Whether AutoComplete is enabled.

Valid values are:

- `0` : AutoComplete is disabled
- `1` : AutoComplete is enabled

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# AutoComplete/History

Whether AutoComplete maintains a list of previous auto-completions.

Valid values are:

- `0` : no history is kept
- `1` : a history of previous auto-completions is kept

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

Related parameters: [AutoComplete/HistorySize](historysize.md).

See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# AutoComplete/HistorySize

The number of previous auto-completions kept when [`AutoComplete/History`](history.md) is `1`.

Valid values are a positive integer.

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

Related parameters: [AutoComplete/History](history.md).

See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# AutoComplete/PrefixSize

The threshold, in number of characters entered, before AutoComplete begins to display suggestions.

Valid values are a non-negative integer.

<!-- REVIEW(default): default value not present in the migrated source; confirm. -->

See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog.
Loading