noose.1

   1 .\" noose.1
   2 .\" Copyright 2001 Julian E. C. Squires (tek@wiw.org)
   3 .\" $Id: noose.1,v 1.1 2001/04/22 21:41:24 tek Exp $
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one
  13 .\"
  14 .\" Formatted or processed versions of this manual, if unaccompanied by
  15 .\" the source, must acknowledge the copyright and authors of this work.
  16 .\"
  17 .TH NOOSE 1 "22 Apr 2001" ""
  18 .SH NAME
  19 noose \- a command-line NNTP tool
  20 .SH SYNOPSIS
  21 .B noose
  22 [\fIOPTION\fR]... <\fICOMMAND\fR>
  23 .SH DESCRIPTION
  24 .PP
  25 .B noose
  26 is a command-line tool which can check for new posts
  27 on a news server, via NNTP, in the groups to which one is subscribed, or
  28 read articles by article-number.
  29 .SH OPTIONS
  30 .TP
  31 \fB\-q\fR
  32 Be less verbose in output. This is most commonly used to make the \fBcheck\fR
  33 command only output groups with non-zero unread messages present.
  34 .TP
  35 \fB\-v\fR
  36 Be more verbose in output.
  37 .TP
  38 \fB\-n\fR \fIserver\fR
  39 Use \fIserver\fR as the NNTP server. By default, the value of the
  40 environment variable NNTPSERVER is used, and if it is not present,
  41 just "news" is used.
  42 .TP
  43 \fB\-r\fR \fIrcfile\fR
  44 Use \fIrcfile\fR as the newsrc file. This is only necessary when using
  45 the \fBcheck\fR command. By default, $HOME/.jnewsrc and $HOME/.newsrc
  46 will be tried, in that order.
  47 .SH COMMANDS
  48 .TP
  49 \fBcheck\fR [\fIgroup\fR]
  50 Returns how many unread posts are in all subscribed groups, or just
  51 \fIgroup\fR, if specified.
  52 .TP
  53 \fBread\fR [\fIgroup\fR] <\fIn\fR>
  54 Grab the entirity of article \fIn\fR from \fIgroup\fR.
  55 .SH AUTHOR
  56 Julian Squires <tek@wiw.org>
  57