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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
gcsd(8)
=======
NAME
----
gcsd - generic command sequencer daemon
SYNOPSIS
--------
....
gcsd
[ -h|--help ]
[ -D|--nodaemonize ]
[ -u|--username <username> ]
[ -g|--groupname <groupname> ]
[ -C|--chroot <path> ]
[ -P|--write-pid <filename> ]
[ -L|--log <target>:<level>[,<param1>[,<param2>[..]]] ]
[ -U|--debug ]
[ -l|--lua-code <lua-file> ]
[ -o|--output <module>:[<param1>=<value>[,<param2>=<value>[..]]] ]
[ -i|--input <module>:[<param1>=<value>[,<param2>=<value>[..]]] ]
....
DESCRIPTION
-----------
*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.
OPTIONS
-------
The following options can be passed to the *gcsd* daemon:
*-D, --nodaemonize*::
This option instructs *gcsd* to run in foreground
instead of becoming a daemon which is the default.
*-u, --username <username>*::
run as this user. If no group is specified (*-g*) the default group of
the user is used. The default is to not drop privileges.
*-g, --groupname <groupname>*::
run as this group. If no username is specified (*-u*) this gets ignored.
The default is to not drop privileges.
*-C, --chroot <path>*::
Instruct *gcsd* to run in a chroot jail. The default is
to not run in chroot.
*-P, --write-pid <filename>*::
Instruct *gcsd* to write it's pid to this file. The default is
to not create a pid file.
*-L, --log <target>:<level>[,<param1>[,<param2>[..]]]*::
add log target to logging system. This can be invoked several times
in order to log to different targets at the same time. Every target
hast its own log level which is a number between 0 and 5. Where 0 means
disabling log and 5 means debug messages are enabled. +
The file target can be used more the once with different levels.
If no target is provided at the command line a single target with the
config *syslog:3,gcsd,daemon* is added. +
The following targets are supported:
*syslog*;; log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
*file*;; log to file, parameters <level>[,<path>]
*stdout*;; log to standard output, parameters <level>
*stderr*;; log to standard error, parameters <level>
*-U, --debug*::
This option instructs *gcsd* to run in debug mode. It implicits *-D*
(don't daemonize) and adds a log target with the configuration
*stdout:5* (logging with maximum level). In future releases there might
be additional output when this option is supplied.
*-l, --lua-code <lua-file>*::
Load the dispatch table and callback functions from this file. If no file is
specified *gcsd* will run in basic mode and just sends any command submitted
by a client to the output und broadcasts any response to all connected clients.
*-o, --output <module>:[<param1>=<value>[,<param2>=<value>[..]]]*::
set and configure the command output module. See Modules section for further
information on which modules exist and how they can be configured. By default
the output module is set to *serial:device=/dev/ttyS0,baudrate=9600,data=8,stop=1,parity=no*
*-i, --input <module>:[<param1>=<value>[,<param2>=<value>[..]]]*::
set and configure command input modules. This can be invoked several times.
gcsd will use all input modules in paralell. See Modules section for further
information on which modules exist and how they can be configured. By default
a single input module with the config *unix:file=/var/run/gcsd.sock,mode=660*
is used.
Modules
-------
tba
EXAMPLES
--------
nothing yet..
BUGS
----
Most likely there are some bugs in *gcsd*. If you find a bug, please let
the developers know at gcsd@spreadspace.org. Of course, patches are preferred.
SEE ALSO
--------
nothing yet..
AUTHORS
-------
Markus Grueneis <gimpf@spreadspace.org>,
Christian Pointner <equinox@spreadspace.org>
RESOURCES
---------
Main web site: http://www.spreadspace.org/gcsd/
COPYING
-------
Copyright \(C) 2010 Markus Grueneis and Christian Pointner. This program is free
software: you can redistribute it and/or modify it under the terms
of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or any later version.
|
