diff options
author | Michal Hruby <michal.mhr@gmail.com> | 2010-08-06 13:55:03 +0200 |
---|---|---|
committer | Michal Hruby <michal.mhr@gmail.com> | 2010-08-06 13:55:03 +0200 |
commit | c39e761220340738d7cd46a958fd1e212fd80841 (patch) | |
tree | 9f654ad4a0a30ea3825a92cfa17ec0c52054bdc8 | |
parent | 942f4edc89ca45db98a7f2f6093d6705c78eef31 (diff) |
Added man page
-rw-r--r-- | Makefile.am | 4 | ||||
-rw-r--r-- | configure.ac | 1 | ||||
-rw-r--r-- | doc/Makefile.am | 1 | ||||
-rw-r--r-- | doc/zeitgeist-datahub.1 | 50 |
4 files changed, 55 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am index f7d4c0b..d81abee 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,5 +1,7 @@ SUBDIRS = \ - src + src \ + doc \ + $(NULL) #ACLOCAL_AMFLAGS = -I m4 diff --git a/configure.ac b/configure.ac index 28548be..7e8dc1c 100644 --- a/configure.ac +++ b/configure.ac @@ -51,6 +51,7 @@ AC_DEFINE_UNQUOTED(PKGDATADIR, "$PKGDATADIR", [Package base directory]) AC_CONFIG_FILES([ Makefile src/Makefile +doc/Makefile ]) AC_OUTPUT diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..467c830 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1 @@ +man_MANS = zeitgeist-datahub.1 diff --git a/doc/zeitgeist-datahub.1 b/doc/zeitgeist-datahub.1 new file mode 100644 index 0000000..b4c3f35 --- /dev/null +++ b/doc/zeitgeist-datahub.1 @@ -0,0 +1,50 @@ +.TH ZEITGEIST\-DATAHUB 1 "May 20, 2009" "Zeitgeist" + +.SH NAME +zeitgeist\-datahub \- passive loggers for Zeitgeist + +.SH SYNOPSIS +\fBzeitgeist\-datahub\fP \fI[OPTION]\fP + +.SH DESCRIPTION +\fBzeitgeist\-datahub\fP is a daemon which centralizes all passive +data sources into a single process, and interfaces between said data +sources (also known as \fIloggers\fP) and \fBzeitgeist-daemon\fP (with +which it communicates via D-Bus). +.PP +\fBPassive\fP data sources are those which run in the background and +look for activities independently to the programs they monitor, whereas +Zeitgeist can also work with \fBactive\fP data sources which are those +in-build into other applications (either natively or through +extensions). + +.SH OPTIONS +The program follows the usual GNU command line syntax, with +options starting with two dashes (`--'). A summary of options is +included below. +.TP +.B Currently there are no options available. + +.SH SEE ALSO +\fBzeitgeist-daemon\fR + +.SH BUGS +Please report any bugs on https://bugs.launchpad.net/zeitgeist-datahub. + +.SH AUTHORS +Please see the AUTHORS file bundled with this application for +a complete list of contributors. + +.SH LICENSE +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Lesser General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.PP +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Lesser General Public License for more details. +.PP +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. |