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

74 lines
2.2 KiB
Groff
Raw Normal View History

2013-10-11 23:07:35 +00:00
.\"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
2013-10-14 12:08:06 +00:00
.RB [\-\-lib-dir|\-l
.IR path \|]
.RB [\-\-data-dir|\-l
.IR path \|]
.RB [\-\-query-dir|\-l
.IR path \|]
2013-10-11 23:07:35 +00:00
.br
.SH DESCRIPTION
.B hedera
2013-12-17 16:03:37 +00:00
is a database access aplication. It features modular conectivity to user-made
modules. The modules can be written in C or in Vala.
2013-10-11 23:07:35 +00:00
.PP
By default
.B hedera
2013-12-17 16:03:37 +00:00
will look for the modules at /usr/lib/x86_64-linux-gnu/hedera/module and for
its corresponding data (GUI files, configuration...) at /usr/share/hedera/module
and at /usr/share/hedera/module/{name-of-the-module}/sql for module specific SQL
query files, but more directories can be added by setting the environment
variables
2013-10-11 23:07:35 +00:00
.B VN_MODULE_LIB_PATH
2013-10-14 12:08:06 +00:00
(for the binaries),
2013-10-11 23:07:35 +00:00
.B VN_MODULE_DATA_PATH
2013-10-14 12:08:06 +00:00
(for the additional data) and
.B VN_MODULE_QUERY_PATH
2013-12-17 16:03:37 +00:00
(for SQL query files) that can also be set automatically passing the
2013-10-14 12:08:06 +00:00
corresponding options. These environment variables are intended for testing
2013-10-11 23:07:35 +00:00
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
2013-10-14 12:08:06 +00:00
.TP
2013-12-17 16:03:37 +00:00
.BI \-l\ path
2013-10-14 12:08:06 +00:00
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
2013-12-17 16:03:37 +00:00
.BI \-d\ path
2013-10-14 12:08:06 +00:00
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
2013-12-17 16:03:37 +00:00
.BI \-q\ path
2013-10-14 12:08:06 +00:00
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
2013-10-11 23:07:35 +00:00
.SH EXAMPLE
Given a module project in the home directory,
.B hedera
should be called like this to load the module without installing it:
2013-12-17 16:03:37 +00:00
hedera -l ~/module/src/.libs -d ~/module/data
2013-10-11 23:07:35 +00:00
.SH AUTHORS
2013-12-17 16:03:37 +00:00
Copyright (C) 2013 Juan Ferrer Toribio <juan@verdnauta.es>.
Copyright (C) 2013 Alejandro T. Colombini <atcolombini@verdnauta.es>.
2013-10-11 23:07:35 +00:00
.PP
2013-10-14 12:08:06 +00:00
Manual page written by Alejandro T. Colombini.