From 064032ea3be5cfd8fd64fc7b89f8b976bb19b5a4 Mon Sep 17 00:00:00 2001 From: Mike Gabriel Date: Tue, 26 Jan 2021 22:14:09 +0100 Subject: man/*: Add man pages for all the command line tools we ship. --- man/ayatana-webmail-clear.1 | 45 ++++++++++++++++++++++++++++++++++++ man/ayatana-webmail-reset.1 | 45 ++++++++++++++++++++++++++++++++++++ man/ayatana-webmail-settings.1 | 38 ++++++++++++++++++++++++++++++ man/ayatana-webmail-url.1 | 40 ++++++++++++++++++++++++++++++++ man/ayatana-webmail.1 | 52 ++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 220 insertions(+) create mode 100644 man/ayatana-webmail-clear.1 create mode 100644 man/ayatana-webmail-reset.1 create mode 100644 man/ayatana-webmail-settings.1 create mode 100644 man/ayatana-webmail-url.1 create mode 100644 man/ayatana-webmail.1 diff --git a/man/ayatana-webmail-clear.1 b/man/ayatana-webmail-clear.1 new file mode 100644 index 0000000..fe2c916 --- /dev/null +++ b/man/ayatana-webmail-clear.1 @@ -0,0 +1,45 @@ +'\" -*- coding: utf-8 -*- +'\" vim:fenc=utf-8 +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH ayatana-webmail-clear 1 "Jan 2021" "Version 21.1.25" "Ayatana Webmail" +.SH NAME +ayatana-webmail-clear \- Webmail Integration into your Desktop +.SH SYNOPSIS +'nh +.fi +.ad l +\fBayatana-webmail-clear\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[ +\fIoptions\fR +] +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +Ayatana Webmail is an application that integrates your webmail into +MATE, Xfce, LXDE and other environments. For further details see the +\fBayatana-webmail\fR(1) man page. +.PP +The \fBayatana-webmail-clear\fR executable is an internal tool of +\fBayatana-webmail\fR, does not have any command line options and should +only be used from the command line, if you know what you are doing. +.PP +\fBayatana-webmail-clear\fR is called internally by the +\fBayatana-webmail\fR app to perform the "Mark all as read" action just +as the "Clear" menu item would do in the "messages" indicator. The +message status update on the IMAP server does not happen immediately, but +only the next time the IMAP server checks in (usually within 10-20 +minutes). +.PP +.SH SEE ALSO +ayatana-webmail(1), ayatana-webmail-reset(1), ayatana-webmail-settings(1), ayatana-webmail-url(1) +.SH AUTHOR +This manual has been written for the Ayatana Indicators project by Mike +Gabriel . diff --git a/man/ayatana-webmail-reset.1 b/man/ayatana-webmail-reset.1 new file mode 100644 index 0000000..2730f5f --- /dev/null +++ b/man/ayatana-webmail-reset.1 @@ -0,0 +1,45 @@ +'\" -*- coding: utf-8 -*- +'\" vim:fenc=utf-8 +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH ayatana-webmail-reset 1 "Jan 2021" "Version 21.1.25" "Ayatana Webmail" +.SH NAME +ayatana-webmail-reset \- Webmail Integration into your Desktop +.SH SYNOPSIS +'nh +.fi +.ad l +\fBayatana-webmail-reset\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[ +\fIoptions\fR +] +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +WARNING: Read the full description below before using this command line tool. +.PP +Ayatana Webmail is an application that integrates your webmail into +MATE, Xfce, LXDE and other environments. For further details see the +\fBayatana-webmail\fR(1) man page. +.PP +When this command gets executed, it will reset the complete +settings for +\fBayatana-webmail\fR to its 'factory-defaults'. All IMAP profiles will +be removed when using this command. You have to reconfigure \fBayatana-webmail\fR from scratch. +Only run this command if you want a fresh start with \fBayatana-webmail\fR. +.PP +The \fBayatana-webmail-reset\fR executable does not have any command line +options. +.PP +.SH SEE ALSO +ayatana-webmail(1), ayatana-webmail-clear(1), ayatana-webmail-settings(1), ayatana-webmail-url(1) +.SH AUTHOR +This manual has been written for the Ayatana Indicators project by Mike +Gabriel . diff --git a/man/ayatana-webmail-settings.1 b/man/ayatana-webmail-settings.1 new file mode 100644 index 0000000..8d8cef7 --- /dev/null +++ b/man/ayatana-webmail-settings.1 @@ -0,0 +1,38 @@ +'\" -*- coding: utf-8 -*- +'\" vim:fenc=utf-8 +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH ayatana-webmail-settings 1 "Jan 2021" "Version 21.1.25" "Ayatana Webmail" +.SH NAME +ayatana-webmail-settings \- Webmail Integration into your Desktop +.SH SYNOPSIS +'nh +.fi +.ad l +\fBayatana-webmail-settings\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[ +\fIoptions\fR +] +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +Ayatana Webmail is an application that integrates your webmail into +MATE, Xfce, LXDE and other environments. For further details see the +\fBayatana-webmail\fR(1) man page. +.PP +The \fBayatana-webmail-settings\fR executable does not have any command +line options. It launches the Ayatana Webmail Configuration dialog +window. +.PP +.SH SEE ALSO +ayatana-webmail(1), ayatana-webmail-clear(1), ayatana-webmail-reset(1), ayatana-webmail-url(1) +.SH AUTHOR +This manual has been written for the Ayatana Indicators project by Mike +Gabriel . diff --git a/man/ayatana-webmail-url.1 b/man/ayatana-webmail-url.1 new file mode 100644 index 0000000..c7e77ab --- /dev/null +++ b/man/ayatana-webmail-url.1 @@ -0,0 +1,40 @@ +'\" -*- coding: utf-8 -*- +'\" vim:fenc=utf-8 +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH ayatana-webmail-url 1 "Jan 2021" "Version 21.1.25" "Ayatana Webmail" +.SH NAME +ayatana-webmail-url \- Webmail Integration into your Desktop (URL launcher) +.SH SYNOPSIS +'nh +.fi +.ad l +\fBayatana-webmail-url\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[ +\fIHome|Compose|Inbox|Sent\fR +] +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +Ayatana Webmail is an application that integrates your webmail into MATE, +Xfce, LXDE and other environments. For further details see the +\fBayatana-webmail\fR(1) man page. +.PP +With \fBayatana-webmail-url\fR you can launch certain functionalities +(Home, Compose, Inbox, Sent) of +\fBayatana-webmail\fR from the command line. +.PP +The \fBayatana-webmail-url\fR executable does not have any command line options. +.PP +.SH SEE ALSO +ayatana-webmail(1), ayatana-webmail-clear(1), ayatana-webmail-reset(1), ayatana-webmail-settings(1) +.SH AUTHOR +This manual has been written for the Ayatana Indicators project by Mike +Gabriel . diff --git a/man/ayatana-webmail.1 b/man/ayatana-webmail.1 new file mode 100644 index 0000000..221295a --- /dev/null +++ b/man/ayatana-webmail.1 @@ -0,0 +1,52 @@ +'\" -*- coding: utf-8 -*- +'\" vim:fenc=utf-8 +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH ayatana-webmail 1 "Jan 2021" "Version 21.1.25" "Ayatana Webmail" +.SH NAME +ayatana-webmail \- Webmail Integration into your Desktop +.SH SYNOPSIS +'nh +.fi +.ad l +\fBayatana-webmail\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[ +\fIoptions\fR +] +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +Ayatana Webmail is an application that integrates your webmail into +MATE, Xfce, LXDE and other environments. +.PP +In the tray applet, it displays notifications about incoming mail, shows +the number of unread messages and displays subjects in the Messaging +Menu. +.PP +The Launcher item also has a quicklist that provides quick access to your +mail folders. It also allows you to quickly compose a new message. +.PP +Ayatana Webmail uses your webmail provider's IMAP server to access +the messages' meta information and status, and mixes in web browser elements +when opening folder lists, message views or message composers. +.PP +Ayatana Webmail can be started via XDG autostart, all you have to do is to enter your +accounts settings in a configuration dialog. +.PP +The \fBayatana-webmail\fR executable does not have any command line +options. It launches the \fBayatana-webmail\fR tray applet. +.SH FILES +~/.config/autostart/ayatana-webmail-autostart.desktop +.PP +.SH SEE ALSO +ayatana-webmail(1), ayatana-webmail-clear(1), ayatana-webmail-reset(1), ayatana-webmail-settings(1), ayatana-webmail-url(1) +.SH AUTHOR +This manual has been written for the Ayatana Indicators project by Mike +Gabriel . -- cgit v1.2.3