.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "NoCeM 3pm" .TH NoCeM 3pm "2022-11-27" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" News::Article::NoCeM \- a module to generate accurate nocem notices .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use News::Article::NoCeM; \& my $nocem = new News::Article::NoCeM(); \& \& $nocem\->hide($type, $spam); \& $nocem\->make_notice($type, $name, $issuer, $group, $prefix); \& $nocem\->sign($keyid, $passphrase); \& $nocem\->issue($conn, $ihave); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Creates a nocem notice on the Usenet articles, which may be posted normally to hide the messages. .SH "USAGE" .IX Header "USAGE" .IP "use News::Article::NoCeM;" 2 .IX Item "use News::Article::NoCeM;" .PP News::Article::NoCeM is class that inherits News::Article and adds four new functions: \fBhide()\fR, \fBmake_notice()\fR, \fBsign()\fR and \fBissue()\fR, redefine to disable two functions: \fBpost()\fR and \fBihave()\fR. .SS "Article Methods" .IX Subsection "Article Methods" .IP "hide ( \s-1TYPE, ARTICLE,\s0 [\s-1ARTICLE, ...\s0] )" 4 .IX Item "hide ( TYPE, ARTICLE, [ARTICLE, ...] )" Hide one or more articles in the given \f(CW\*(C`TYPE\*(C'\fR. \f(CW\*(C`ARTICLE\*(C'\fR is an News::Article object that going to be hid. \fBhide()\fR will skip the articles without Newsgroup or Message-ID and skip the ones already hid. .Sp \&\fBhide()\fR returns the number of the articles hid. .IP "post" 4 .IX Item "post" .PD 0 .IP "ihave" 4 .IX Item "ihave" .PD \&\fBpost()\fR and \fBihave()\fR is disabled in News::Article::NoCeM. Please use \fBissue()\fR instead. .IP "make_notice ( \s-1TYPE, NAME, GROUP, ISSUER,\s0 [ \s-1PREFIX\s0 ] )" 4 .IX Item "make_notice ( TYPE, NAME, GROUP, ISSUER, [ PREFIX ] )" Retrieve articles marked by hide with \f(CW\*(C`TYPE\*(C'\fR, and make a notice fot them. If there's only one type within a container, then the container itself can be a notice. \f(CW\*(C`NAME\*(C'\fR is the identifier of the issuer. \f(CW\*(C`GROUP\*(C'\fR is the newsgroup the you will post nocem notice to. \f(CW\*(C`ISSUER\*(C'\fR is the email address of the issuer. \f(CW\*(C`PREFIX\*(C'\fR is the announcement before the nocem notice, which may explain the criteria of this notice, or where to find your public key for \&\s-1PGP\s0 verification. .Sp \&\fBmake_notice()\fR returns a News::Article::NoCeM object if success, and return undef if no article is hid. .IP "sign ( \s-1KEYID, PASSPHRASE\s0 )" 4 .IX Item "sign ( KEYID, PASSPHRASE )" Sign the content of the nocem notice with \f(CW\*(C`KEYID\*(C'\fR and \f(CW\*(C`PASSPHRASE\*(C'\fR. Please make sure that the issuer's public/secret keyring is ready. .Sp \&\fBsign()\fR returns a News::Article::NoCeM object if success, and return undef if no article is hid, or pgp_sign failed. .IP "issue ( [ \s-1CONN, IHAVE\s0 ] )" 4 .IX Item "issue ( [ CONN, IHAVE ] )" Take optional \f(CW\*(C`CONN\*(C'\fR as a Net::NNTP object and issue the nocem notice. \&\f(CW\*(C`IHAVE\*(C'\fR indicates that call \fBNet::NNTP::ihave()\fR for submitting the notice, otherwise \fBissue()\fR will call \fBNews::Article::post()\fR by default. .Sp \&\fBissue()\fR return the result of \fBNews::Article::post()\fR or \fBissue()\fR. .SH "NOTES" .IX Header "NOTES" Standard article manipulation information can be read in the News::Article manpages. .PP NoCeM \s-1FAQ\s0 is available on the web at . .SH "AUTHOR" .IX Header "AUTHOR" Written by Yen-Ming Lee , based on a module by Tim Skirvin . .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2004\-2005 by Yen-Ming Lee . This code may be redistributed under the same terms as Perl itself.