Merge pull request #49 from Vincent-C/master

Add manual pages and update readme file
This commit is contained in:
Patrick Ulbrich
2012-12-17 10:22:41 -08:00
3 changed files with 43 additions and 0 deletions

View File

@@ -21,6 +21,13 @@ Issue the following commands in a terminal to enable the PPA and install Mailnag
sudo apt-get update
sudo apt-get install mailnag
As of Ubuntu 13.04 (Raring) onwards, Mailnag is also available in the official repos.
Run `sudo apt-get install mailnag` in a terminal to install it.
### Debian
Mailnag is currently available in Debian unstable.
Run `sudo apt-get install mailnag` in a terminal to install it.
### Fedora
As of Fedora 17, Mailnag is available in the official Fedora repos.
Just run `yum install mailnag` (as root) in a terminal to install the package.

19
data/mailnag.1 Normal file
View File

@@ -0,0 +1,19 @@
.TH MAILNAG "1" "November 2012" "Mailnag 0.5.0"
.SH NAME
mailnag \- a mail notification daemon for GNOME 3
.SH SYNOPSIS
\fBmailnag\fP
.SH DESCRIPTION
\fBmailnag\fP checks POP3 and IMAP servers for new mail. When it finds new
messages, it creates a GNOME 3 notification (integrated with the Shell) that
mentions sender and subject.
.PP
Note that you must first run \fBmailnag_config\fR to setup Mailnag.
.SH SEE ALSO
.PP
\fBmailnag_config\fP(1)
.SH AUTHOR
\fBmailnag\fP was written by Patrick Ulbrich <zulu99@gmx.net>.
.PP
This manual page was written by Vincent Cheng <Vincentc1208@gmail.com>,
for the Debian project (and may be used by others).

17
data/mailnag_config.1 Normal file
View File

@@ -0,0 +1,17 @@
.TH MAILNAG_CONFIG "1" "November 2012" "Mailnag 0.5.0"
.SH NAME
mailnag_config \- a helper script to setup Mailnag
.SH SYNOPSIS
\fBmailnag_config\fP
.SH DESCRIPTION
\fBmailnag_config\fP is a script that makes it easy to setup Mailnag
initially. This only needs to be run once; after running it and closing the
configuration window, Mailnag will be started automatically.
.SH SEE ALSO
.PP
\fBmailnag\fP(1)
.SH AUTHOR
\fBmailnag\fP was written by Patrick Ulbrich <zulu99@gmx.net>.
.PP
This manual page was written by Vincent Cheng <Vincentc1208@gmail.com>,
for the Debian project (and may be used by others).