chiark / gitweb /
unfolding: do not introduce additional lwsp
[modbot-mtm.git] / stump / local / man / man1 / pmapp.1
1 .TH PMAPP 1 "PGP Moose"
2 .\"@(#)pmapp.1  1.4 (PGPMoose) 95/10/21
3 .SH NAME
4 pmapp \- insert a verifiable signature into a
5 news article.
6 .SH SYNOPSIS
7 .B pmapp
8 .I [newsgroups|user] [file] 
9 .SH DESCRIPTION
10 .I Pmapp
11 accepts an article from the named
12 .IR file
13 (or standard input if not specified),
14 computes a digital signature from the important
15 part of the contents, and inserts a special
16 header into the article which enables subsequent
17 checking of the signature. The amended article is
18 produced on standard output, suitable for
19 injection into the news system.
20 .LP
21 The signature is created using the defaults for
22 the user name (and optionally password) built
23 into the script when a newsgroup is specified. 
24 This is the most common case for a newsgroup
25 moderator who will use a customised version of
26 the script. These defaults can be overridden with
27 environment variables \f3PMUSER\fP and
28 \f3PMPASSWORD\fP.
29 .LP
30 In any case, whenever the
31 password is the empty string, a prompt is
32 written to the controlling terminal and a
33 password is read from it.
34 .LP
35 When a user is specified (by way of an email
36 address containing an "\fB@\fP") this is used to
37 select the signing user, and a password will be
38 requested.
39 .LP
40 When the signature is being generated for a
41 newsgroup, it is assumed that the newsgroup is
42 moderated and the invoking user is (one of) the
43 moderator(s).
44 The simple case is that there is only one
45 newsgroup specified; an Approved: line is added
46 as well as the X-Auth: line, and the
47 article is ready for posting.
48 .LP
49 \f2Pmapp\fP goes to some trouble to
50 handle the case of multiple moderated newsgroups
51 in the Newsgroups: line. The first, and probably
52 most important, case, is
53 when a moderator wants to cross-post a FAQ to
54 their own group, as well as news.answers (for
55 example). In this case their approval counts for
56 both groups, so they can insert the Approved:
57 header and post away. Presumably the other groups
58 are not under the contol of the PGP Moose Daemon.
59 The moderator can just go ahead and
60 put in the Approved: header, and save themself
61 and pmapp a lot of time. It will be passed right
62 through.
63 .LP
64 The other case is harder to get right. This is when
65 the article really is meant to be posted to two (or
66 more) unrelated moderated newsgroups. The approval
67 script checks whether there are any moderated
68 newsgroups left that don't have X-Auth:
69 headers for them. If there are none left, an Approved:
70 header is inserted and the article gets posted.
71 Otherwise, it issues a warning, and re-orders the
72 newsgroups header with a newsgroup which is moderated
73 but has no X-Auth:  line at the start.
74 When the article is posted, the news system will
75 forward it to the moderator of the (new) first
76 moderated group. If all moderators are sensible,
77 and check for moderated newsgroups in this fashion,
78 the mess should sort itself out and the last moderator
79 will go ahead and post it. A warning message to the
80 subsequent moderator NOT to change the article is
81 also inserted.
82 .\".SH FILES
83 .SH SEE ALSO
84 .IR pmcheck (1),
85 .IR pmcanon (1)
86 for a description of the fields which go into the
87 signature calculation,
88 the PGP User's Manual.
89 .SH AUTHOR
90 Greg Rose, RoSecure Software.