Commit db0eb345 authored by Michael Gratton's avatar Michael Gratton 🤞

Merge branch 'wip/243-manual-updates' into 'master'

Update user manual

Closes #243

See merge request !178
parents 377877a4 1379daa2
Pipeline #70469 passed with stages
in 73 minutes and 22 seconds
......@@ -2,69 +2,99 @@
type="guide"
id="accounts">
<info>
<link type="guide" xref="index#overview"/>
<link type="next" xref="archive"/>
</info>
<title>Accounts</title>
<section id="adding-accounts">
<title>Adding accounts</title>
<p>The first time you start Geary, you will be prompted to add an email account. On this screen,
select if your account is Gmail, Yahoo, Outlook.com, or other. For other account types, you will
need to enter your IMAP and SMTP login settings manually.</p>
<p>Additional accounts can be added from the Accounts dialog. The <gui>Accounts</gui> option is
available in either Geary's application menu or the gear menu in the upper-right of the
toolbar. (The location depends on the install desktop shell. For GNOME Shell and Unity, the
application menu is available near the top-left corner of the screen.)
To add an account, click the + button.</p>
</section>
<section id="editing-accounts">
<title>Editing existing accounts</title>
<p>From the Accounts dialog, select an account and click the pencil icon to change various settings.
Please note that Geary cannot change server settings on an existing account. If you need to
change your IMAP or SMTP server, you will need to delete the account and re-add it.</p>
<p>To change the order that accounts are displayed in the folder list, drag the accounts in the
Accounts dialog to the desired order.</p>
<p>There are some advanced options available when editing accounts:</p>
<list>
<item><p>The <gui>Save sent mail</gui> checkbox controls whether Geary will push successfully sent
messages up to the account's <gui>Sent Mail</gui> folder. For Gmail accounts, this happens
automatically. Yahoo and some other accounts can be configured to do this automatically as well.
For other accounts, if you disable this setting, you may be unable to view messages you've
sent.</p></item>
<item><p>The <gui>Sign emails</gui> checkbox indicates whether a signature will be automatically
inserted when a composer is opened. You may enter the signature into the box immediately
below. You may use HTML tags to style the text. Switch to a preview of the signature using the
buttons to the right.</p>
<p>If you leave the signature in the Accounts dialog blank, Geary will use the
<file>.signature</file> file in your home directory, if it exists. This file may contain either
plain text or HTML markup. In the latter case, the markup will be inserted directly into the
composer, without any escaping.</p></item>
<item><p>The <gui>Download mail</gui> drop-down allows you to configure how much mail Geary will keep
locally. Geary can only use locally available mail when searching and forming
conversations.</p></item>
</list>
</section>
<section id="removing-accounts">
<title>Removing accounts</title>
<p>To delete an account, open the Accounts dialog, select the account, and press the - button.
Geary will delete all information associated with the account.</p>
</section>
</page>
<info>
<link type="guide" xref="index#overview"/>
<link type="next" xref="archive"/>
</info>
<title>Accounts</title>
<section id="accounts-editor">
<title>Accounts Editor</title>
<p>Your email accounts can be added, updated, and removed using
the <em>accounts editor</em>. To open it, click Geary’s
application menu button in the main window above the folder list,
then click <gui>Accounts</gui> in the pop-up menu.</p>
<p>To change the order that accounts are displayed in the folder
list, click and drag the handle for an account in the accounts
editor, or focus an account with <key>Tab</key>, then use
<keyseq><key>Ctrl</key><key>↑</key></keyseq> and
<keyseq><key>Ctrl</key><key>↓</key></keyseq> to re-position the
currently selected account.</p>
</section>
<section id="adding-accounts">
<title>Adding accounts</title>
<p>Geary will automatically use any email accounts you have added
via the <app>Online Accounts</app> panel of <app>GNOME
Settings</app>. If you do not have any accounts added to
<app>Online Accounts</app>, you will be prompted to add an account
the first time you run Geary.</p>
<p>To add additional accounts, open the accounts editor, then
choose the appropriate email provider from the list at the bottom
of the window. For providers supported by <app>Online
Accounts</app>, <app>GNOME Settings</app> will be opened and you
will be asked for your account information there. For other email
providers, you will be asked for your account information by
Geary. Once entered, click <gui>Create</gui> and the account
information will be checked and then added.</p>
</section>
<section id="editing-accounts">
<title>Updating existing accounts</title>
<p>To update existing accounts, open the accounts editor and
choose the account you wish to update. Geary will display settings
for the account. From there, you can add and remove additional
sender email addresses, edit your email signature, and various
other settings.</p>
<p>The <gui>Download mail</gui> setting allows you to configure
how much mail Geary will download and store locally. Geary can
only use locally available mail when displaying and searching for
conversations.</p>
<p>To edit the server settings for the account, scroll to the
bottom of the window and click <gui>Server Settings</gui>. The
server settings will be displayed and you can click to edit
them. Once done, click <gui>Apply</gui> and Geary will check the
settings, then update the account. Note that accounts added via
the <app>Online Accounts</app> panel of <app>GNOME Settings</app>
cannot have their server name, security, login, or password
settings changed.</p>
<p>The <gui>Save draft email on server</gui> checkbox controls
whether the composer will save copies of email messages being
written in the <gui>Drafts</gui> folder. If de-selected, you will
not be able to save draft messages when closing the composer.</p>
<p>The <gui>Save sent email on server</gui> checkbox controls
whether Geary will save copies of email that have been sent
to the <gui>Sent</gui> folder. If de-selected, you will no be able
to see any email messages you have sent, unless your server
automatically saves them for you.</p>
</section>
<section id="removing-accounts">
<title>Removing accounts</title>
<p>Accounts added via the <app>Online Accounts</app> panel of
<app>GNOME Settings</app> must also be removed from there. To do
so, open <app>Online Accounts</app>, select the account, and click
<gui>Remove</gui>.</p>
<p>To remove an account added via Geary, open the accounts editor
and choose the account you wish to remove. Geary will display
settings for the account. Scroll to the bottom of the window and
click <gui>Remove Account</gui>. You will be prompted to confirm
removing the account. Once confirmed, if you change your mind you
can still undo removing the account by clicking <gui>Undo</gui> in
the popup notification, or by typing
<keyseq><key>Ctrl</key><key>U</key></keyseq>.</p>
</section>
</page>
This diff is collapsed.
......@@ -2,18 +2,21 @@
type="guide"
id="index">
<title><media type="image" src="figures/geary.svg"></media> Geary</title>
<title>
<media type="image" src="figures/geary.svg" width="64" height="64"></media>
<span>Geary</span>
</title>
<section id="introduction" style="2column">
<title>Introduction</title>
</section>
<section id="introduction" style="2column">
<title>Introduction</title>
</section>
<section id="overview" style="2column">
<title>Using Geary</title>
</section>
<section id="overview" style="2column">
<title>Using Geary</title>
</section>
<section id="contribute" style="2column">
<title>Contributing and bug reporting</title>
</section>
<section id="contribute" style="2column">
<title>Contributing and bug reporting</title>
</section>
</page>
......@@ -2,57 +2,93 @@
type="guide"
id="overview">
<info>
<link type="guide" xref="index#introduction"/>
</info>
<title>Overview</title>
<info>
<link type="guide" xref="index#introduction"/>
</info>
<p>Geary is a lightweight email reader for the <link href="http://gnome.org">GNOME</link> desktop.
It works with mail servers that
support the IMAP protocol, including popular services such as Gmail, Yahoo Mail, and Outlook.com.</p>
<title>Overview</title>
<p>Geary groups mail messages into <em>conversations</em>. A conversation contains all
messages in a single thread of discussion.</p>
<p>Geary is an email application built around conversations, for the
GNOME 3 desktop. It allows you to read, find and send email with a
straightforward, modern interface.</p>
<p>The main Geary window is divided into several areas:</p>
<section id="folder-list">
<p>Conversations allow you to read a complete discussion without
having to find and click from message to message.</p>
<p>The main Geary window is divided into several areas: The folder
list, the conversation list, and the conversation viewer.</p>
<section id="folder-list">
<title>Folder list</title>
<p>The <em>folder list</em> at the left displays all <em>folders</em> and
<em>labels</em> in your mail account. Geary uses the term <em>label</em> for any folder
that you have created to help organize your messages. (The Gmail web interface
also uses this term; most other mail services do not.)</p>
</section>
<section id="conversation-list">
<p>The <em>folder list</em> displays all <em>folders</em> and
<em>labels</em> for your email accounts. Geary uses the term
<em>label</em> for any folder that you have created to organize
your email messages.</p>
<p>Select a folder or label to display the conversations it
contains in the conversation list.</p>
</section>
<section id="conversation-list">
<title>Conversation list</title>
<p>The <em>conversation list</em> displays a list of conversations in the
selected folder. Newer conversations appear at the top.</p>
<p>Each sender's name appears bold if there are unread messages from that sender.
If a conversation has more than one message, Geary displays a count of messages
in the conversation.</p>
<p>Geary does not automatically download all messages in all of your mail folders. When you first visit your Inbox or any other folder, Geary downloads the 50 most recent messages in that folder. To see more messages, simply scroll down the conversation list and Geary will fetch more messages automatically.</p>
<p>Some commands in Geary can
act on a group of conversations. To select multiple conversations, hold down the
<key>Ctrl</key> key and click each conversation in turn in the conversation list.
Alternatively, click the first
conversation in a range, then hold down <key>Shift</key> and click the last conversation.</p>
</section>
<section id="message-area">
<title>Message area</title>
<p>The <em>message area</em> displays all messages in the selected conversation,
with the oldest message at the top.</p>
<p>At the upper right of each message, Geary displays a dropdown arrow that
lets you open the <em>message menu</em> with commands that operate on the message.</p>
<p>When you view a conversation, Geary collapses messages that you've already read. Click collapsed messages to expand them. Click an expanded message's header to collapse it.</p>
<p>Any attachments in a message appear at the bottom of the message. You can click
an attachment to open it or right-click to save it.</p>
<p>Geary uses <link href="https://secure.gravatar.com/">Gravatar</link> to display an avatar for each
message's sender in its header.</p>
</section>
</page>
<p>The <em>conversation list</em> displays a list of
conversations in the selected folder. Newer conversations appear
at the top.</p>
<p>Each sender’s name appears bold if there are unread messages
from that sender. If a conversation has more than one message,
Geary displays a count of messages in the conversation.</p>
<p>Geary does not automatically download all messages in all of
your mail folders. When you first visit your Inbox or any other
folder, Geary downloads the most recent messages in that
folder. To see more messages, simply scroll down the conversation
list and Geary will fetch more messages automatically.</p>
<p>Some commands in Geary can act on a group of conversations. To
select multiple conversations, hold down the <key>Ctrl</key> key
and click each conversation in turn in the conversation list.
Alternatively, click the first conversation in a range, then hold
down <key>Shift</key> and click the last conversation.</p>
</section>
<section id="conversation-viewer">
<title>Conversation viewer</title>
<p>The <em>conversation viewer</em> displays all email messages in
the selected conversation, with the oldest message at the top.</p>
<p>When you view a conversation, Geary collapses messages that
you’ve already read. Click collapsed messages to expand
them. Click an expanded message’s header to collapse it.</p>
<p>Click on any of the sender’s or receiver’s names or email
address for a message to open the <em>contact menu</em>, which
displays additional information and options for the email
address. You can to start a new conversation, copy the email
address to the clipboard, and search for related conversations. If
the email address is present in your desktop address book, it will
show the contact’s photo, preferred name, and whether they are a
favourite contact. You can also open the contact in the address
book. If the email address is not already present, you can choose
to add them to the address book, and update the remote image
loading preference for that address.</p>
<p>Click the star button present on each message to mark or
un-mark a message as being starred. Staring a message will mark
the whole conversation as starred, and Geary will display the
first starred message in a conversation when returning to it.</p>
<p>Click the menu button present on each message to open the
<em>message menu</em>, which allows you to reply and forward to a
specific message, update which messages have been marked as read
or unread, print a message, and so on.</p>
<p>Any attachments in a message appear at the bottom of the
message. Double click an attachment to open it, or use the Open and Save
buttons to open and save selected attachments.</p>
</section>
</page>
......@@ -29,7 +29,7 @@
</tr>
<tr>
<td><p><input>bcc:<var>recipient</var></input></p></td>
<td><p>Finds messages where <var>recipient</var> matches the BCC header.</p></td>
<td><p>Finds messages where <var>recipient</var> matches email BCC fields.</p></td>
</tr>
<tr>
<td><p><input>body:<var>text</var></input></p></td>
......@@ -37,11 +37,11 @@
</tr>
<tr>
<td><p><input>cc:<var>recipient</var></input></p></td>
<td><p>Finds messages where <var>recipient</var> matches the CC header.</p></td>
<td><p>Finds messages where <var>recipient</var> matches email CC fields.</p></td>
</tr>
<tr>
<td><p><input>from:<var>sender</var></input></p></td>
<td><p>Finds messages where <var>sender</var> matches the From header.</p></td>
<td><p>Finds messages where <var>sender</var> matches email From fields.</p></td>
</tr>
<tr>
<td><p><input>is:read</input></p></td>
......@@ -61,7 +61,7 @@
</tr>
<tr>
<td><p><input>to:<var>recipient</var></input></p></td>
<td><p>Finds messages where <var>recipient</var> matches the To, CC, or BCC header.</p></td>
<td><p>Finds messages where <var>recipient</var> matches email To, CC, or BCC fields.</p></td>
</tr>
</table>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment