[evolution] Add a man page for evolution
- From: Milan Crha <mcrha src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution] Add a man page for evolution
- Date: Wed, 12 Sep 2018 11:55:38 +0000 (UTC)
commit 62d30aca65f9a7aa01e8de6df5454a606b330c64
Author: Milan Crha <mcrha redhat com>
Date: Mon Sep 3 13:59:09 2018 +0200
Add a man page for evolution
CMakeLists.txt | 7 +++----
docs/CMakeLists.txt | 8 +++++++-
docs/evolution.1 | 47 +++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 57 insertions(+), 5 deletions(-)
---
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 734ecc9737..8611364e89 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -126,6 +126,7 @@ add_printable_variable_path(LIBEXEC_INSTALL_DIR "Install directory for library e
add_printable_variable_path(SHARE_INSTALL_PREFIX "Install directory for shared files, defaults to
CMAKE_INSTALL_PREFIX/share" "")
add_printable_variable_path(LOCALE_INSTALL_DIR "Install directory for locale files, defaults to
SHARE_INSTALL_PREFIX/locale" "")
add_printable_variable_path(SYSCONF_INSTALL_DIR "Install directory for system configuration files, defaults
to CMAKE_INSTALL_PREFIX/etc" "")
+add_printable_variable_path(MAN_INSTALL_DIR "Install directory for manual pages, defaults to
SHARE_INSTALL_PREFIX/man" "")
macro(ensure_default_value _var _defvalue)
if(${_var} STREQUAL "")
@@ -140,6 +141,7 @@ ensure_default_value(LIBEXEC_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/libexec")
ensure_default_value(SHARE_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}/share")
ensure_default_value(LOCALE_INSTALL_DIR "${SHARE_INSTALL_PREFIX}/locale")
ensure_default_value(SYSCONF_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/etc")
+ensure_default_value(MAN_INSTALL_DIR "${SHARE_INSTALL_PREFIX}/man")
# ******************************
# Special directories
@@ -757,14 +759,11 @@ add_pkgconfig_file(evolution-mail.pc.in evolution-mail-${INTERFACE_VERSION}.pc)
add_pkgconfig_file(evolution-shell.pc.in evolution-shell-${INTERFACE_VERSION}.pc)
add_subdirectory(data)
+add_subdirectory(docs)
add_subdirectory(po)
add_subdirectory(src)
add_subdirectory(tests)
-if(ENABLE_GTK_DOC)
- add_subdirectory(docs)
-endif(ENABLE_GTK_DOC)
-
if(WITH_HELP)
add_subdirectory(help)
endif(WITH_HELP)
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index 90bb2b5963..0bc0820cdd 100644
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -1 +1,7 @@
-add_subdirectory(reference)
+install(FILES evolution.1
+ DESTINATION ${MAN_INSTALL_DIR}/man1
+)
+
+if(ENABLE_GTK_DOC)
+ add_subdirectory(reference)
+endif(ENABLE_GTK_DOC)
diff --git a/docs/evolution.1 b/docs/evolution.1
new file mode 100644
index 0000000000..58e338a50b
--- /dev/null
+++ b/docs/evolution.1
@@ -0,0 +1,47 @@
+.TH "EVOLUTION" "1" "Aug 27, 2018" "" ""
+.SH NAME
+evolution \- The Evolution PIM and Email Client
+.SH SYNOPSIS
+.sp
+\fBevolution\fR [ \fB-c|--component \fIcomponent\fB\fR ] [ \fB-g|--geometry \fIgeometry\fB\fR ] [
\fB--offline\fR ] [ \fB--online\fR ] [ \fB--force-online\fR ] [ \fB--disable-eplugin\fR ] [
\fB--disable-preview\fR ] [ \fB-i|--import \fIfilenames\fB\fR ] [ \fB-q|--quit\fR ]
+.SH "DESCRIPTION"
+.PP
+\fBEvolution\fR is the GNOME mailer, calendar, contact manager and
+communications tool. The components which make up Evolution
+are tightly integrated with one another and act as a seamless
+personal information-management (PIM) tool.
+.SH "OPTIONS"
+.PP
+This program follows the usual GNU command line syntax,
+with long options starting with two dashes (`-'). A summary of
+options is included below.
+.TP
+\fB-c|--component \fIcomponent\fB\fR
+Start Evolution showing the specified \fIcomponent\fR. Available options
+are “mail”, “calendar”, “contacts”, “tasks” and “memos”.
+.TP
+\fB-g|--geometry \fIgeometry\fB\fR
+Apply the given \fIgeometry\fR to the main window.
+.TP
+\fB--offline\fR
+Start in offline mode.
+.TP
+\fB--online\fR
+Start in online mode.
+.TP
+\fB--force-online\fR
+Ignore network availability.
+.TP
+\fB--disable-eplugin\fR
+Disable loading of any plugins.
+.TP
+\fB--disable-preview\fR
+Disable preview pane of Mail, Contacts and Tasks.
+.TP
+\fB-i|--import \fIfilenames\fB\fR
+Import URIs or filenames given as rest of arguments.
+.TP
+\fB-q|--quit\fR
+Request a running Evolution process to quit.
+.SH "AUTHOR"
+The Evolution team, https://wiki.gnome.org/Apps/Evolution
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]