Skip to content

Commit 14c6cf8

Browse files
committed
Deployed 83bcbdc to 20.0 with MkDocs 1.5.3 and mike 2.0.0
1 parent e3cc25d commit 14c6cf8

File tree

24 files changed

+23
-23
lines changed

24 files changed

+23
-23
lines changed

20.0/language-reference-guide/system-commands/save/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71340,7 +71340,7 @@
7134071340

7134171341
<h1 class="heading"><span class="name">Save Workspace</span> <span class="command">)SAVE {-force} {ws}</span></h1>
7134271342

71343-
<p>This command compacts (see <a href="../../system-functions/wa/">"Workspace Available: "</a> for details) and saves the active workspace.</p>
71343+
<p>This command compacts (see <a href="../../system-functions/wa/">Workspace Available</a> for details) and saves the active workspace.</p>
7134471344
<p>If specified, <code>ws</code> is a full or relative path name to the file in which the workspace will be written. If <code>ws</code> is omitted, it defaults to <code>⎕WSID</code>. Unless the path specified by <code>ws</code> or <code>⎕WSID</code> is a full pathname, it is taken to be relative to the current working directory which may be obtained by the expression: <code>⊃1 ⎕NPARTS ''</code>.</p>
7134571345
<p>If <code>ws</code> specifies a file name other than that implied by <code>⎕WSID</code>, the specified file must not already exist unless the <strong>force</strong> parameter is specified.. If <code>ws</code> is omitted or resolves to the same file as <code>⎕WSID</code>, an existing stored workspace with the same name will be replaced.</p>
7134671346
<p>See <a href="../../../programming-reference-guide/introduction/workspaces">Programmer's Guide: "Workspaces"</a> for the rules for specifying a workspace name.</p>

20.0/language-reference-guide/system-commands/sh/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71340,7 +71340,7 @@
7134071340

7134171341
<h1 class="heading"><span class="name">Execute (UNIX) Command</span> <span class="command">)SH {cmd}</span></h1>
7134271342

71343-
<p>This command allows WINDOWS or UNIX shell commands to be given from APL.  <code>)SH</code> is a synonym of <code>)CMD</code>. Either command may be given in either environment (Windows or UNIX) with exactly the same effect.  <code>)SH</code> is probably more natural for the UNIX user. This section describes the behaviour of <code>)SH</code> and <code>)CMD</code> under UNIX. See <a href="../cmd/">"Windows Command Processor: "</a> for a discussion of their behaviour under Windows.</p>
71343+
<p>This command allows WINDOWS or UNIX shell commands to be given from APL.  <code>)SH</code> is a synonym of <code>)CMD</code>. Either command may be given in either environment (Windows or UNIX) with exactly the same effect.  <code>)SH</code> is probably more natural for the UNIX user. This section describes the behaviour of <code>)SH</code> and <code>)CMD</code> under UNIX. See <a href="../cmd/">Windows Command Processor</a> for a discussion of their behaviour under Windows.</p>
7134471344
<p>The system functions <a href="../../system-functions/execute-unix-command/"><code>⎕SH</code></a> and <a href="../../system-functions/execute-windows-command/"><code>⎕CMD</code></a> provide similar facilities but may be executed from within APL code. For further information, see <a href="../../system-functions/execute-unix-command/">Execute (UNIX) Command</a> and <a href="../../system-functions/execute-windows-command/">Execute Windows Command</a>.</p>
7134571345
<p><code>)SH</code> allows UNIX shell commands to be given from APL. The argument must be entered in the appropriate case (usually lower-case).  The result of the command, if any, is displayed.</p>
7134671346
<p><code>)SH</code> causes Dyalog to invoke the <code>system()</code> library call. The shell which is used to run the command is therefore the shell which <code>system()</code> is defined to call. For example, under AIX this would be <code>/usr/bin/sh</code>.</p>

20.0/language-reference-guide/system-functions/execute-unix-command/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71446,7 +71446,7 @@
7144671446

7144771447
<h1 class="heading"><span class="name">Execute (UNIX) Command</span> <span class="command">{R}←⎕SH Y</span></h1>
7144871448

71449-
<p><code>⎕SH</code> executes a UNIX shell or a Windows Command Processor.  <code>⎕SH</code> is a synonym of <code>⎕CMD</code>.  Either function may be used in either environment (UNIX or Windows) with exactly the same effect.  <code>⎕SH</code> is probably more natural for the UNIX user.  This section describes the behaviour of <code>⎕SH</code> and <code>⎕CMD</code> under UNIX.  See <a href="../execute-windows-command/">"Execute Windows Command: "</a> for a discussion of the behaviour of these system functions under Windows.</p>
71449+
<p><code>⎕SH</code> executes a UNIX shell or a Windows Command Processor.  <code>⎕SH</code> is a synonym of <code>⎕CMD</code>.  Either function may be used in either environment (UNIX or Windows) with exactly the same effect.  <code>⎕SH</code> is probably more natural for the UNIX user.  This section describes the behaviour of <code>⎕SH</code> and <code>⎕CMD</code> under UNIX.  See <a href="../execute-windows-command/">Execute Windows Command</a> for a discussion of the behaviour of these system functions under Windows.</p>
7145071450
<p>The system commands <a href="../../system-commands/sh/"><code>)SH</code></a> and <a href="../../system-commands/cmd/"><code>)CMD</code></a> provide similar facilities. For further information, see <a href="../../system-commands/sh/">Execute (UNIX) Command: </a> and <a href="../../system-commands/cmd/">Example</a>.</p>
7145171451
<p><code>Y</code> must be a simple character scalar or vector representing a UNIX shell command.  <code>R</code> is a nested vector of character vectors.</p>
7145271452
<p><code>Y</code> may be any acceptable UNIX command. If the command does not produce any output, <code>R</code> is <code>0⍴⊂''</code> but the result is suppressed if not explicitly used or assigned.  If the command has a non-zero exit code, then APL will signal a <code>DOMAIN ERROR</code>.  If the command returns a result and has a zero exit code, then each element of <code>R</code> will be a line from the standard output (stdout) of the command.  Output from standard error (stderr) is not captured unless redirected to stdout.</p>

20.0/language-reference-guide/system-functions/execute-windows-command/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71644,7 +71644,7 @@
7164471644

7164571645
<h1 class="heading"><span class="name">Execute Windows Command</span> <span class="command">{R}←⎕CMD Y</span></h1>
7164671646

71647-
<p><code>⎕CMD</code> executes the Windows Command Processor or UNIX shell or starts another Windows application program.  <code>⎕CMD</code> is a synonym of <code>⎕SH</code>.  Either system function may be used in either environment (Windows or UNIX) with exactly the same effect.  <code>⎕CMD</code> is probably more natural for the Windows user.  This section describes the behaviour of <code>⎕CMD</code> and <code>⎕SH</code> under Windows. See <a href="../execute-unix-command/">"Execute (UNIX) Command: "</a> for a discussion of the behaviour of these system functions under UNIX.</p>
71647+
<p><code>⎕CMD</code> executes the Windows Command Processor or UNIX shell or starts another Windows application program.  <code>⎕CMD</code> is a synonym of <code>⎕SH</code>.  Either system function may be used in either environment (Windows or UNIX) with exactly the same effect.  <code>⎕CMD</code> is probably more natural for the Windows user.  This section describes the behaviour of <code>⎕CMD</code> and <code>⎕SH</code> under Windows. See <a href="../execute-unix-command/">Execute (UNIX) Command</a> for a discussion of the behaviour of these system functions under UNIX.</p>
7164871648
<p>The system commands <a href="../../system-commands/sh/"><code>)SH</code></a> and <a href="../../system-commands/cmd/"><code>)CMD</code></a> provide similar facilities. For further information, see <a href="../../system-commands/sh/">Execute (UNIX) Command: </a> and <a href="../../system-commands/cmd/">Example</a>.</p>
7164971649
<p>See also <a href="../shell/"><code>⎕SHELL</code></a>.</p>
7165071650
<h2 id="executing-the-windows-command-processor">Executing the Windows Command Processor</h2>

20.0/language-reference-guide/system-functions/nq/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71350,7 +71350,7 @@ <h1 class="heading"><span class="name">Enqueue Event</span> <span class="command
7135071350
<p>This system function generates an event or invokes a method.</p>
7135171351
<p>While APL is executing, events occur "naturally" as a result of user action or of communication with other applications.  These events are added to the event queue as and when they occur, and are subsequently removed and processed one by one by <code>⎕DQ</code>.  <code>⎕NQ</code> provides an "artificial" means to generate an event and is analogous to <code>⎕SIGNAL</code>.</p>
7135271352
<p>If the left argument <code>X</code> is omitted or is 0, <code>⎕NQ</code> adds the event specified by <code>Y</code> to the bottom of the event queue. The event will subsequently be processed by <code>⎕DQ</code> when it reaches the top of the queue.</p>
71353-
<p>If <code>X</code> is 1, the event is actioned <strong>immediately</strong> by <code>⎕NQ</code> itself and is processed in exactly the same way as it would be processed by <code>⎕DQ</code>.  For example, if the event has a callback function attached, <code>⎕NQ</code> will invoke it directly. See <a href="../dq/">"Dequeue Events: "</a> for further details. If the event generates any subsidiary events (for example, a KeyPress might generate a GotFocus), the subsidiary events are added to the event queue rather than being executed immediately.</p>
71353+
<p>If <code>X</code> is 1, the event is actioned <strong>immediately</strong> by <code>⎕NQ</code> itself and is processed in exactly the same way as it would be processed by <code>⎕DQ</code>.  For example, if the event has a callback function attached, <code>⎕NQ</code> will invoke it directly. See <a href="../dq/">Dequeue Events</a> for further details. If the event generates any subsidiary events (for example, a KeyPress might generate a GotFocus), the subsidiary events are added to the event queue rather than being executed immediately.</p>
7135471354
<p>Note that it is not possible for one thread to use <code>1 ⎕NQ</code> to send an event to another thread.</p>
7135571355
<p>If <code>X</code> is 2 and the name supplied is the name of an event, <code>⎕NQ</code> performs the default processing for the event immediately, but does <strong>not</strong> invoke a callback function if there is one attached.</p>
7135671356
<p>If <code>X</code> is 2 and the name supplied is the name of a (Dyalog APL) method, <code>⎕NQ</code> invokes the method.  Its (shy) result is the result produced by the method.</p>

20.0/language-reference-guide/system-functions/start-unix-auxiliary-processor/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71346,7 +71346,7 @@
7134671346

7134771347
<h1 class="heading"><span class="name">Start UNIX Auxiliary Processor</span> <span class="command">{R}←X ⎕SH Y</span></h1>
7134871348

71349-
<p>Used dyadically, <code>⎕SH</code> starts an Auxiliary Processor. The effect, as far as the APL user is concerned, is identical under both Windows and UNIX although there are differences in the method of implementation. <code>⎕SH</code> is a synonym of <code>⎕CMD</code> Either function may be used in either environment (UNIX or Windows) with exactly the same effect. This section describes the behaviour of <code>⎕SH</code> and <code>⎕CMD</code> under UNIX. See <a href="../start-windows-auxiliary-processor/">"Start Windows Auxiliary Processor: "</a> for a discussion of the behaviour of these system functions under Windows.</p>
71349+
<p>Used dyadically, <code>⎕SH</code> starts an Auxiliary Processor. The effect, as far as the APL user is concerned, is identical under both Windows and UNIX although there are differences in the method of implementation. <code>⎕SH</code> is a synonym of <code>⎕CMD</code> Either function may be used in either environment (UNIX or Windows) with exactly the same effect. This section describes the behaviour of <code>⎕SH</code> and <code>⎕CMD</code> under UNIX. See <a href="../start-windows-auxiliary-processor/">Start Windows Auxiliary Processor</a> for a discussion of the behaviour of these system functions under Windows.</p>
7135071350
<p>Although it is still possible for users to create their own APs, Dyalog strongly recommends creating shared libraries/DLLs instead.</p>
7135171351
<p><code>X</code> must be a simple character vector. <code>Y</code> may be a simple character scalar or vector, or a nested character vector.</p>
7135271352
<p><code>⎕SH</code> loads the Auxiliary Processor from the file named by <code>X</code> using a search-path defined by the environment variable <code>WSPATH</code>.</p>

20.0/language-reference-guide/system-functions/system-functions-categorised/component-files/fchk/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71485,7 +71485,7 @@ <h3 id="specifying-options-using-a-left-argument">Specifying options using a lef
7148571485
</ul>
7148671486
<p>Following a <em>check</em> of the file, a non-null result indicates that the file is damaged.</p>
7148771487
<p>Following a <em>repair</em> of the file, the result indicates those components that could not be recovered. Un-recovered components will give a <code>FILE COMPONENT DAMAGED</code> error if read but may be replaced without error.</p>
71488-
<p>Repair can recover only check-summed components from the file, that is, only those components that were written with the checksum option enabled (see <a href="../fprops/">"File Properties: "</a>).</p>
71488+
<p>Repair can recover only check-summed components from the file, that is, only those components that were written with the checksum option enabled (see <a href="../fprops/">File Properties</a>).</p>
7148971489
<p>Following an operating system crash, repair may result in one or more individual components being rolled back to a previous version or not recovered at all, unless Journaling levels 2 or 3 were also set when these components were written.</p>
7149071490

7149171491

20.0/language-reference-guide/system-functions/system-functions-categorised/component-files/freplace/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71346,7 +71346,7 @@ <h1 class="heading"><span class="name">File Replace Component</span> <span class
7134671346

7134771347
<h2 id="access-code-16">Access code 16</h2>
7134871348
<p><code>Y</code> must be a simple 2 or 3 element integer vector containing the file tie number, the component number, and an optional passnumber. If the passnumber is omitted it is assumed to be zero. The component number specified must lie within the file's component number limits.</p>
71349-
<p><code>X</code> is any array (including, for example, the <code>⎕OR</code> of a namespace), and overwrites the value of the specified component. The component information (see <a href="../frdci/">"File Read Component Information: "</a>) is also updated.</p>
71349+
<p><code>X</code> is any array (including, for example, the <code>⎕OR</code> of a namespace), and overwrites the value of the specified component. The component information (see <a href="../frdci/">File Read Component Information</a>) is also updated.</p>
7135071350
<p>The shy result of <code>⎕FREPLACE</code> is the file index (component number of replaced record).</p>
7135171351
<h1 class="example">Example</h1>
7135271352
<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="nv">SALES</span><span class="kd">←</span><span class="nf">⎕FREAD</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">241</span>

20.0/language-reference-guide/system-functions/system-functions-categorised/gui-and-com-support/nq/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71326,7 +71326,7 @@ <h1 class="heading"><span class="name">Enqueue Event</span> <span class="command
7132671326
<p>This system function generates an event or invokes a method.</p>
7132771327
<p>While APL is executing, events occur "naturally" as a result of user action or of communication with other applications.  These events are added to the event queue as and when they occur, and are subsequently removed and processed one by one by <code>⎕DQ</code>.  <code>⎕NQ</code> provides an "artificial" means to generate an event and is analogous to <code>⎕SIGNAL</code>.</p>
7132871328
<p>If the left argument <code>X</code> is omitted or is 0, <code>⎕NQ</code> adds the event specified by <code>Y</code> to the bottom of the event queue. The event will subsequently be processed by <code>⎕DQ</code> when it reaches the top of the queue.</p>
71329-
<p>If <code>X</code> is 1, the event is actioned <strong>immediately</strong> by <code>⎕NQ</code> itself and is processed in exactly the same way as it would be processed by <code>⎕DQ</code>.  For example, if the event has a callback function attached, <code>⎕NQ</code> will invoke it directly. See <a href="../dq/">"Dequeue Events: "</a> for further details. If the event generates any subsidiary events (for example, a KeyPress might generate a GotFocus), the subsidiary events are added to the event queue rather than being executed immediately.</p>
71329+
<p>If <code>X</code> is 1, the event is actioned <strong>immediately</strong> by <code>⎕NQ</code> itself and is processed in exactly the same way as it would be processed by <code>⎕DQ</code>.  For example, if the event has a callback function attached, <code>⎕NQ</code> will invoke it directly. See <a href="../dq/">Dequeue Events</a> for further details. If the event generates any subsidiary events (for example, a KeyPress might generate a GotFocus), the subsidiary events are added to the event queue rather than being executed immediately.</p>
7133071330
<p>Note that it is not possible for one thread to use <code>1 ⎕NQ</code> to send an event to another thread.</p>
7133171331
<p>If <code>X</code> is 2 and the name supplied is the name of an event, <code>⎕NQ</code> performs the default processing for the event immediately, but does <strong>not</strong> invoke a callback function if there is one attached.</p>
7133271332
<p>If <code>X</code> is 2 and the name supplied is the name of a (Dyalog APL) method, <code>⎕NQ</code> invokes the method.  Its (shy) result is the result produced by the method.</p>

20.0/language-reference-guide/system-functions/system-functions-categorised/manipulating-functions-and-operators/refs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71322,7 +71322,7 @@
7132271322

7132371323
<h1 class="heading"><span class="name">Cross References</span> <span class="command">R←⎕REFS Y</span></h1>
7132471324

71325-
<p><code>Y</code> must be a simple character scalar or vector, identifying the name of a function or operator, or the object representation form of a function or operator (see <a href="../or/">"Object Representation: "</a>). <code>R</code> is a simple character matrix, with one name per row, of identified names in the function or operator in <code>Y</code> excluding distinguished names of system constants, variables or functions.</p>
71325+
<p><code>Y</code> must be a simple character scalar or vector, identifying the name of a function or operator, or the object representation form of a function or operator (see <a href="../or/">Object Representation</a>). <code>R</code> is a simple character matrix, with one name per row, of identified names in the function or operator in <code>Y</code> excluding distinguished names of system constants, variables or functions.</p>
7132671326
<h2 class="example">Example</h2>
7132771327
<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="nf">⎕VR</span><span class="s1">'OPTIONS'</span>
7132871328
<span class="w"> </span><span class="bp">∇</span><span class="w"> </span><span class="nv">OPTIONS</span><span class="sr">;</span><span class="nv">OPTS</span><span class="sr">;</span><span class="nv">INP</span>

0 commit comments

Comments
 (0)