ARTICLE

Section: User Commands (1)
Index Return to Main Contents
 

NAME

article - print formatted news article header information  

SYNOPSIS

article [ -adnvV ] [-f format ] newsarticle [ ... ]  

DESCRIPTION

article allows the user to display information contained in the news article headers. This information includes the auxiliary headers added by the moderators of most of the source newsgroups. article takes the names of article files from standard input or as specified on the command line. By default, article produces output in a format of:

(Newsarticle Article Subject) sources.d/1210 Re: Archiving USENET Software

If the user has specified that only potential archive members are to be displayed, article produces output in a format of:

(Newsarticle Archive Name Article Description) unix/1420 archive/part01 Source Archiver, Part 1 of 8

The user can select almost any information contained within a news article header and can then specify the way in which the information should be displayed. The format that the user specifies is much like that of a C printf statement.  

OPTIONS

-a
Print information (in the specified format if supplied) if and only if the news article contains the auxiliary headers added by the sources newsgroup moderators. Do not print any information about files that do not contain auxiliary headers.
-d
Turn on debugging output. This option allows the user to display the information found in an article header. This is basically a formatted dump of the header structure after parsing the article's header.
-f format
This option allows the user to specify a format. The format is used to determine which parts of the article header information are to be displayed. It also specifies the presentation format of the article information in much the same manner as the C printf function. See Formatting below.
-n
Print information (in the specified format if supplied) if and only if the news article does not contains the auxiliary headers added by the sources newsgroup moderators.
-v
Print additional information about the newsgroup.
-V
Print the version and patchlevel of the current executable.
 

FORMATTING

article places output on the standard output stream stdout. article selects, formats, and prints its output under control of the format. The format is a character string that contains two types of objects: plain characters, which are copied directly to the output stream, and selection specifications. Specifying a selection results in fetching the selected items from the news article. The results are undefined if there is no associated information found in the news article.

Each selection specification is introduced by the character %. After the %, a character follows that indicates the type of selection to be made.

The selection characters and their meanings are:

                Article Information Lines

        A - Print the Approved line.
        C - Print the Supersedes line.
        D - Print the Date line.
        F - Print the From line.
        K - Print the Keywords line.
        L - Print the Lines line.
        M - Print the Message-ID line.
        N - Print the Newsgroups line.
        P - Print the Path line.
        R - Print the References line.
        S - Print the Subject line.
        a - Print the Archive-name line.
        b - Print the Submitted-by line.
        c - Print the Control line.
        d - Print the Distribution line.
        e - Print the Expires line.
        f - Print the Followup-to line.
        o - Print the Organization line.
        p - Print the Posting-number line.
        r - Print the Reply-to line.
        s - Print the Sender line.
        u - Print the Summary line.
        x - Print the Xref line.

                Archive Information 

        B - Print the base file name.
        O - Print the Full path of the specified file.
        G - Print the newsGroup name.
        i - Print the issue (if archive) line.
        l - Print the Author's logon address line.
        n - Print the Author's name.
        v - Print the volume (if archive) line.

                Additional Specification Characters 

        T - Print the Subject line's topic information.
        % - Print a %, no argument is converted.

In addition to the conversion characters, the following 
characters have meaning during the formatting of the output.
\    \t - Print a tab in the output.
 

EXAMPLES

To print all files in the sources directory that have auxiliary headers and can be archived by Archive-Name or Volume-Issue methods:

$ find /usr/spool/news/comp/sources -print | article -a

To print a list of files in

$ cd /usr/spool/news/comp/sources; article -f"%O %T" unix/*

unix/1843 Introduction to comp.sources.unix 
unix/1844 List of sources in the archives    
 

SEE ALSO

rkive(1), ckconfig(1), rkive.cf(5)  

BUGS

article does not know about the X-Archiver format used in Volume 1 of comp.sources.misc.


 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
FORMATTING
EXAMPLES
SEE ALSO
BUGS

This document was created by man2html, using the manual pages.
Time: 06:37:59 GMT, December 12, 2024