summaryrefslogtreecommitdiff
path: root/README
blob: 5bce34ad9165034188a705f5908d9e4e027aab4f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
Introduction
============

gcsd the generic command sequencer daemon can be used to serialize
commands sent over various paralell communication channels to a
single command output. It can be seen as a multiplexer for any
kind of communication between a single resource and various clients
which want to submit commands to it or query information from it.
gcsd is written in C and Lua. The goal is to provide an easy to
understand high level API based on Lua which can be used to
implement the business logic of the so formed multiplexer daemon.


Dependencies
============

Linux
-----

core:
 build-essential
 lua5.1
 liblua5.1-0-dev

if you want clang as compiler
 clang

if you want to rebuild the manpage:
 asciidoc

modules:
 <no additional deps yet>


FreeBSD
-------

core:
 devel/gmake
 lang/lua

modules:
 <no additional deps yet>


Windows
-------

core:
  MinGW and MSYS (details follow)
  lua-5.1.x


Installation
============

Getting the source via GIT:
---------------------------

git clone git://git.spreadspace.org/gcsd.git
cd gcsd


Building from source
--------------------

# cd src
# ./configure
# make

Notes:
  - try './configure --help' for further information
  - on FreeBSD you have to use gmake instead of make


Building on Windows
-------------------

gcsd can be built on Windows using MinGW and MSYS..

tba ...


Installing
----------

# sudo make install

This will install gcsd under the --prefix defined with configure.


Uninstalling
------------

# sudo make remove

This removes everything except for the config files

# sudo make purge

This also removes the config files


Usage:
======

tba..