From: Tobias Ulmer <tu@emlix.com>
Date: Thu, 14 Feb 2013 18:37:35 +0000 (+0100)
Subject: Add manpage for e2
X-Git-Tag: e2factory-2.3.13rc1~18
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=3f2f60dbd311839687fc05cf070758ab8c15ebe7;p=e2factory.git

Add manpage for e2

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

diff --git a/doc/man/e2.1.in b/doc/man/e2.1.in
new file mode 100644
index 0000000..b7ac394
--- /dev/null
+++ b/doc/man/e2.1.in
@@ -0,0 +1,36 @@
+.\" (c)2013 emlix GmbH
+.\"
+.TH e2 1 "Feb 14, 2013" "@VERSION@"
+
+.SH NAME
+e2 \- the emlix embedded build system
+
+.SH SYNOPSIS
+e2 <tool> ...
+
+.SH DESCRIPTION
+\fBe2\fR is the entry point to the local and global e2factory tools.
+.PP
+e2 ensures that the correct version of the specified tool is called,
+according to the project configuration. As a convenience, symbolic links
+in the form "e2\-tool" which point to e2 are interpreted as "e2 tool".
+.PP
+The e2 tool provides little user\-visible functionality.
+For a general overview of e2factory and the available tools,
+see \fBe2factory\fR(1).
+
+.SH RETURN VALUE
+Normally, exit status is 0. On error, it is non-zero.
+
+.SH OPTIONS
+.TP
+.BR \-\-prefix
+Print installation prefix.
+.TP
+For further global options and environment variables, see \fBe2factory\fR(1).
+
+.SH SEE ALSO
+.BR e2factory (1)
+
+.SH COPYRIGHT
+(c)2013 emlix GmbH