trojita/docs/trojita.1

0001 .\"
0002 .\" Copyright (C) 2022 Caspar Schutijser <caspar@schutijser.com>
0003 .\"
0004 .\" This file is part of the Trojita Qt IMAP e-mail client,
0005 .\" http://trojita.flaska.net/
0006 .\"
0007 .\" This program is free software; you can redistribute it and/or
0008 .\" modify it under the terms of the GNU General Public License as
0009 .\" published by the Free Software Foundation; either version 2 of
0010 .\" the License or (at your option) version 3 or any later version
0011 .\" accepted by the membership of KDE e.V. (or its successor approved
0012 .\" by the membership of KDE e.V.), which shall act as a proxy
0013 .\" defined in Section 14 of version 3 of the license.
0014 .\"
0015 .\" This program is distributed in the hope that it will be useful,
0016 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
0017 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0018 .\" GNU General Public License for more details.
0019 .\"
0020 .\" You should have received a copy of the GNU General Public License
0021 .\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
0022 .\"
0023 .Dd $Mdocdate$
0024 .Dt TROJITA 1
0025 .Os
0026 .Sh NAME
0027 .Nm trojita
0028 .Nd fast Qt IMAP e-mail client
0029 .Sh SYNOPSIS
0030 .Nm
0031 .Op Fl achlmv
0032 .Op Fl p Ar profile
0033 .Op url
0034 .Sh DESCRIPTION
0035 .Nm
0036 is a fast Qt IMAP e-mail client.
0037 Optionally,
0038 an RFC2368 mailto
0039 .Ar url
0040 may be specified.
0041 This will open the compose window with a message
0042 constructed from the specified URL.
0043 .Pp
0044 .Nm
0045 supports multiple profiles which allows the use of multiple IMAP accounts.
0046 Multiple instances of
0047 .Nm ,
0048 each using a different profile,
0049 may be started concurrently.
0050 A profile may be specified using
0051 .Fl p .
0052 .Pp
0053 The options are as follows:
0054 .Bl -tag -width Ds
0055 .It Fl a , -addressbook
0056 Show the addressbook window.
0057 .It Fl c , -compose
0058 Compose a new e-mail
0059 (default when
0060 .Ar url
0061 is provided).
0062 .It Fl h , -help
0063 Show help text.
0064 .It Fl l , -log-to-disk
0065 Activate debug traffic logging to disk immediately on startup.
0066 .It Fl m , -mainwindow
0067 Show the main window
0068 (default when no option is provided).
0069 .It Fl p , -profile Ar profile
0070 Use the specified profile.
0071 .It Fl v , -version
0072 Show the version of
0073 .Nm .
0074 .El
0075 .Sh FILES
0076 The location of
0077 .Nm Ns 's
0078 configuration file and cache is determined by Qt.
0079 On XDG platforms,
0080 the configuration file can be found in
0081 .Pa ~/.config/flaska.net
0082 while the cache can be found in
0083 .Pa ~/.cache/flaska.net .
0084 For more details and information about other platforms,
0085 see
0086 .Lk https://doc.qt.io/qt-5/qstandardpaths.html#StandardLocation-enum .
0087 .Sh EXAMPLES
0088 Compose a new e-mail to
0089 .Mt alice@example.net :
0090 .Bd -literal -offset indent
0091 $ trojita -c 'mailto:alice@example.net?subject=Hi&body=Message.'
0092 .Ed
0093 .Pp
0094 Launch
0095 .Nm
0096 using a profile:
0097 .Bd -literal -offset indent
0098 $ trojita -p work
0099 .Ed
0100 .Sh SEE ALSO
0101 .Lk http://trojita.flaska.net/