[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / tslice.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
<html>
<head>
<title>MHonArc Resources: TSLICE</title>
</head>
<body>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev:&nbsp;<a href="tsingletxt.html">TSINGLETXT</a>]</td><td><nobr>[<a href="../resources.html#tslice">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="tslicebeg.html">TSLICEBEG</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<h1>TSLICE</h1>

<!-- *************************************************************** -->
<hr>
<h2>Syntax</h2>

<dl>

<dt><strong>Envariable</strong></dt>
<dd><p>
<code>M2H_TSLICE=</code><var>number</var><code>:</code><var>number</var><code>:</code><var>inclusive-flag</var>
</p>
</dd>

<dt><strong>Element</strong></dt>
<dd><p><code>&lt;TSLICE&gt;</code><br>
<var>number</var><code>:</code><var>number</var><code>:</code><var>inclusive-flag</var><br>
<code>&lt;/TSLICE&gt;</code><br>
</p>
</dd>

<dt><strong>Command-line Option</strong></dt>
<dd><p><code>-tslice </code><var>number</var><code>:</code><var>number</var><code>:</code><var>inclusive-flag</var>
</p>
</dd>

</dl>

<!-- *************************************************************** -->
<hr>
<h2>Description</h2>

<p>TSLICE sets the default argument values for the the
<b><tt><a href="../rcvars.html#TSLICE">$TSLICE$</a></tt></b>
resource variable: the thread listing
"<em>slice</em>" (ie. a portion of the complete thread listing).
The value of the TSLICE resource is two numbers and an inclusive flag,
where each value is separated by a colon.
The first number is the number of messages listed <b>before</b> the
current message in the thread slice.  The second number is
the number of messages listed <b>after</b> the current message.
The inclusive flag is either a <tt><b>1</b></tt> or
<tt><b>0</b></tt>.  If <tt><b>1</b></tt>, <tt>$TSLICE$</tt>
will only include in the thread listing messages in the same thread
as the current thread.  If <tt><b>0</b></tt>, <tt>$TSLICE$</tt> will
include messages in neighboring threads if before and/or after count 
extend beyond the current thread.  If the inclusive flag is not
set, then <tt>0</tt> will be used.
</p>
<p>The default values can be overridden by providing different
values as arguments to
<tt><a href="../rcvars.html#TSLICE">$TSLICE$</a></tt>.
</p>

<table border=0 cellpadding=4>
<tr valign=top>
<td><strong>NOTE</strong></td>
<td><p>The value of the TSLICE
resource is used to determine the number of messages to update,
before and after by thread, when a new message is added.  To
insure that messages within a thread slice are updated when
a new message is added, make sure the before and after ranges
specified for TSLICE is
equal to maximum before and the maximum after range arguments
specifed in the uses of the
<a href="../rcvars.html#TSLICE"><tt>$TSLICE$</tt></a> resource
variable.  For example, if you have <tt>$TSLICE(0;4)$</tt> and
<tt>$TSLICE(3;3)$</tt> in message layout resources, you should
set TSLICE to <tt>3:4</tt>.
</p>
<p>If you only use <tt>$TSLICE$</tt> once, it is best to
set options for thread slice formatting via the
TSLICE resource so you will not have anything to worry about.
</p>
</td>
</tr>
</table>

<!-- *************************************************************** -->
<hr>
<h2>Default Setting</h2>

<pre>
0:4:0
</pre>

<!-- *************************************************************** -->
<hr>
<h2>Resource Variables</h2>

<p>N/A
</p>

<!-- *************************************************************** -->
<hr>
<h2>Examples</h2>

<p>The default setting causes a thread slice to start with the
current message.  However, you may want to have the current message
in the middle so the reader can see message that come before along
with after the current message.  The following causes the
previous two and next two messages to be listed with the current
in the middle and only if the messages are part of the current thread:
</p>

<pre>
<b>&lt;TSlice></b>
2:2:1
<b>&lt;/TSlice></b>
</pre>

<!-- *************************************************************** -->
<hr>
<h2>Version</h2>

<p>2.2.0
</p>

<!-- *************************************************************** -->
<hr>
<h2>See Also</h2>

<p>
<a href="../rcvars.html#TSLICE"><tt>$TSLICE$</tt></a>,
<a href="tslicebeg.html">TSLICEBEG</a>,
<a href="tslicecontbeg.html">TSLICECONTBEG</a>,
<a href="tslicecontend.html">TSLICECONTEND</a>,
<a href="tsliceend.html">TSLICEEND</a>,
<a href="tsliceindentbeg.html">TSLICEINDENTBEG</a>,
<a href="tsliceindentend.html">TSLICEINDENTEND</a>,
<a href="tsliceliend.html">TSLICELIEND</a>,
<a href="tsliceliendcur.html">TSLICELIENDCUR</a>,
<a href="tslicelinone.html">TSLICELINONE</a>,
<a href="tslicelinoneend.html">TSLICELINONEEND</a>,
<a href="tslicelitxt.html">TSLICELITXT</a>,
<a href="tslicelitxtcur.html">TSLICELITXTCUR</a>,
<a href="tslicesingletxt.html">TSLICESINGLETXT</a>,
<a href="tslicesingletxtcur.html">TSLICESINGLETXTCUR</a>,
<a href="tslicesubjectbeg.html">TSLICESUBJECTBEG</a>,
<a href="tslicesubjectend.html">TSLICESUBJECTEND</a>,
<a href="tslicesublistbeg.html">TSLICESUBLISTBEG</a>,
<a href="tslicesublistend.html">TSLICESUBLISTEND</a>,
<a href="tslicetopbeg.html">TSLICETOPBEG</a>,
<a href="tslicetopbegcur.html">TSLICETOPBEGCUR</a>,
<a href="tslicetopend.html">TSLICETOPEND</a>,
<a href="tslicetopendcur.html">TSLICETOPENDCUR</a>
</p>

<!-- *************************************************************** -->
<hr>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev:&nbsp;<a href="tsingletxt.html">TSINGLETXT</a>]</td><td><nobr>[<a href="../resources.html#tslice">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="tslicebeg.html">TSLICEBEG</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<address>
$Date: 2002/07/27 05:13:11 $ <br>
<img align="top" src="../monicon.png" alt="">
<a href="http://www.mhonarc.org/"
><strong>MHonArc</strong></a><br>
Copyright &#169; 1998-1999, <a href="http://www.earlhood.com/"
>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
>mhonarc@mhonarc.org</a><br>
</address>

</body>
</html>
Commit	Line	Data
86530b38 AT	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
	2	<html>
	3	<head>
	4	<title>MHonArc Resources: TSLICE</title>
	5	</head>
	6	<body>
	7	<!--x-rc-nav-->
	8	<table border=0><tr valign="top">
	9	<td align="left" width="50%">[Prev: <a href="tsingletxt.html">TSINGLETXT</a>]</td><td><nobr>[<a href="../resources.html#tslice">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="tslicebeg.html">TSLICEBEG</a>]</td></tr></table>
	10	<!--/x-rc-nav-->
	11	<hr>
	12	<h1>TSLICE</h1>
	13
	14	<!-- *************************************************************** -->
	15	<hr>
	16	<h2>Syntax</h2>
	17
	18	<dl>
	19
	20	<dt><strong>Envariable</strong></dt>
	21	<dd><p>
	22	<code>M2H_TSLICE=</code><var>number</var><code>:</code><var>number</var><code>:</code><var>inclusive-flag</var>
	23	</p>
	24	</dd>
	25
	26	<dt><strong>Element</strong></dt>
	27	<dd><p><code><TSLICE></code><br>
	28	<var>number</var><code>:</code><var>number</var><code>:</code><var>inclusive-flag</var><br>
	29	<code></TSLICE></code><br>
	30	</p>
	31	</dd>
	32
	33	<dt><strong>Command-line Option</strong></dt>
	34	<dd><p><code>-tslice </code><var>number</var><code>:</code><var>number</var><code>:</code><var>inclusive-flag</var>
	35	</p>
	36	</dd>
	37
	38	</dl>
	39
	40	<!-- *************************************************************** -->
	41	<hr>
	42	<h2>Description</h2>
	43
	44	<p>TSLICE sets the default argument values for the the
	45	<b><tt><a href="../rcvars.html#TSLICE">$TSLICE$</a></tt></b>
	46	resource variable: the thread listing
	47	"<em>slice</em>" (ie. a portion of the complete thread listing).
	48	The value of the TSLICE resource is two numbers and an inclusive flag,
	49	where each value is separated by a colon.
	50	The first number is the number of messages listed <b>before</b> the
	51	current message in the thread slice. The second number is
	52	the number of messages listed <b>after</b> the current message.
	53	The inclusive flag is either a <tt><b>1</b></tt> or
	54	<tt><b>0</b></tt>. If <tt><b>1</b></tt>, <tt>$TSLICE$</tt>
	55	will only include in the thread listing messages in the same thread
	56	as the current thread. If <tt><b>0</b></tt>, <tt>$TSLICE$</tt> will
	57	include messages in neighboring threads if before and/or after count
	58	extend beyond the current thread. If the inclusive flag is not
	59	set, then <tt>0</tt> will be used.
	60	</p>
	61	<p>The default values can be overridden by providing different
	62	values as arguments to
	63	<tt><a href="../rcvars.html#TSLICE">$TSLICE$</a></tt>.
	64	</p>
65
66	<table border=0 cellpadding=4>
67	<tr valign=top>
68	<td><strong>NOTE</strong></td>
69	<td><p>The value of the TSLICE
70	resource is used to determine the number of messages to update,
71	before and after by thread, when a new message is added. To
72	insure that messages within a thread slice are updated when
73	a new message is added, make sure the before and after ranges
74	specified for TSLICE is
75	equal to maximum before and the maximum after range arguments
76	specifed in the uses of the
77	<a href="../rcvars.html#TSLICE"><tt>$TSLICE$</tt></a> resource
78	variable. For example, if you have <tt>$TSLICE(0;4)$</tt> and
79	<tt>$TSLICE(3;3)$</tt> in message layout resources, you should
80	set TSLICE to <tt>3:4</tt>.
81	</p>
82	<p>If you only use <tt>$TSLICE$</tt> once, it is best to
83	set options for thread slice formatting via the
84	TSLICE resource so you will not have anything to worry about.
85	</p>
86	</td>
87	</tr>
88	</table>
89
90	<!-- *************************************************************** -->
91	<hr>
92	<h2>Default Setting</h2>
93
94	<pre>
95	0:4:0
96	</pre>
97
98	<!-- *************************************************************** -->
99	<hr>
100	<h2>Resource Variables</h2>
101
102	<p>N/A
103	</p>
104
105	<!-- *************************************************************** -->
106	<hr>
107	<h2>Examples</h2>
108
109	<p>The default setting causes a thread slice to start with the
110	current message. However, you may want to have the current message
111	in the middle so the reader can see message that come before along
112	with after the current message. The following causes the
113	previous two and next two messages to be listed with the current
114	in the middle and only if the messages are part of the current thread:
115	</p>
116
117	<pre>
118	<b><TSlice></b>
119	2:2:1
120	<b></TSlice></b>
121	</pre>
122
123	<!-- *************************************************************** -->
124	<hr>
125	<h2>Version</h2>
126
127	<p>2.2.0
128	</p>
129
130	<!-- *************************************************************** -->
131	<hr>
132	<h2>See Also</h2>
133
134	<p>
135	<a href="../rcvars.html#TSLICE"><tt>$TSLICE$</tt></a>,
136	<a href="tslicebeg.html">TSLICEBEG</a>,
137	<a href="tslicecontbeg.html">TSLICECONTBEG</a>,
138	<a href="tslicecontend.html">TSLICECONTEND</a>,
139	<a href="tsliceend.html">TSLICEEND</a>,
140	<a href="tsliceindentbeg.html">TSLICEINDENTBEG</a>,
141	<a href="tsliceindentend.html">TSLICEINDENTEND</a>,
142	<a href="tsliceliend.html">TSLICELIEND</a>,
143	<a href="tsliceliendcur.html">TSLICELIENDCUR</a>,
144	<a href="tslicelinone.html">TSLICELINONE</a>,
145	<a href="tslicelinoneend.html">TSLICELINONEEND</a>,
146	<a href="tslicelitxt.html">TSLICELITXT</a>,
147	<a href="tslicelitxtcur.html">TSLICELITXTCUR</a>,
148	<a href="tslicesingletxt.html">TSLICESINGLETXT</a>,
149	<a href="tslicesingletxtcur.html">TSLICESINGLETXTCUR</a>,
150	<a href="tslicesubjectbeg.html">TSLICESUBJECTBEG</a>,
151	<a href="tslicesubjectend.html">TSLICESUBJECTEND</a>,
152	<a href="tslicesublistbeg.html">TSLICESUBLISTBEG</a>,
153	<a href="tslicesublistend.html">TSLICESUBLISTEND</a>,
154	<a href="tslicetopbeg.html">TSLICETOPBEG</a>,
155	<a href="tslicetopbegcur.html">TSLICETOPBEGCUR</a>,
156	<a href="tslicetopend.html">TSLICETOPEND</a>,
157	<a href="tslicetopendcur.html">TSLICETOPENDCUR</a>
158	</p>
159
160	<!-- *************************************************************** -->
161	<hr>
162	<!--x-rc-nav-->
163	<table border=0><tr valign="top">
164	<td align="left" width="50%">[Prev: <a href="tsingletxt.html">TSINGLETXT</a>]</td><td><nobr>[<a href="../resources.html#tslice">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="tslicebeg.html">TSLICEBEG</a>]</td></tr></table>
165	<!--/x-rc-nav-->
166	<hr>
167	<address>
168	$Date: 2002/07/27 05:13:11 $ <br>
169	<img align="top" src="../monicon.png" alt="">
170	<a href="http://www.mhonarc.org/"
171	><strong>MHonArc</strong></a><br>
172	Copyright © 1998-1999, <a href="http://www.earlhood.com/"
173	>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
174	>mhonarc@mhonarc.org</a><br>
175	</address>
176
177	</body>
178	</html>