From: Tobias Ulmer <tu@emlix.com>
Date: Thu, 14 Feb 2013 18:44:17 +0000 (+0100)
Subject: Add e2-help man page
X-Git-Tag: e2factory-2.3.13rc1~15
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=7ec8ac3271e512cc078adf49bbcb4e5ebc638048;p=e2factory.git

Add e2-help man page

Signed-off-by: Tobias Ulmer <tu@emlix.com>
---

diff --git a/doc/man/e2-help.1.in b/doc/man/e2-help.1.in
new file mode 100644
index 0000000..ce1dc2d
--- /dev/null
+++ b/doc/man/e2-help.1.in
@@ -0,0 +1,31 @@
+.\" (c)2013 emlix GmbH
+.TH e2-help 1 "Feb 13, 2013" "@VERSION@"
+
+.SH NAME
+e2-help \- display documentation for e2factory commands and configuration.
+
+.SH SYNOPSIS
+e2-help <document>
+
+.SH DESCRIPTION
+\fBe2-help\fR opens man pages and other documentation specific to the
+e2factory version used in a project.
+.br
+With no arguments, e2-help lists all available documents.
+To view a specific document, supply its name as an argument.
+
+.SH RETURN VALUE
+Normally, exit status is 0. On error, it is non-zero.
+
+.SH OPTIONS
+.TP
+For options, see global options in \fBe2factory\fR(1).
+
+.SH EXAMPLES
+\fBe2-help e2factory\fR displays the e2factory overview page.
+
+.SH SEE ALSO
+.BR e2factory (1)
+
+.SH COPYRIGHT
+(c)2013 emlix GmbH