missing rocketsh vars

Author: braindigitalis

docpages/user-guide/commands/rocketsh.md

@@ -117,3 +117,28 @@ Display version and copyright information for the shell.
 ```basic
 version
 ```
+
+### Variables
+
+The rocketsh shell allows you to change certain variables that influence how the shell operates. These are:
+
+#### PATH$
+
+The `PATH$` variable is a list of directories that are searched for programs to run them. Each path in PATH$ (separated
+by semicolons, ';') is prepended to the command line to try and match a file. If a match is found by prepending this search
+path, the program is executed. So for example if your program is located at `/programs/tasks/foo` and you type `tasks/foo`,
+with the path containing `/programs`, the program will be found and ran. Note this is slightly different from how paths operate
+in other operating systems. The current directory cannot be included in the path as it has no direct representation.
+
+If you want to run a program that is not in the path, you must provide the full path to the program from the file system root.
+
+#### LIB$
+
+This is the path where system libraries may be found. There can be only one active library path. Programs may optionally
+use this global variable when loading their libraries, but it is not mandatory to do so, for example if a program wishes to
+load its own libraries from some non-standard location.
+
+#### PROMPT$
+
+Changing the `PROMPT$` variable changes the displayed prompt of the shell to whatever you want. By default, `PROMPT$` has
+the value `"ROCKETSH"`. Changing `PROMPT$` to an empty string will cause it to display just `>`, like the BBC Micro.

docs/ERROR.html

@@ -107,7 +107,7 @@
 </ul>
 <dl class="section remark"><dt>Remarks</dt><dd><span class="tt">ERR</span> and <span class="tt">ERR$</span> are described on the </dd>
 <dd>
-<a class="el" href="variables.html">Variable Types</a> page.</dd></dl>
+<a class="el" href="rocketsh.html#variables">Variables</a> page.</dd></dl>
 <hr  />
 <h3 class="doxsection"><a class="anchor" id="examples-127"></a>
 Examples</h3>

docs/basic-ref.html

@@ -106,7 +106,7 @@
 </li>
 <li><b>Sequential execution.</b> Programs execute line by line, top to bottom, unless redirected with control statements (e.g. <span class="tt">GOTO</span>, <span class="tt">IF</span>, <span class="tt">PROC</span>, <span class="tt">FUNCTION</span>).</li>
 <li><b>Statements.</b> Each line must contain at least one valid statement, with any required parameters.</li>
-<li><b>Variables.</b> Four types of variables are available (see <a class="el" href="variables.html">Variable Types</a>). Variables may be:<ul>
+<li><b>Variables.</b> Four types of variables are available (see <a class="el" href="rocketsh.html#variables">Variables</a>). Variables may be:<ul>
 <li><b>Local</b> to the current program, or</li>
 <li><b>Inherited</b> by other programs run with <span class="tt">CHAIN</span> or similar mechanisms.</li>
 </ul>
@@ -117,7 +117,7 @@
 <p><b>Further Reference</b></p>
 <ul>
 <li><a class="el" href="basic-beginner.html">Beginners' Tutorial</a></li>
-<li><a class="el" href="variables.html">Variable Types</a></li>
+<li><a class="el" href="rocketsh.html#variables">Variables</a></li>
 <li><a class="el" href="keywords.html">Keywords</a></li>
 <li><a class="el" href="builtin-functions.html">Built-In Functions</a></li>
 <li><a class="el" href="audio-basics.html">Audio Introduction</a></li>

docs/doxygen_crawl.html

@@ -942,7 +942,7 @@
 <a href="glossary.html#network-interface"/>
 <a href="glossary.html#pixel-art"/>
 <a href="glossary.html#program"/>
-<a href="glossary.html#prompt"/>
+<a href="glossary.html#prompt-1"/>
 <a href="glossary.html#prompt-string"/>
 <a href="glossary.html#ram-disk"/>
 <a href="glossary.html#retrofs"/>
@@ -1105,11 +1105,15 @@
 <a href="rocketsh.html#built-in-commands"/>
 <a href="rocketsh.html#cd--chdir"/>
 <a href="rocketsh.html#command-line-entry"/>
+<a href="rocketsh.html#lib"/>
 <a href="rocketsh.html#multi-line-program-entry"/>
+<a href="rocketsh.html#path"/>
+<a href="rocketsh.html#prompt"/>
 <a href="rocketsh.html#rocket-shell-commands"/>
 <a href="rocketsh.html#run"/>
 <a href="rocketsh.html#task"/>
 <a href="rocketsh.html#up"/>
+<a href="rocketsh.html#variables"/>
 <a href="rocketsh.html#version"/>
 <a href="saving-your-work.html"/>
 <a href="saving-your-work.html#installed-system"/>

docs/glossary.html

@@ -118,7 +118,7 @@ <h3 class="doxsection"><a class="anchor" id="mount"></a>
 <h3 class="doxsection"><a class="anchor" id="program"></a>
 Program</h3>
 <p>A file written in BASIC that Retro Rocket can run. Programs live in <span class="tt">/programs</span>.</p>
-<h3 class="doxsection"><a class="anchor" id="prompt"></a>
+<h3 class="doxsection"><a class="anchor" id="prompt-1"></a>
 Prompt</h3>
 <p>The <span class="tt">&gt;</span> symbol you see in the shell where you type commands.</p>
 <h3 class="doxsection"><a class="anchor" id="ram-disk"></a>

docs/rocketsh.html

@@ -174,7 +174,20 @@ <h4 class="doxsection"><a class="anchor" id="version"></a>
 version</h4>
 <p>Display version and copyright information for the shell.</p>
 <div class="fragment"><div class="line">version</div>
-</div><!-- fragment --> </div></div><!-- contents -->
+</div><!-- fragment --><h3 class="doxsection"><a class="anchor" id="variables"></a>
+Variables</h3>
+<p>The rocketsh shell allows you to change certain variables that influence how the shell operates. These are:</p>
+<h4 class="doxsection"><a class="anchor" id="path"></a>
+PATH$</h4>
+<p>The <span class="tt">PATH$</span> variable is a list of directories that are searched for programs to run them. Each path in PATH$ (separated by semicolons, ';') is prepended to the command line to try and match a file. If a match is found by prepending this search path, the program is executed. So for example if your program is located at <span class="tt">/programs/tasks/foo</span> and you type <span class="tt">tasks/foo</span>, with the path containing <span class="tt">/programs</span>, the program will be found and ran. Note this is slightly different from how paths operate in other operating systems. The current directory cannot be included in the path as it has no direct representation.</p>
+<p>If you want to run a program that is not in the path, you must provide the full path to the program from the file system root.</p>
+<h4 class="doxsection"><a class="anchor" id="lib"></a>
+LIB$</h4>
+<p>This is the path where system libraries may be found. There can be only one active library path. Programs may optionally use this global variable when loading their libraries, but it is not mandatory to do so, for example if a program wishes to load its own libraries from some non-standard location.</p>
+<h4 class="doxsection"><a class="anchor" id="prompt"></a>
+PROMPT$</h4>
+<p>Changing the <span class="tt">PROMPT$</span> variable changes the displayed prompt of the shell to whatever you want. By default, <span class="tt">PROMPT$</span> has the value <span class="tt">"ROCKETSH"</span>. Changing <span class="tt">PROMPT$</span> to an empty string will cause it to display just <span class="tt">&gt;</span>, like the BBC Micro. </p>
+</div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

docs/search/all_14.js

@@ -20,49 +20,50 @@ var searchData=
   ['level_20layout_20informative_17',['2. High-level layout (informative)',['../retrofs.html#autotoc_md2-high-level-layout-informative',1,'']]],
   ['lgetlastcpuid_20function_18',['LGETLASTCPUID Function',['../LGETLASTCPUID.html',1,'int-funcs']]],
   ['lgetlastcpuid_2emd_19',['LGETLASTCPUID.md',['../LGETLASTCPUID_8md.html',1,'']]],
-  ['libraries_20',['Libraries',['../libraries.html#available-libraries',1,'Available Libraries'],['../libraries.html',1,'Libraries']]],
-  ['library_21',['Library',['../ansi.html',1,'ANSI Library'],['../http.html',1,'HTTP Library'],['../mouse.html',1,'Mouse Library']]],
-  ['library_20keyword_22',['LIBRARY Keyword',['../LIBRARY.html',1,'keywords']]],
-  ['library_2emd_23',['LIBRARY.md',['../LIBRARY_8md.html',1,'']]],
-  ['lifecycle_24',['Module Lifecycle',['../modules.html#module-lifecycle',1,'']]],
-  ['lifecycle_20scheduler_20handshake_25',['Program lifecycle & scheduler handshake',['../basic-intdev.html#program-lifecycle--scheduler-handshake',1,'']]],
-  ['like_20a_20phone_20call_20reliable_20conversation_26',['TCP - Like a Phone Call (reliable conversation)',['../networking.html#tcp---like-a-phone-call-reliable-conversation',1,'']]],
-  ['like_20operations_27',['Arrays & list-like operations',['../basic-intdev.html#arrays--list-like-operations',1,'']]],
-  ['like_20sending_20a_20parcel_20quick_20independent_20messages_28',['UDP - Like Sending a Parcel (quick, independent messages)',['../networking.html#udp---like-sending-a-parcel-quick-independent-messages',1,'']]],
-  ['line_20endings_29',['Separators and line endings',['../PRINT.html#separators-and-line-endings',1,'']]],
-  ['line_20entry_30',['Command line entry',['../rocketsh.html#command-line-entry',1,'']]],
-  ['line_20keyword_31',['LINE Keyword',['../LINE.html',1,'keywords']]],
-  ['line_20numbering_20auto_20number_20and_20execution_32',['Line numbering, auto-number, and execution',['../basic-intdev.html#line-numbering-auto-number-and-execution',1,'']]],
-  ['line_20numbers_20permitted_33',['Example: simple subroutine (line numbers permitted)',['../GOSUB.html#example-simple-subroutine-line-numbers-permitted',1,'']]],
-  ['line_20program_20entry_34',['Multi-line program entry',['../rocketsh.html#multi-line-program-entry',1,'']]],
-  ['line_2emd_35',['LINE.md',['../LINE_8md.html',1,'']]],
-  ['linux_36',['Linux',['../creating-boot-media.html#linux',1,'']]],
-  ['linux_20advanced_37',['Linux (advanced)',['../creating-boot-media.html#linux-advanced',1,'']]],
-  ['linux_20recommended_20tools_38',['Linux (recommended tools)',['../creating-boot-media.html#linux-recommended-tools',1,'']]],
-  ['list_20command_39',['list command',['../list.html',1,'commands']]],
-  ['list_20full_20pathname_40',['list [full pathname]',['../list.html#list-full-pathname',1,'']]],
-  ['list_20like_20operations_41',['Arrays & list-like operations',['../basic-intdev.html#arrays--list-like-operations',1,'']]],
-  ['list_2emd_42',['list.md',['../list_8md.html',1,'']]],
-  ['live_43',['Where programs live',['../working-with-programs.html#where-programs-live',1,'']]],
-  ['livecd_44',['LiveCD',['../glossary.html#livecd',1,'']]],
-  ['livecd_20mode_45',['LiveCD mode',['../saving-your-work.html#livecd-mode',1,'']]],
-  ['livecd_20or_20liveusb_46',['1. Boot the LiveCD or LiveUSB',['../installation.html#autotoc_md1-boot-the-livecd-or-liveusb',1,'']]],
-  ['liveusb_47',['1. Boot the LiveCD or LiveUSB',['../installation.html#autotoc_md1-boot-the-livecd-or-liveusb',1,'']]],
-  ['ljust_24_20function_48',['LJUST$ Function',['../LJUST.html',1,'string-funcs']]],
-  ['ljust_2emd_49',['LJUST.md',['../LJUST_8md.html',1,'']]],
-  ['load_50',['SOUND LOAD',['../SOUND.html#sound-load',1,'']]],
-  ['load_20newline_20separated_20integers_20from_20a_20file_51',['Example: load newline-separated integers from a file',['../DATA.html#example-load-newline-separated-integers-from-a-file',1,'']]],
-  ['loader_20pipeline_52',['Loader Pipeline',['../modules.html#loader-pipeline',1,'']]],
-  ['local_20keyword_53',['LOCAL Keyword',['../LOCAL.html',1,'keywords']]],
-  ['local_2emd_54',['LOCAL.md',['../LOCAL_8md.html',1,'']]],
-  ['locals_20within_20a_20definition_55',['Example: locals within a definition',['../DEF.html#example-locals-within-a-definition',1,'']]],
-  ['log_20function_56',['LOG Function',['../LOG.html',1,'real-funcs']]],
-  ['log_2emd_57',['LOG.md',['../LOG_8md.html',1,'']]],
-  ['logo_20and_20system_20info_20scrolling_20with_20text_58',['Example: Keep a logo and system info scrolling with text',['../SCROLLREGION.html#example-keep-a-logo-and-system-info-scrolling-with-text',1,'']]],
-  ['loop_20scope_59',['Loop scope',['../ENDPROC.html#loop-scope',1,'Loop scope'],['../RETURN.html#loop-scope-1',1,'Loop scope']]],
-  ['loopback_60',['Loopback',['../glossary.html#loopback',1,'']]],
-  ['lower_24_20function_61',['LOWER$ Function',['../LOWER.html',1,'string-funcs']]],
-  ['lower_2emd_62',['LOWER.md',['../LOWER_8md.html',1,'']]],
-  ['ltrim_24_20function_63',['LTRIM$ Function',['../LTRIM.html',1,'string-funcs']]],
-  ['ltrim_2emd_64',['LTRIM.md',['../LTRIM_8md.html',1,'']]]
+  ['lib_24_20',['LIB$',['../rocketsh.html#lib',1,'']]],
+  ['libraries_21',['Libraries',['../libraries.html#available-libraries',1,'Available Libraries'],['../libraries.html',1,'Libraries']]],
+  ['library_22',['Library',['../ansi.html',1,'ANSI Library'],['../http.html',1,'HTTP Library'],['../mouse.html',1,'Mouse Library']]],
+  ['library_20keyword_23',['LIBRARY Keyword',['../LIBRARY.html',1,'keywords']]],
+  ['library_2emd_24',['LIBRARY.md',['../LIBRARY_8md.html',1,'']]],
+  ['lifecycle_25',['Module Lifecycle',['../modules.html#module-lifecycle',1,'']]],
+  ['lifecycle_20scheduler_20handshake_26',['Program lifecycle & scheduler handshake',['../basic-intdev.html#program-lifecycle--scheduler-handshake',1,'']]],
+  ['like_20a_20phone_20call_20reliable_20conversation_27',['TCP - Like a Phone Call (reliable conversation)',['../networking.html#tcp---like-a-phone-call-reliable-conversation',1,'']]],
+  ['like_20operations_28',['Arrays & list-like operations',['../basic-intdev.html#arrays--list-like-operations',1,'']]],
+  ['like_20sending_20a_20parcel_20quick_20independent_20messages_29',['UDP - Like Sending a Parcel (quick, independent messages)',['../networking.html#udp---like-sending-a-parcel-quick-independent-messages',1,'']]],
+  ['line_20endings_30',['Separators and line endings',['../PRINT.html#separators-and-line-endings',1,'']]],
+  ['line_20entry_31',['Command line entry',['../rocketsh.html#command-line-entry',1,'']]],
+  ['line_20keyword_32',['LINE Keyword',['../LINE.html',1,'keywords']]],
+  ['line_20numbering_20auto_20number_20and_20execution_33',['Line numbering, auto-number, and execution',['../basic-intdev.html#line-numbering-auto-number-and-execution',1,'']]],
+  ['line_20numbers_20permitted_34',['Example: simple subroutine (line numbers permitted)',['../GOSUB.html#example-simple-subroutine-line-numbers-permitted',1,'']]],
+  ['line_20program_20entry_35',['Multi-line program entry',['../rocketsh.html#multi-line-program-entry',1,'']]],
+  ['line_2emd_36',['LINE.md',['../LINE_8md.html',1,'']]],
+  ['linux_37',['Linux',['../creating-boot-media.html#linux',1,'']]],
+  ['linux_20advanced_38',['Linux (advanced)',['../creating-boot-media.html#linux-advanced',1,'']]],
+  ['linux_20recommended_20tools_39',['Linux (recommended tools)',['../creating-boot-media.html#linux-recommended-tools',1,'']]],
+  ['list_20command_40',['list command',['../list.html',1,'commands']]],
+  ['list_20full_20pathname_41',['list [full pathname]',['../list.html#list-full-pathname',1,'']]],
+  ['list_20like_20operations_42',['Arrays & list-like operations',['../basic-intdev.html#arrays--list-like-operations',1,'']]],
+  ['list_2emd_43',['list.md',['../list_8md.html',1,'']]],
+  ['live_44',['Where programs live',['../working-with-programs.html#where-programs-live',1,'']]],
+  ['livecd_45',['LiveCD',['../glossary.html#livecd',1,'']]],
+  ['livecd_20mode_46',['LiveCD mode',['../saving-your-work.html#livecd-mode',1,'']]],
+  ['livecd_20or_20liveusb_47',['1. Boot the LiveCD or LiveUSB',['../installation.html#autotoc_md1-boot-the-livecd-or-liveusb',1,'']]],
+  ['liveusb_48',['1. Boot the LiveCD or LiveUSB',['../installation.html#autotoc_md1-boot-the-livecd-or-liveusb',1,'']]],
+  ['ljust_24_20function_49',['LJUST$ Function',['../LJUST.html',1,'string-funcs']]],
+  ['ljust_2emd_50',['LJUST.md',['../LJUST_8md.html',1,'']]],
+  ['load_51',['SOUND LOAD',['../SOUND.html#sound-load',1,'']]],
+  ['load_20newline_20separated_20integers_20from_20a_20file_52',['Example: load newline-separated integers from a file',['../DATA.html#example-load-newline-separated-integers-from-a-file',1,'']]],
+  ['loader_20pipeline_53',['Loader Pipeline',['../modules.html#loader-pipeline',1,'']]],
+  ['local_20keyword_54',['LOCAL Keyword',['../LOCAL.html',1,'keywords']]],
+  ['local_2emd_55',['LOCAL.md',['../LOCAL_8md.html',1,'']]],
+  ['locals_20within_20a_20definition_56',['Example: locals within a definition',['../DEF.html#example-locals-within-a-definition',1,'']]],
+  ['log_20function_57',['LOG Function',['../LOG.html',1,'real-funcs']]],
+  ['log_2emd_58',['LOG.md',['../LOG_8md.html',1,'']]],
+  ['logo_20and_20system_20info_20scrolling_20with_20text_59',['Example: Keep a logo and system info scrolling with text',['../SCROLLREGION.html#example-keep-a-logo-and-system-info-scrolling-with-text',1,'']]],
+  ['loop_20scope_60',['Loop scope',['../ENDPROC.html#loop-scope',1,'Loop scope'],['../RETURN.html#loop-scope-1',1,'Loop scope']]],
+  ['loopback_61',['Loopback',['../glossary.html#loopback',1,'']]],
+  ['lower_24_20function_62',['LOWER$ Function',['../LOWER.html',1,'string-funcs']]],
+  ['lower_2emd_63',['LOWER.md',['../LOWER_8md.html',1,'']]],
+  ['ltrim_24_20function_64',['LTRIM$ Function',['../LTRIM.html',1,'string-funcs']]],
+  ['ltrim_2emd_65',['LTRIM.md',['../LTRIM_8md.html',1,'']]]
 ];