'\" t
.\"     Title: imaprowl
.\"    Author: Takuo Kitame <kitame@debian.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 04/23/2014
.\"    Manual: IMAProwl User Manual
.\"    Source: imaprowl
.\"  Language: English
.\"
.TH "IMAPROWL" "1" "04/23/2014" "imaprowl" "IMAProwl User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
imaprowl \- IMAP new mail notification utility for iPhone using Prowl Public API
.SH "SYNOPSIS"
.HP \w'\fBimaprowl\fR\ 'u
\fBimaprowl\fR \fB\-c\ \fR\fB\fIFILENAME\fR\fR [\fB\-\-config\ \fR\fBFILENAME\fR] [{\fB\-q\fR\ |\ \fB\-\-daemon\fR}] [{\fB\-d\fR\ |\ \fB\-\-debug\fR}]
.HP \w'\fBimaprowl\fR\ 'u
\fBimaprowl\fR [{\fB\-h\fR\ |\ \fB\-\-help\fR} | {\fB\-v\fR\ |\ \fB\-\-version\fR}]
.SH "DESCRIPTION"
.PP
This manual page documents briefly the
\fBimaprowl\fR
command\&.
.PP
This manual page was written for the Debian distribution because the original program does not have a manual page\&.
.PP
\fBimaprowl\fR
is an IMAP new mail notification utility for iPhone using Prowl Public API
.PP
Prowl is a service and an App for iPhone\*(Aqs Push Notification service\&.(APNs) See
\m[blue]\fB\%idp56771680\fR\m[]
for more about Prowl\&.
.PP
IMAProwl is an utility script to notify new mail of IMAP server with Prowl service\&. It\*(Aqs very useful to push notification of GMail or any other IMAP mail service to your iPhone\&.
.PP
This program uses IMAP/IDLE(RFC2177) or IMAP/NOOP to check the new mail on IMAP server and uses Prowl Public API via HTTPS\&.
.SH "REQUIREMENTS"
.PP
Ruby script language version >= 1\&.9\&.0
.PP
OpenSSL extenstion library for Ruby
.PP
IMAP server must support SSL/TLS connection\&.
.PP
The Prowl service account\&. It\*(Aqs free, you can register at
\m[blue]\fB\%http://prowl.weks.net/\fR\m[]
.PP
Your iPhone deveice and the Prowl\&.app from AppStore\&.
.SH "OPTIONS"
.PP
The program follows the usual GNU command line syntax, with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&.
.PP
\fB\-c \fR\fB\fIFILENAME\fR\fR, \fB\-\-config \fR\fB\fIFILENAME\fR\fR
.RS 4
Configuration file to load\&.
.RE
.PP
\fB\-q\fR, \fB\-\-daemon\fR
.RS 4
Enable daemon mode\&. imaprowl will launch as background process\&.
.RE
.PP
\fB\-d\fR, \fB\-\-debug\fR
.RS 4
Enable debug output\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show summary of options\&.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Show version of program\&.
.RE
.SH "FILES"
.PP
${HOME}/\&.imaprowl\&.conf
.RS 4
The per\-user configuration file to control the behaviour of
imaprowl\&. See /usr/share/doc/imaprowl/examples/config\&.yml for further details\&.
.RE
.SH "ISSUES"
.PP
The program is currently limited to only work with the
ruby1\&.9\&.
.PP
The upstreams
Issue tracker
can be found at
\m[blue]\fB\%http://github.com/takuo/IMAProwl/issues\fR\m[]\&.
.SH "AUTHOR"
.PP
\fBTakuo Kitame\fR <\&kitame@debian\&.org\&>
.RS 4
Wrote this manpage for the Debian system\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2009 Takuo Kitame
.br
.PP
This manual page was written for the Debian system (and may be used by others)\&.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation\&.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in
/usr/share/common\-licenses/GPL\&.
.sp