diff options
| author | Matěj Cepl <mcepl@cepl.eu> | 2023-05-25 10:15:47 +0200 |
|---|---|---|
| committer | Matěj Cepl <mcepl@cepl.eu> | 2023-05-25 11:01:18 +0200 |
| commit | ec4b49d843e67b31b33ac81bef55346353f1d04c (patch) | |
| tree | 5f60ffae4d6ebe180c5ee4d51d468bf154535251 /docs/pygm2n.1 | |
| parent | 8006d981ce26fe8c1140e33b9476c08470d59f30 (diff) | |
| download | pyg-ec4b49d843e67b31b33ac81bef55346353f1d04c.tar.gz | |
refactor: rearrange the project to the src/ layout.0.10.3
Fix also pyproject.toml to generate what seems right.
Add the explicit dependency on nntplib for Python >= 3.12
(gh#python/cpython!104894).
Fixes: https://todo.sr.ht/~mcepl/pygn/7
Diffstat (limited to 'docs/pygm2n.1')
| -rw-r--r-- | docs/pygm2n.1 | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/pygm2n.1 b/docs/pygm2n.1 new file mode 100644 index 0000000..63f2e09 --- /dev/null +++ b/docs/pygm2n.1 @@ -0,0 +1,68 @@ +.\" wing requests are required for all man pages. +.TH pygm2n 1 "Sun Sep 12 18:10:00 CEST 2000" "" "Python Gateway mail to news" +.SH NAME +pygm2n - Python Gateway mail to news +.SH SYNOPSIS +.B pygm2n +.BR -n +.IR newsgroups +[ +.BR -s +.IR newsserver +] +[ +.BR -h +] + +.SH DESCRIPTION +.B IMPORTANT: +this man page is to be continued. The Whole pyg gateway is in +.B devel.\ state. +try -h option for more detailed option. + +pygm2n reads from stdin an email, sending it to newsgroups, a comma separated list without spaces of newsgroup names (at least one), rfc799 compliant. + +If pygm2n reads from stdin a sigle line starting with /, it is +considered an absolute path to a single-email mailbox, +so pygm2n will open and read it. + +.B Note +that now pyg can't read a real mailbox, with many emails. If you +give it in input, pyg will post the whole mailbox as a single email. + +\" The following requests should be uncommented and +.\" used where appropriate. This next request is +.\" for sections 2 and 3 function return values only. +.\" .Sh RETURN VALUES +.\" This next request is for sections 1, 6, 7 & 8 only +.\" .Sh ENVIRONMENT +.\" .Sh FILES +.SH EXAMPLES +There is some documetation in /urs/share/doc/pyg + +I created mailgate user (moderator of local.moderated ng). +Subscribe to a list with this user (or simply email one message to). +Every email posted to this user will send to newsgroups, +in its .procmailrc I've put something like: + +:0 bh +* ^From *mailinglist-request@lists.debian.org +| $HOME/pygm2n -n local.debian.mailinglist + + +.\" This next request is for sections 1, 6, 7 & 8 only +.\" (command return values (to shell) and +.\" fprintf/stderr type diagnostics) +.\" .Sh DIAGNOSTICS +.\" The next request is for sections 2 and 3 error +.\" and signal handling only. +.\" .Sh ERRORS +.\" .Sh SEE ALSO +.\" .Sh STANDARDS +.\" .Sh HISTORY +.SH AUTHORS +Cosimo Alfarano <alfarano@students.cs.unibo.it> + +.SH BUGS +Boh. send any bug, advice or opinion to the author, please. + |