<!-- Generated by Harlequin WebMaker 2.2.3 (23-Apr-1996)
LispWorks 3.2.2 -->
<HTML> <HEAD>
<TITLE>Appendix&nbsp;B</B>:  Useful star commands</TITLE>
</HEAD>
<BODY bgcolor="#ffffff">
<A NAME=HEADING3> </A>
<A HREF="BOOK3_6.HT"><IMG ALIGN=BOTTOM SRC="next" WIDTH=69 HEIGHT=24></A> <A HREF="BOOK3_2.HT"><IMG ALIGN=BOTTOM SRC="prev" WIDTH=69 HEIGHT=24></A> <A HREF="../BOOKB/USERGUIDE"><IMG ALIGN=BOTTOM SRC="top" WIDTH=69 HEIGHT=24></A> <A HREF="../BOOKB/TOC.HTM"><IMG ALIGN=BOTTOM SRC="content" WIDTH=69 HEIGHT=24></A> <A HREF="../INDEX/MAIN.HTM"><IMG ALIGN=BOTTOM SRC="index" WIDTH=69 HEIGHT=24></A><P>
RISC OS 3.7 User Guide<P>
<A NAME=HEADING3-0> </A>
<HR>
<H1>Appendix B</B>:  <A NAME=MARKER-9-1> </A>Useful star commands</H1>
<HR>
This chapter provides a short list of useful star commands which you may need to reconfigure your computer or recover from a crash. There is an alphabetical list of every * Command available under RISC OS 3 in the file<CODE> StarComms </CODE>in the directory<CODE> Tutorials</CODE>. It does not contain * Commands provided by the addition of expansion cards or extra filing systems.<P>
<A NAME=MARKER-2-2> </A>Each command is followed by a short explanation of its function and its command syntax. All of these commands are explained in greater detail in the <I>RISC OS Programmer's Reference Manual</I>. One very useful command is *Status (see <A HREF=#MARKER-9-59>page 426</A>).<P>
<A NAME=HEADING3-3> </A>
<H2> <A NAME=MARKER-2-3> </A>Command syntax</H2>
The <A NAME=MARKER-2-4> </A>syntax of each command in the following sections is described in a standard way. The symbols used in syntax descriptions are</B>:<P>
<CODE>&lt;value&gt;</CODE>  indicate that an actual value must be substituted. For example, &lt;<CODE>filename&gt;</CODE> means that you must supply an actual filename.<P>
[...]  indicate that the item enclosed in the square brackets is optional.<P>
|  indicates alternatives. For example,<CODE> </CODE>0 | 1 means that the value 0 or 1 must be supplied.<P>
<A NAME=HEADING3-8> </A>
<H2> Useful star commands</H2>
<A NAME=HEADING3-9> </A>
<H3> <A NAME=MARKER-2-5> </A>*Access</H3>
*Access changes the attributes of all objects matching the wildcard specification. These attributes control whether you can run, read from, write to and delete a file.<P>
Valid attributes</B>:<P><CODE>L</CODE>   : lock object against deletion by any user<P><CODE>W</CODE>    : write permission for you<P><CODE>R</CODE>   <A NAME=MARKER-2-6> </A>: read <A NAME=MARKER-2-7> </A>permission for you<P><CODE>/</CODE>    : separator between your permissions and the public's<P><CODE>W</CODE>     : write permission for the public (on a network)<P><CODE>R</CODE>   : read permission for the public (on a network)<P>
*Access &lt;object_spec&gt; [&lt;attributes&gt;]<P>
<A NAME=HEADING3-14> </A>
<H3> <A NAME=MARKER-2-8> </A>*ADFS</H3>
*<A NAME=MARKER-2-9> </A>ADFS selects the Advanced Disc Filing System as the <A NAME=MARKER-2-10> </A>current filing system.<P>
*ADFS<P>
<A NAME=HEADING3-17> </A>
<H3> <A NAME=MARKER-2-11> </A>*CDFS</H3>
*<A NAME=MARKER-2-12> </A>CDFS selects the <A NAME=MARKER-2-13> </A>CD-ROM Filing System as the current filing system. This command is only available if you have a CD-ROM drive fitted.<P>
*CDFS<P>
<A NAME=HEADING3-20> </A>
<H3> <A NAME=MARKER-2-14> </A>*CheckMap</H3>
*CheckMap checks that the <A NAME=MARKER-2-15> </A>map of an E- or F-format disc has the correct checksums and is consistent with the directory tree. If only one copy of the map is good, it allows you to rewrite the bad one with the information in the good one.<P>
*CheckMap [&lt;disc_spec&gt;]<P>
If the map information cannot be cured, you should backup all of your files and then reformat your hard disc. Contact your supplier for more information.<P>
<A NAME=HEADING3-24> </A>
<H3> <A NAME=MARKER-2-16> </A>*Close</H3>
*<A NAME=MARKER-2-17> </A>Close closes all open files on the current filing system.<P>
*Close<P>
<A NAME=HEADING3-27> </A>
<H3> <A NAME=MARKER-2-18> </A>*Configure Boot|NoBoot</H3>
*Configure Boot (the default setting) sets the configured boot action so that a power on, reset or Ctrl Break runs a boot file.<P>
*Configure NoBoot sets the configured boot action so that a Shift power on, Shift reset or Shift Break runs a boot file.<P>
*Configure Boot|NoBoot<P>
<A NAME=HEADING3-31> </A>
<H3> *Configure Drive</H3>
*Configure Drive sets the configured number of the <A NAME=MARKER-2-19> </A>drive that is selected at power on.<P>
*Configure Drive <CODE>&lt;n&gt;</CODE><P>
<A NAME=HEADING3-34> </A>
<H3> *Configure FileSystem</H3>
*Configure FileSystem sets the configured <A NAME=MARKER-2-20> </A>filing system to be used at power on or hard reset.<P>
*Configure FileSystem &lt;fs_name&gt;|&lt;fs_number&gt;<P>
<A NAME=HEADING3-37> </A>
<H3> *Configure Floppies</H3>
*Configure Floppies sets the <A NAME=MARKER-2-21> </A>configured number of floppy disc drives recognised at power on.<P>
*Configure Floppies <CODE>&lt;n&gt;</CODE><P>
<A NAME=HEADING3-40> </A>
<H3> *Configure IDEDiscs</H3>
*Configure IDEDiscs sets the <A NAME=MARKER-2-22> </A>configured number of IDE hard disc drives recognised at power on. <P>
*Configure IDEDiscs <CODE>&lt;n&gt;</CODE><P>
<A NAME=HEADING3-43> </A>
<H3> *Configure Language</H3>
*Configure Language sets the <A NAME=MARKER-2-23> </A>configured language used at power on.<P>
*Configure Language <CODE>&lt;module_no&gt;</CODE><P>
<A NAME=HEADING3-46> </A>
<H3> <A NAME=MARKER-9-24> </A>*Configure MouseType</H3>
<A NAME=MARKER-2-25> </A>*Configure MouseType sets the configured pointer device to be used thereafter. Device types are 0 (Acorn quadrature mouse), 1 (Microsoft serial mouse), 2 (Mouse Systems serial mouse), or 3 (PS/2 serial mouse).<P>
*Configure MouseType <CODE>&lt;</CODE>device_type&gt;<P>
<A NAME=HEADING3-49> </A>
<H3> <A NAME=MARKER-9-26> </A>*Configure Truncate</H3>
*Configure Truncate sets the configured value for whether or not filenames are <A NAME=MARKER-2-27> </A>truncated when too long for a filing system to handle.<P>
*Configure Truncate On|Off<A NAME=MARKER-2-28> </A><P>
<A NAME=HEADING3-52> </A>
<H3> <A NAME=MARKER-9-29> </A>*Create</H3>
*Create reserves space for a new file. No data is transferred to the file. The optional load and execution addresses and length are in hexadecimal.<P>
*Create &lt;filename&gt; [&lt;length&gt; [&lt;exec_addr&gt; [&lt;load_addr&gt;]]]<P>
<A NAME=HEADING3-55> </A>
<H3> <A NAME=MARKER-9-30> </A>*Defect<A NAME=MARKER-2-31> </A></H3>
*Defect reports what object contains a <A NAME=MARKER-2-32> </A>defect, or (if none) marks the defective part of the disc so it will no longer be used.<P>
*Defect &lt;disc_spec&gt; &lt;disc_addr&gt;<P>
<A NAME=HEADING3-58> </A>
<H3> <A NAME=MARKER-9-33> </A>*DOSMap<A NAME=MARKER-2-34> </A></H3>
*DOSMap specifies a mapping between an MS-DOS extension and a RISC OS file type. If the only parameter given is an MS-DOS extension, then the mapping (if any) for that extension is cancelled. If no parameter is given, then all current mappings are listed.<P>
The mappings are only retained until the next reset.<P>
*DOSMap [&lt;MS-DOS_extension&gt; [&lt;file_type&gt;]]<P>
<A NAME=HEADING3-62> </A>
<H3> <A NAME=MARKER-2-35> </A>*FSLock_Unlock</H3>
*FSLock_Unlock <A NAME=MARKER-2-36> </A>unlocks the computer, so you can alter its CMOS RAM and hard disc. If the <CODE>-full</CODE> switch is not given then the computer will only be unlocked until it is next reset.<P>
*FSLock_Unlock [-full] [&lt;password&gt;]<P>
<A NAME=HEADING3-65> </A>
<H3> <A NAME=MARKER-2-37> </A>*Help</H3>
*<A NAME=MARKER-2-38> </A>Help gives brief information about each command. There are also some special keywords</B>: <P>
*Help Commands : lists all available utility commands<P>
*Help FileCommands : lists all the command relating to filing systems<P>
*Help Modules : lists the names of all currently loaded modules, with their version numbers and creation dates<P>
*Help Station : displays the current network and station numbers of your machine<P>
*Help Syntax : explains the format used for syntax messages<P>

<CODE>*Help [&lt;keyword&gt;]</CODE> <P>
<A NAME=HEADING3-68> </A>
<H3> <A NAME=MARKER-2-39> </A>*List</H3>
*List displays the contents of the named file using the configured DumpFormat. Each line is numbered.<P>
*List [-File] &lt;filename&gt; [-TabExpand]<P>
<A NAME=HEADING3-71> </A>
<H3> <A NAME=MARKER-2-40> </A>*Opt 4</H3>
*Opt 4 sets the boot action for the current filing system</B>:<P>
*Opt 4,0 : no boot action<P>
*Opt 4,1 : *Load boot file<P>
*Opt 4,2 : *Run boot file<P>
*Opt 4,3 : *Exec boot file<P>

<CODE>*Opt 4 [[,]&lt;n&gt;]</CODE><P>
<A NAME=HEADING3-74> </A>
<H3> <A NAME=MARKER-2-41> </A>*Podules</H3>
*Podules displays a list of the installed <A NAME=MARKER-2-42> </A>expansion cards and extension ROMs.<P>
*Podules<P>
<A NAME=HEADING3-77> </A>
<H3> <A NAME=MARKER-2-43> </A>*Ram</H3>
*Ram selects the <A NAME=MARKER-2-44> </A>RAM filing system as the current filing system.<P>
*Ram<P>
<A NAME=HEADING3-80> </A>
<H3> <A NAME=MARKER-2-45> </A>*ResourceFS</H3>
*ResourceFS <A NAME=MARKER-2-46> </A>selects the Resource Filing System as the current filing system.<P>
*ResourceFS<P>
<A NAME=HEADING3-83> </A>
<H3> <A NAME=MARKER-2-47> </A>*RMKill</H3>
*RMKill deactivates and deletes a relocatable <A NAME=MARKER-2-48> </A>module. Use this command only with extreme caution, as it may be drastic in its effects. <P>
*RMKill &lt;module_title&gt;[&lt;%instantiation&gt;]<P>
<A NAME=HEADING3-86> </A>
<H3> <A NAME=MARKER-2-49> </A>*RMReInit</H3>
*RMReInit reinitialises a relocatable <A NAME=MARKER-2-50> </A>module, reversing the action of any previous *RMKill or *Unplug command. Use this command only with extreme caution, as it may be drastic in its effects. <P>
*RMReInit &lt;module_title&gt; [&lt;module_init_string&gt;]<P>
<A NAME=HEADING3-89> </A>
<H3> <A NAME=MARKER-2-51> </A>*ScreenLoad</H3>
*ScreenLoad loads the contents of a <A NAME=MARKER-2-52> </A>sprite file into the graphics window.<P>
*ScreenLoad <CODE>&lt;filename&gt;</CODE><P>
<A NAME=HEADING3-92> </A>
<H3> <A NAME=MARKER-2-53> </A>*ScreenSave</H3>
*ScreenSave saves the contents of the graphics window and its palette to a file.<P>
*ScreenSave &lt;filename&gt;<P>
<A NAME=HEADING3-95> </A>
<H3> <A NAME=MARKER-2-54> </A>*SCSI</H3>
*SCSI selects the <A NAME=MARKER-2-55> </A>SCSI Filing System as the current filing system. This command is only available if you have a SCSI expansion card fitted.<P>
*SCSI<P>
<A NAME=HEADING3-98> </A>
<H3> <A NAME=MARKER-2-56> </A>*Shut</H3>
*Shut closes all open files on all filing systems.<P>
*Shut<P>
<A NAME=HEADING3-101> </A>
<H3> <A NAME=MARKER-2-57> </A>*ShutDown</H3>
*ShutDown closes all open files on all filing systems, logs off all network file servers, and parks hard disc heads.<P>
*ShutDown<P>
<A NAME=HEADING3-104> </A>
<H3> <A NAME=MARKER-2-58> </A><A NAME=MARKER-9-59> </A>*Status</H3>
*Status displays the value of a configuration option in the <A NAME=MARKER-2-60> </A>CMOS RAM. If no option is specified, the values of all configuration options are shown.<P>
*Status [&lt;option&gt;]<P>
<A NAME=HEADING3-107> </A>
<H3> <A NAME=MARKER-2-61> </A>*Unplug</H3>
*Unplug kills and disables all copies of a <A NAME=MARKER-2-62> </A>ROM resident module. If no parameters are given, the unplugged ROM modules are listed.<P>
*Unplug [&lt;module_title&gt; [&lt;ROM_section&gt;]]<P>
<!-- TOC -->

<HR>
<ADDRESS>RISC OS 3.7 User Guide - 20 JAN 1997</ADDRESS>
<A HREF="BOOK3_6.HT"><IMG ALIGN=BOTTOM SRC="next" WIDTH=69 HEIGHT=24></A> <A HREF="BOOK3_2.HT"><IMG ALIGN=BOTTOM SRC="prev" WIDTH=69 HEIGHT=24></A> <A HREF="../BOOKB/USERGUIDE"><IMG ALIGN=BOTTOM SRC="top" WIDTH=69 HEIGHT=24></A> <A HREF="../BOOKB/TOC.HTM"><IMG ALIGN=BOTTOM SRC="content" WIDTH=69 HEIGHT=24></A> <A HREF="../INDEX/MAIN.HTM"><IMG ALIGN=BOTTOM SRC="index" WIDTH=69 HEIGHT=24></A><P>
</BODY>
</HTML> 