git.maemo.org Git - modest/blob - man/modest.1

   1 .\" -*-nroff-*-
   2 .\"
   3 .\"
   4 .\"    Copyright (c) 2006,2007 Nokia Corporation
   5 .\"    All rights reserved.
   6 .\"
   7 .\"    Redistribution and use in source and binary forms, with or without
   8 .\"    modification, are permitted provided that the following conditions are
   9 .\"    met:
  10 .\"
  11 .\"    * Redistributions of source code must retain the above copyright
  12 .\"      notice, this list of conditions and the following disclaimer.
  13 .\"    * Redistributions in binary form must reproduce the above copyright
  14 .\"      notice, this list of conditions and the following disclaimer in the
  15 .\"      documentation and/or other materials provided with the distribution.
  16 .\"    * Neither the name of the Nokia Corporation nor the names of its
  17 .\"      contributors may be used to endorse or promote products derived from
  18 .\"      this software without specific prior written permission.
  19 .\"
  20 .\"    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  21 .\"    IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  22 .\"    TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  23 .\"    PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  24 .\"    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25 .\"    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26 .\"    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  27 .\"    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  28 .\"    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  29 .\"    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30 .\"    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 .\"
  32 .\"
  33 .TH modest 1 "February 2007" Unix "User Manuals"
  34 .SH NAME
  35 modest \- The Modest Mail User Agent
  36 .SH SYNOPSIS
  37 .PP
  38 .B modest
  39 [-m \fIaddress\fP]
  40 [-s \fIsubject\fP]
  41 [-b \fIbody\fP]
  42 [-c \fIcc\fP]
  43 [-x \fIbcc\fP]
  44 [-a \fIaccount\fP]
  45 [-b]
  46 .SH DESCRIPTION
  47 .PP
  48 Modest is a graphical e-mail program, targetting resource constrained
  49 environments, such as older PCs and internet tablets. It aims to be
  50 easy to use and provide a complete e-mail experience, while keeping
  51 the resource usage at a modest level (by 2007 standards).
  52 .SH OPTIONS
  53 .PP
  54 .IP "-m, --mailto \fIaddress\fP"
  55 Specify the To: address for the message
  56 .IP "-s, --subject \fIsubject\fP"
  57 Specify the subject for the message
  58 .IP "-b, --body \fIbody\fP"
  59 Specify the body for the message
  60 .IP "-c, --cc \fIaddress\fP"
  61 Specify a Cc: address for the message
  62 .IP "-x, --bcc \fIaddress\fP"
  63 Specify a Bcc: address for the message
  64 .IP "-a, --account \fIaccount\fP"
  65 Use the given (named) account
  66 .IP "-y, --batch"
  67 Use batch mode (don't show graphical UI)
  68 .IP "-h"
  69 Display help.
  70 .SH ENVIRONMENT
  71 .PP
  72 .B "MODEST_DEBUG"
  73 The MODEST_DEBUG environment can contain an number of ':'-separated strings
  74 to trigger certain debugging features:
  75 .PP
  76 .IP "abort-on-warning"
  77 Abort the program when any Gtk/Glib warning or error occurs. This can be
  78 useful when running inside a debugger.
  79 .IP "log-actions"
  80 Log actions to the log file (not available yet)
  81 .IP "debug-objects"
  82 Debug GObject usage (G_TYPE_DEBUG_OBJECTS)
  83 .IP "debug-signals"
  84 Debug GSignal usage (G_TYPE_DEBUG_SIGNALS)
  85 .IP "factory-settings"
  86 Return all the user-settings to the 'factory defaults'
  87 .SH EXIT CODES
  88 .PP
  89 .IP "0: no error"
  90 .IP "1: error in the options given to the program"
  91 .IP "2: error getting configuration data"
  92 .IP "3: error int the graphical user interface"
  93 .IP "4: error with Hildon (maemo-only)"
  94 .IP "5: error running"
  95 .IP "6: error sending mail"
  96 .IP "7: error in one or more of the paramaters"
  97 .IP "8: error in initialization"
  98 .SH FILES
  99 .PP
 100 .IP "~/.modest/cache"
 101 Modest e-mail cache.
 102 .IP "~/.modest/local_folders"
 103 Root of the local folders hierarchy (in Maildir format)
 104 .SH BUGS
 105 .PP
 106 Some...  If you find one, please let us know!
 107 .SH NO WARRANTIES
 108 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 109 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 110 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 111 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 112 OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 113 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 114 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 115 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 116 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 117 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 118 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 119 .SH SEE ALSO
 120 .PP
 121 .BR mutt (3),
 122 .BR maildir (5),
 123 .PP
 124 Modest Home Page: http://modest.garage.maemo.org/
 125 .PP
 126 .SH COPYRIGHTS
 127 Copyright (c) 2006,2007 Nokia Corporation
 128 All rights reserved.
 129 .PP
 130 .SH AUTHORS
 131 .PP
 132 Dirk-Jan C. Binnema and many others. Modest uses the Tinymail framework,
 133 written by Philip Van Hoof.