Difference between revisions of "SET ODOMETER"

From Recital Documentation Wiki
Jump to: navigation, search
 
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=SET ODOMETER=
 
 
 
==Class==
 
Recital Terminal Developer Environment
 
 
 
 
==Purpose==
 
==Purpose==
 
Determine how often the counter is updated in commands that display their progress
 
Determine how often the counter is updated in commands that display their progress
Line 12: Line 5:
 
==Syntax==
 
==Syntax==
 
SET ODOMETER AT <expN1>, <expN2> | DEFAULT
 
SET ODOMETER AT <expN1>, <expN2> | DEFAULT
 +
 
SET ODOMETER ON | OFF | (<expL>)
 
SET ODOMETER ON | OFF | (<expL>)
 +
 
SET ODOMETER TO REVERSE | BOLD | NONE | <expN>
 
SET ODOMETER TO REVERSE | BOLD | NONE | <expN>
 +
  
  
 
==See Also==
 
==See Also==
SET TALK, SET PERFMETER
+
[[INDEX]], [[PACK]], [[SET PERFMETER]], [[SET TALK]], [[SORT]]
  
  
Line 27: Line 23:
  
 
==Example==
 
==Example==
<pre>
+
<code lang="recital">
 
set talk off
 
set talk off
 
set odometer on
 
set odometer on
Line 34: Line 30:
 
set message to "Pack in progress"
 
set message to "Pack in progress"
 
pack
 
pack
set odometer off</pre>
+
set odometer off</code>
  
  
 
==Products==
 
==Products==
Recital Terminal Developer
+
Recital  
 +
[[Category:Documentation]]
 +
[[Category:Commands]]
 +
[[Category:Set_Commands|ODOMETER]]
 +
[[Category:Terminal Environment]]
 +
[[Category:Terminal Environment Set Commands]]

Latest revision as of 16:27, 23 November 2009

Purpose

Determine how often the counter is updated in commands that display their progress


Syntax

SET ODOMETER AT <expN1>, <expN2> | DEFAULT

SET ODOMETER ON | OFF | (<expL>)

SET ODOMETER TO REVERSE | BOLD | NONE | <expN>


See Also

INDEX, PACK, SET PERFMETER, SET TALK, SORT


Description

When SET TALK is ON, certain commands display their progress on the screen. Commands such as INDEX, PACK, SORT etc. ’count’ on the screen to inform you of their progress. The SET ODOMETER TO <expN> command allows you to specify the units in which the counting should be performed. By default, the counting is performed in units of one. When SET TALK is OFF, SET ODOMETER TO will not operate unless SET ODOMETER is ON.

You may position the counter display using AT <expN1>, <expN2> which specify the row and column coordinates, or place it back to the default position using the DEFAULT keyword. The BOLD, REVERSE, and NONE keywords allow you to control the display attributes of the counter.


Example

set talk off
set odometer on
set odometer to 10
set odometer at 10,43
set message to "Pack in progress"
pack
set odometer off


Products

Recital