| 1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. |
|---|
| 2 | .TH PKMAIL "1" "April 2006" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" |
|---|
| 3 | .SH NAME |
|---|
| 4 | pkmail \- manual page for pkmail 1.24_unofficial |
|---|
| 5 | .SH DESCRIPTION |
|---|
| 6 | pkmail v1.24_unofficial (c) 2003, 2004, 2005, 2006 Jerome Alet \- alet@librelogiciel.com |
|---|
| 7 | .PP |
|---|
| 8 | Email gateway for PyKota. |
|---|
| 9 | .PP |
|---|
| 10 | command line usage : |
|---|
| 11 | .TP |
|---|
| 12 | pkmail |
|---|
| 13 | [options] |
|---|
| 14 | .PP |
|---|
| 15 | options : |
|---|
| 16 | .TP |
|---|
| 17 | \fB\-v\fR | \fB\-\-version\fR |
|---|
| 18 | Prints pkmail's version number then exits. |
|---|
| 19 | .TP |
|---|
| 20 | \fB\-h\fR | \fB\-\-help\fR |
|---|
| 21 | Prints this message then exits. |
|---|
| 22 | .IP |
|---|
| 23 | This command is meant to be used from your mail server's aliases file, |
|---|
| 24 | as a pipe. It will then accept commands send to it in email messages, |
|---|
| 25 | and will send the answer to the command's originator. |
|---|
| 26 | .IP |
|---|
| 27 | To use this command, create an email alias in /etc/aliases with |
|---|
| 28 | the following format : |
|---|
| 29 | .IP |
|---|
| 30 | pykotacmd: "|/usr/bin/pkmail" |
|---|
| 31 | .IP |
|---|
| 32 | Then run the 'newaliases' command to regenerate the aliases database. |
|---|
| 33 | .IP |
|---|
| 34 | You can now send commands by email to 'pykotacmd@yourdomain.com', with |
|---|
| 35 | the command in the subject. |
|---|
| 36 | .IP |
|---|
| 37 | List of supported commands : |
|---|
| 38 | .IP |
|---|
| 39 | report [username] |
|---|
| 40 | .IP |
|---|
| 41 | NB : For pkmail to work correctly, you may have to put the 'mail' |
|---|
| 42 | system user in the 'pykota' system group to ensure this user can |
|---|
| 43 | read the /etc/pykota/pykotadmin.conf file, and restart your |
|---|
| 44 | mail server (e.g. /etc/init.d/exim restart). It is strongly advised |
|---|
| 45 | that you think at least twice before doing this though. |
|---|
| 46 | .IP |
|---|
| 47 | Use at your own risk ! |
|---|
| 48 | .PP |
|---|
| 49 | This program is free software; you can redistribute it and/or modify |
|---|
| 50 | it under the terms of the GNU General Public License as published by |
|---|
| 51 | the Free Software Foundation; either version 2 of the License, or |
|---|
| 52 | (at your option) any later version. |
|---|
| 53 | .PP |
|---|
| 54 | This program is distributed in the hope that it will be useful, |
|---|
| 55 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 56 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 57 | GNU General Public License for more details. |
|---|
| 58 | .PP |
|---|
| 59 | You should have received a copy of the GNU General Public License |
|---|
| 60 | along with this program; if not, write to the Free Software |
|---|
| 61 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA. |
|---|
| 62 | .PP |
|---|
| 63 | Please report bugs to : Jerome Alet \- alet@librelogiciel.com |
|---|
