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 "November 2007" Unix "User Manuals"
  34 .SH NAME
  35 modest \- The Modest Mail User Agent
  36 .SH SYNOPSIS
  37 .PP
  38 .B modest
  39 [showui]
  40 .SH DESCRIPTION
  41 .PP
  42 Modest is a graphical e-mail program, targetting resource-constrained
  43 environments, such as older PCs and internet tablets. It aims to be
  44 easy to use and provide a complete e-mail experience, while keeping
  45 the resource usage at a modest level (by 2007 standards).
  46 .SH OPTIONS
  47 .PP
  48 .IP "showui"
  49 To actually start with the UI, you have to provide the 'showui' parameter to
  50 modest. Reason for this not being the default is to allow for DBUS-activation
  51 of various services without showing the UI.
  52 .SH ENVIRONMENT
  53 .PP
  54 .B "MODEST_DEBUG"
  55 The MODEST_DEBUG environment may contain any number of ':'-separated strings
  56 to trigger certain debugging features:
  57 .PP
  58 .IP "abort-on-warning"
  59 Abort the program when any Gtk/Glib warning or error occurs. This can be
  60 useful when running inside a debugger.
  61 .IP "debug-code"
  62 Run various pieces of debug-only code in modest
  63 .IP "log-actions"
  64 Log actions to the log file (not available yet)
  65 .IP "debug-objects"
  66 Debug GObject usage (G_TYPE_DEBUG_OBJECTS)
  67 .IP "debug-signals"
  68 Debug GSignal usage (G_TYPE_DEBUG_SIGNALS)
  69 .IP "factory-settings"
  70 Return all the user-settings to the 'factory defaults'
  71 .SH EXIT CODES
  72 .PP
  73 Normally, modest will exit with 0 as its exit code. In case of any error,
  74 the exit code will be non-zero.
  75 .SH FILES
  76 .PP
  77 .IP "~/.modest/cache"
  78 Modest e-mail cache.
  79 .IP "~/.modest/local_folders"
  80 Root of the local folders hierarchy (in Maildir format)
  81 .SH BUGS
  82 .PP
  83 Some...  If you find one, please let us know!
  84 .SH NO WARRANTIES
  85 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  86 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  87 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  88 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  89 OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  90 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  91 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  92 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  93 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  94 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  95 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  96 .SH SEE ALSO
  97 .PP
  98 .BR mutt (3),
  99 .BR maildir (5),
 100 .PP
 101 Modest Home Page: http://modest.garage.maemo.org/
 102
 103 .PP
 104 .SH COPYRIGHTS
 105 Copyright (c) 2006,2007 Nokia Corporation
 106 All rights reserved.
 107 .PP
 108 .SH AUTHORS
 109 .PP
 110 Dirk-Jan C. Binnema and many others. Modest uses the Tinymail framework,
 111 written by Philip Van Hoof.