SirFact: Difference between revisions

Latest revision as of 18:46, 18 May 2017

SirFact is a post hoc debugging tool made up of two distinct components:

A collection of Model 204 object code enhancements. Prior to version 7.5 of Model 204, these enhancements are distributed as components of the Sirius Mods.
A collection of SOUL procedure files that are distributed with the RKTools products. These files include:
- A SIRFACT file, which contains code useful for looking at SirFact dumps.
- The definitions for the FACT subsystem, which is useful for looking at SirFact dumps.
No other RKTools products are required to run SirFact, though SirPro makes it more convenient to look at a list of dumps and to select one to be viewed from the FACT subsystem.

Product installation

SirFact requires the installation of both of these:

Model 204 7.5 or higher (or the Sirius Mods if a lower version of Model 204).
See the Model 204 installation page.
RKTools, the version of which must be the same as or lower than that of Model 204.
See the RKTools installation page.

Related products

You can use SirPro to invoke the FACT subsystem, which is used for looking at SirFact dumps. SirPro also provides a good user interface for scanning lists of dumps and programs.

SirFact does not address issues with tracking and distributing fixes to bugs once they are written. SirLib might prove useful to handle change control and fix distribution issues related to post hoc (and even ad hoc) debugging.

Though SirFact provides a powerful post hoc debugging facility, the Rocket Model 204 Janus Debugger and the Rocket Model 204 TN/3270 Debugger are interactive debugging facilities that are useful for debugging code while it is being developed.

SirScan can also be useful for debugging certain applications, especially those that are not associated with a terminal; for example, Janus or Connect★ bugs.

SirFact topics

The SirFact documentation consists of the pages listed below. This list is also available as a "See also" link from each of the pages.

SirFact topic list

@@ Line 1: / Line 1: @@
-This page is [[under construction]]. In the meantime, see the <var class="book">[[Media:FactrNew.pdf|Rocket M204 SirFact Reference Manual]]</var>.
+<var class="product">SirFact</var> is a [[SirFact_post_hoc_debugging#Ad_hoc_versus_post_hoc_debugging|post hoc debugging]] tool made up of two distinct components:
+<ul>
+<li>A collection of <var class="product">Model&nbsp;204</var> object code enhancements. Prior to version 7.5 of Model 204,
+these enhancements are distributed as
+components of the <var class="product">[[Sirius Mods]]</var>.</li>
+<li>A collection of <var class="product">SOUL</var> procedure files that are distributed
+with the <var class="product">[[RKTools]]</var> products. These files include:
+<ul>
+<li>A <code>SIRFACT</code> file, which contains code
+useful for looking at <var class="product">SirFact</var> dumps. </li>
+<li>The definitions for the <code>FACT</code> subsystem, which is useful for looking at <var class="product">SirFact</var> dumps. </li>
+</ul>
+<p>
+No other <var class="product">RKTools</var> products are required to run <var class="product">SirFact</var>, though <var class="product">[[SirPro]]</var>
+makes it more convenient
+to look at a list of dumps and to select one to be viewed from the <code>FACT</code> subsystem. </p></li>
+</ul>
-==See also==
+==Product installation==
+<var class="product">SirFact</var> requires the installation of both of these:
 <ul>
-<li>[[Terminal MODEL 6 support]] </li>
+<li><var class="product">Model&nbsp;204</var> 7.5 or higher (or the <var class="product">Sirius Mods</var> if a lower version of <var class="product">Model&nbsp;204</var>).
+<p>
+See the [[Model 204 installation]] page. </p></li>
+<li><var class="product">RKTools</var>, the version of which must be the same as or lower than that of <var class="product">Model&nbsp;204</var>.
+<p>
+See the [[RKTools installation]] page. </p></li>
 </ul>
+==Related products==
+You can use <var class="product"><b>[[SirPro]]</b></var> to invoke the <code>FACT</code> subsystem, which is used for looking at <var class="product">SirFact</var> dumps.
+<var class="product">SirPro</var> also provides a good user interface
+for scanning lists of dumps and programs.
+<var class="product">SirFact</var> does not address issues with tracking and distributing fixes to bugs once they are written.
+<var class="product"><b>[[SirLib]]</b></var> might prove useful to handle
+change control and fix distribution issues related to post hoc (and even
+[[SirFact_post_hoc_debugging#Ad_hoc_versus_post_hoc_debugging|ad hoc]]) debugging.
+Though <var class="product">SirFact</var> provides a powerful post hoc debugging facility,
+the <var class="product"><b>[[Debugger|Rocket Model 204 Janus Debugger]]</b></var> and the <var class="product"><b>[[Debugger|Rocket Model 204 TN/3270 Debugger]]</b></var> are interactive debugging facilities that
+are useful for debugging code while it is being developed.
+<var class="product"><b>[[SirScan]]</b></var> can also be useful for debugging
+certain applications, especially those that are not associated with
+a terminal; for example, [[Janus products|Janus]] or [[Connect*|Connect<span class="superstar">&#9733;</span>]] bugs.
+==SirFact topics==
+The <var class="product">SirFact</var> documentation consists of the pages listed below.
+This list is also available as a "See also" link from each of the pages.
+See also:
+<ul>
+<li>[[List of Model 204 messages#msir|MSIR. messages]] for information about product error messages. </li>
+<li>The [[List of $functions]] for documentation for all $functions except the SirFact-specific $functions, which are documented in [[SirFact $functions]].</li>
+<li>[[Terminal MODEL 6 support]] for information about customizing your workstation's screen geometry. </li>
+</ul>
+===SirFact  topic list===
+{{Template: SirFact topic list}}
+[[Category: SirFact]]