This repository has been archived on 2024-07-15. You can view files and clone it, but cannot push or open issues or pull requests.
hedera/main/hedera.1

76 lines
2.2 KiB
Groff

.\"Created with GNOME Manpages Editor Wizard
.\"http://sourceforge.net/projects/gmanedit2
.TH hedera 1 "2013-01-02" "1.0" "Hedera"
.SH NAME
hedera \- modular management system
.SH SYNOPSIS
.B hedera
.RB [\-\-lib-dir|\-l
.IR path \|]
.RB [\-\-data-dir|\-l
.IR path \|]
.RB [\-\-query-dir|\-l
.IR path \|]
.br
.SH DESCRIPTION
.B hedera
is an enterprise management and administration application. It features modular
conectivity to user-made modules.
.PP
Being so easily extensible,
.B hedera
can handle virtually any task related to a database if the right module is
available. The modules can be written in C or in Vala.
.PP
By default
.B hedera
will look for the modules in /usr/lib/hedera/module and for its corresponding
data (GUI files, configuration...) in /usr/share/hedera/module but more
directories can be added by setting
.B VN_MODULE_LIB_PATH
(for the binaries),
.B VN_MODULE_DATA_PATH
(for the additional data) and
.B VN_MODULE_QUERY_PATH
(for SQL query files) that can also be set automatically passing the
corresponding options. These environment variables are intended for testing
during the developement and the expected is to use the modules installed.
.PP
The format for the configuration files for the modules and some information on
how to write the modules themselves, can be seen in the official documentation
for
.B hedera.
.SH OPTIONS
.TP
.BI \-l\ path ,\ \-\-lib-dir\ path
Sets the value of the
.B VN_MODULE_LIB_PATH
variable. This option can be used mutiple times to specify more than one search
path for the module libraries.
.TP
.BI \-d\ path ,\ \-\-data-dir\ path
Sets the value of the
.B VN_MODULE_DATA_PATH
variable. This option can be used mutiple times to specify more than one search
path for the module data files.
.TP
.BI \-q\ path ,\ \-\-query-dir\ path
Sets the value of the
.B VN_MODULE_QUERY_PATH
variable. This option can be used mutiple times to specify more than one search
path for the module query files.
.br
.SH EXAMPLE
Given a module project in the home directory,
.B hedera
should be called like this to load the module without installing it:
hedera --lib-dir ~/module/src/.libs --data-dir ~/module/data
.SH AUTHORS
Copyright (C) 2012 Juan Ferrer Toribio <juan@verdnauta.es>.
.PP
Manual page written by Alejandro T. Colombini.