[hamradio-commits] [axmail] 01/02: Added manpages and explanation for where they came from

Tue Sep 29 20:50:10 UTC 2015

This is an automated email from the git hooks/post-receive script.

hibby-guest pushed a commit to branch master
in repository axmail.

commit d6dd24ea95cf11a87994b97ca9f5b117a346b5ce
Author: Dave Hibberd <d at vehibberd.com>
Date:   Tue Sep 29 21:27:22 2015 +0100

    Added manpages and explanation for where they came from
---
 debian/README.source          |  4 +++
 debian/axmail.manpages        |  1 +
 debian/manpages/axmail.8      | 84 +++++++++++++++++++++++++++++++++++++++++++
 debian/manpages/axmail.conf.5 | 81 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 170 insertions(+)

diff --git a/debian/README.source b/debian/README.source
new file mode 100644
index 0000000..aa552fa
--- /dev/null
+++ b/debian/README.source
@@ -0,0 +1,4 @@
+Manpages for the binaries are included in the debian/manpages folder.
+These have been supplied by upstream and are in svn and will be included
+in the next major release, however I have included them here for 
+clarity. 
diff --git a/debian/axmail.manpages b/debian/axmail.manpages
new file mode 100644
index 0000000..2fb19fb
--- /dev/null
+++ b/debian/axmail.manpages
@@ -0,0 +1 @@
+debian/manpages/*
diff --git a/debian/manpages/axmail.8 b/debian/manpages/axmail.8
new file mode 100644
index 0000000..f622fc0
--- /dev/null
+++ b/debian/manpages/axmail.8
@@ -0,0 +1,84 @@
+.TH AXMAIL 8 "28 September 2015" Linux "Linux System Managers Manual"
+.SH NAME
+axMail \- A powerful but simple SMTP plugin for URONode.
+.SH SYNOPSIS
+.B axmail %u
+.SH DESCRIPTION
+.LP
+.B axMail\-FAX
+is a simple but powerful SMTP mail plugin for URONode. This package allows
+an end user to read and send SMTP based mail via RF, with many options
+available.
+.SH COMMANDS
+The following commands are supported for users of
+.B axMail\-FAX:
+.TP 14
+.BI ?
+Give short list of available commands.
+.TP 14
+.BI "Autofwd \- 
+allows the end user for forward their mail to this location to any valid SMTP mailbox."
+.TP 14
+.BI "Bye \- 
+Disconnect user from their mailbox."
+.TP 14
+.BI "Cancel \- 
+Exit mailbox, discard any kills."
+.TP 14
+.BI "Delete (number) -\ 
+Delete message number #. Multiple numbers can be space delimited."
+.TP 14
+.BI "Exit \- 
+Quit the mailbox, save changes."
+.TP 14
+.BI "Help (command) -\ 
+Display help for specific command."
+.TP 14
+.BI "Info \- 
+Online information about this application."
+.TP 14
+.BI "Kill \- 
+see Delete. Msg numbers can be space delimited for multi kills."
+.TP 14
+.BI "List \- 
+List your mailbox messages for reading."
+.TP 14
+.BI "Name \- 
+Enter or change your name in your outgoing mail. This does not change your email address."
+.TP 14
+.BI "Quit \- 
+Quit the application, kill messages flagged for deletion."
+.TP 14
+.BI "Read (number) \- 
+Read message number #. You may reply to it after reading it by using the Send Reply (SReply) command."
+.TP 14
+.BI "Send \- 
+Send a message. axMail will prompt you through everything step by step and also will ask you for two layers of receipt generations.
+.TP 14
+.BI "STatus \- 
+Quick listing of your mailbox status."
+.TP 14
+.BI "Unkill \- 
+Undelete or unkill a message flagged for deletion."
+.TP 14
+.BI "Verbose \- 
+Read your mail with full message headers for debugging."
+.SH FILES
+.LP
+.TP 5
+.B /usr/local/etc/ax25/axmail.conf
+axMail configuration file.
+.br
+.TP 5
+.B /etc/postfix/main.cf
+postfix configuration file.
+.br
+.SH AUTHORS
+Brian Rogers (N1URO) <n1uro at n1uro.com>
+.br
+.SH OTHERS
+Marius Petrescu (YO2LOJ) <mpetrescu at online.ro>
+.br
+Bob Tenty (VE3TOK) <ve3tok at gmail.com>
+.br
+Heikki Hannikainen (OH7LZB) <hessu at hes.iki.fi>
diff --git a/debian/manpages/axmail.conf.5 b/debian/manpages/axmail.conf.5
new file mode 100644
index 0000000..72740ec
--- /dev/null
+++ b/debian/manpages/axmail.conf.5
@@ -0,0 +1,81 @@
+.TH AXMAIL.CONF 5 "28 September 2015" Linux "Linux System Managers Manual"
+.SH NAME
+axMail \- A powerful but simple SMTP plugin for URONode.
+.SH SYNOPSIS
+.B axmail.conf
+.SH DESCRIPTION
+.LP
+.B axmail.conf
+This file configures the operations of axMail\-FAX. You have to insure that
+you add the proper group using addgroup. The common one to use is "ax25".
+.SH COMMANDS
+The following opions are supported for
+.B axmail.conf:
+.TP 14
+.BI "IdleTimeout"
+This should not be longer than the same command in uronode.conf.
+.TP 14
+.BI "HostName"
+This is the fully qualified hostname of your mail system. Typically this
+would be an amprnet domnain such as n1uro.ampr.org.
+.TP 14
+.BI "AllowMail"
+This command controls who has access to use mail on your system. The
+default is all.
+.TP 14
+.BI "Identification"
+This shows how users can authenticate into the application. The default is
+none as the password used over RF may also be used for popping/imap if
+the local sysop chooses to do this.
+Disconnect user from their mailbox."
+.TP 14
+.BI "AutoCreate"
+This allows creation of the user accounts. Since you can also configure
+dovecot or a pop3 daemon and pop-before-smtp to allow mail on smartphones
+as well, this should be set to yes which is default.
+.TP 14
+.BI "LoginAllowed"
+This grants or denies permissions for other functions such as ssh on the
+box. This also controls access to imap/pop. Default is yes.
+.TP 14
+.BI "AutoGroup"
+I suggest using ax25. You'll have to set this using addgroup ax25.
+.TP 14
+.BI "First_uid"
+This is the first user id numeric to be used when axmail creates accounts.
+I suggest 2000 as this keeps mail clients 1000 UID away from actual local
+clients so it'll somewhat separate them this way.
+.TP 14
+.BI "Last_uid"
+This sets just how many users may create and use mailboxes using axmail.
+.TP 14
+.BI "HomeDir"
+This sets the base of the users home directory. I suggest using the
+standard home directory for all users.
+.TP 14
+.BI "Shell"
+This is the shell the users are granted. I suggest if you wish not to allow
+ssh or telnet access into your server to use /bin/false.
+.TP 14
+.BI "FaxGate"
+This is the efax gateway to send your faxes through to. The SFax command
+will preformat your mail to use this gateway. Remove the quotes.
+.SH FILES
+.LP
+.TP 5
+.B /usr/local/etc/ax25/welcome.txt
+Greeting file for new users to welcome them to the mail system.
+.br
+.TP 5
+.B /etc/postfix/main.cf
+postfix configuration file.
+.br
+.SH AUTHORS
+Brian Rogers (N1URO) <n1uro at n1uro.com>
+.br
+.SH OTHERS
+Marius Petrescu (YO2LOJ) <mpetrescu at online.ro>
+.br
+Bob Tenty (VE3TOK) <ve3tok at gmail.com>
+.br
+Heikki Hannikainen (OH7LZB) <hessu at hes.iki.fi>

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-hamradio/axmail.git

