ch17_03.htm

by Randal L. Schwartz and Tom Phoenix ISBN 0-596-00132-0 Third Edition, published July 2001. (See

</dl></div>

<a name="INDEX-2264" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>mark_range</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;mark_range(<em class="replaceable">groupname</em>, <em class="replaceable">n</em>, <em class="replaceable">m</em>[, <em class="replaceable">options</em>])
</pre><p><a name="INDEX-2264" />Adds articles in the specified
range to the list. Arguments are:
</p><dl>
<dt><i><em class="replaceable"><tt>groupname</tt></em></i></dt>
<dd>
Newsgroup to add articles to.</p>
</dd>


<dt><i><em class="replaceable"><tt>n</tt></em></i></dt>
<dd>
Number of the first article in the range.</p>
</dd>


<dt><i><em class="replaceable"><tt>m</tt></em></i></dt>
<dd>
Number of the last article in the range.</p>
</dd>


<dt><i><em class="replaceable"><tt>options</tt></em></i></dt>
<dd>
Hash. See description under <tt class="literal">add_group</tt>.</p>
</dd>

</dl></div>

<a name="INDEX-2265" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>save</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;save(  )
</pre><p><a name="INDEX-2265" />Saves changes to
<em class="filename">.newsrc</em> file.
</p></div>

<a name="INDEX-2266" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>save_as</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;save_as(<em class="replaceable">filename</em>)
</pre><p><a name="INDEX-2266" />Saves changes to specified file
<em class="replaceable"><tt>filename</tt></em>, rather than to
<em class="filename">.newsrc</em> file.
</p></div>

<a name="INDEX-2267" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>sub_groups</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;sub_groups(  )
</pre><p><a name="INDEX-2267" />Returns list of subscribed
groups in <em class="filename">.newsrc</em>.
</p></div>

<a name="INDEX-2268" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>subscribe</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;subscribe(<em class="replaceable">groupname</em>)
</pre><p><a name="INDEX-2268" />Subscribes to newsgroup
<em class="replaceable"><tt>groupname</tt></em>. If the group is not in
<em class="filename">.newsrc</em>, it is added; its location may be given
in <em class="replaceable"><tt>options</tt></em>, as specified for
<tt class="literal">add_group</tt>.
</p></div>

<a name="INDEX-2269" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>subscribed</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;subscribed(<em class="replaceable">groupname</em>)
</pre><p><a name="INDEX-2269" />Returns true if the group
<em class="replaceable"><tt>groupname</tt></em> exists and is subscribed to.
</p></div>

<a name="INDEX-2270" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>unmark</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;unmark(<em class="replaceable">groupname</em>, <em class="replaceable">article_number</em>[, <em class="replaceable">options</em>])
</pre><p><a name="INDEX-2270" />Removes specified article from
the group list. Arguments are:
</p><dl>
<dt><i><em class="replaceable"><tt>groupname</tt></em></i></dt>
<dd>
Newsgroup to remove articles from.</p>
</dd>


<dt><i><em class="replaceable"><tt>article_number</tt></em></i></dt>
<dd>
Article to remove.</p>
</dd>


<dt><i><em class="replaceable"><tt>options</tt></em></i></dt>
<dd>
Hash. See description under <tt class="literal">add_group</tt>.</p>
</dd>

</dl></div>

<a name="INDEX-2271" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>unmarked_articles</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;unmarked_articles(<em class="replaceable">groupname</em>, <em class="replaceable">n</em>, <em class="replaceable">m</em>[, <em class="replaceable">options</em>])
</pre><p><a name="INDEX-2271" />Returns the list of articles
from <em class="replaceable"><tt>n</em> to <em class="replaceable">m</tt></em>,
inclusive, that are not in the article list for the newsgroup.
Arguments are:
</p><dl>
<dt><i><em class="replaceable"><tt>groupname</tt></em></i></dt>
<dd>
Group to return articles from.</p>
</dd>


<dt><i><em class="replaceable"><tt>n</tt></em></i></dt>
<dd>
Number of the first article in the range.</p>
</dd>


<dt><i><em class="replaceable"><tt>m</tt></em></i></dt>
<dd>
Number of the last article in the range.</p>
</dd>


<dt><i><em class="replaceable"><tt>options</tt></em></i></dt>
<dd>
Hash. See description under <tt class="literal">add_group</tt>.</p>
</dd>

</dl></div>

<a name="INDEX-2272" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>unmark_list</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;unmark_list(<em class="replaceable">groupname</em>, \@<em class="replaceable">article_list</em>[, <em class="replaceable">options</em>)
</pre><p><a name="INDEX-2272" />Removes specified list of
articles from the group list. Arguments are:
</p><dl>
<dt><i><em class="replaceable"><tt>groupname</tt></em></i></dt>
<dd>
Group to remove articles from.</p>
</dd>


<dt><b><tt class="literal">\@</tt><em class="replaceable">article_list</em></b></dt>
<dd>
Reference to list of articles to remove.</p>
</dd>


<dt><i><em class="replaceable"><tt>options</tt></em></i></dt>
<dd>
Hash. See description under <tt class="literal">add_group</tt>.</p>
</dd>

</dl></div>

<a name="INDEX-2273" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>unmark_range</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;unmark_range(<em class="replaceable">groupname</em>, <em class="replaceable">n</em>, <em class="replaceable">m</em>[, <em class="replaceable">options</em>])
</pre><p><a name="INDEX-2273" />Removes a range of articles
from <em class="replaceable"><tt>n</em> to <em class="replaceable">m</em>from <em class="filename">.newsrc</tt></em>. Arguments are:
</p><dl>
<dt><i><em class="replaceable"><tt>groupname</tt></em></i></dt>
<dd>
Group to remove articles from.</p>
</dd>


<dt><i><em class="replaceable"><tt>n</tt></em></i></dt>
<dd>
Number of the first article in the range.</p>
</dd>


<dt><i><em class="replaceable"><tt>m</tt></em></i></dt>
<dd>
Number of the last article in the range.</p>
</dd>


<dt><i><em class="replaceable"><tt>options</tt></em></i></dt>
<dd>
Hash. See description under <tt class="literal">add_group</tt>.</p>
</dd>

</dl></div>

<a name="INDEX-2274" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>unsub_groups</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;unsub_groups(  )
</pre><p><a name="INDEX-2274" />Returns list of unsubscribed
groups in <em class="filename">.newsrc</em>. In scalar context, returns an
array reference.
</p></div>

<a name="INDEX-2275" /><a name="INDEX-2276" /><a name="INDEX-2277" /><a name="INDEX-2278" /><a name="INDEX-2279" /><a name="INDEX-2280" /><a name="INDEX-2281" /><a name="INDEX-2282" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>unsubscribe</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
$<em class="replaceable">newsrc</em>-&gt;unsubscribe(<em class="replaceable">groupname</em>[, <em class="replaceable">options</em>])
</pre><p><a name="INDEX-2275" />Unsubscribes from newsgroup in
<em class="filename">.newsrc</em>. If the group is not in
<em class="filename">.newsrc</em>, it is added. Arguments are:
</p><dl>
<dt><i><em class="replaceable"><tt>groupname</tt></em></i></dt>
<dd>
Group to unsubscribe from.</p>
</dd>


<dt><i><em class="replaceable"><tt>options</tt></em></i></dt>
<dd>
Hash. See description under <tt class="literal">add_group</tt>.<a name="INDEX-2276" /><a name="INDEX-2277" /><a name="INDEX-2278" /><a name="INDEX-2279" /><a name="INDEX-2280" /><a name="INDEX-2281" /><a name="INDEX-2282" />
</p>
</dd>

</dl></div>
</div>


<hr width="684" align="left" />
<div class="navbar"><table width="684" border="0"><tr><td align="left" valign="top" width="228"><a href="ch17_02.htm"><img src="../gifs/txtpreva.gif" alt="Previous" border="0" /></a></td><td align="center" valign="top" width="228"><a href="index.htm"><img src="../gifs/txthome.gif" alt="Home" border="0" /></a></td><td align="right" valign="top" width="228"><a href="ch18_01.htm"><img src="../gifs/txtnexta.gif" alt="Next" border="0" /></a></td></tr><tr><td align="left" valign="top" width="228">17.2. Net::NNTP</td><td align="center" valign="top" width="228"><a href="index/index.htm"><img src="../gifs/index.gif" alt="Book Index" border="0" /></a></td><td align="right" valign="top" width="228">18. FTP</td></tr></table></div>
<hr width="684" align="left" />

<img src="../gifs/navbar.gif" usemap="#library-map" border="0" alt="Library Navigation Links" />
<p><p><font size="-1"><a href="copyrght.htm">Copyright &copy; 2002</a> O'Reilly &amp; Associates. All rights reserved.</font></p>

<map name="library-map">
<area shape="rect" coords="1,0,85,94" href="../index.htm"><area shape="rect" coords="86,1,178,103" href="../lwp/index.htm"><area shape="rect" coords="180,0,265,103" href="../lperl/index.htm"><area shape="rect" coords="267,0,353,105" href="../perlnut/index.htm"><area shape="rect" coords="354,1,446,115" href="../prog/index.htm"><area shape="rect" coords="448,0,526,132" href="../tk/index.htm"><area shape="rect" coords="528,1,615,119" href="../cookbook/index.htm"><area shape="rect" coords="617,0,690,135" href="../pxml/index.htm">
</map>

</body></html>