gcsd(8) ======= NAME ---- gcsd - generic command sequencer daemon SYNOPSIS -------- .... gcsd [ -h|--help ] [ -D|--nodaemonize ] [ -u|--username ] [ -g|--groupname ] [ -C|--chroot ] [ -P|--write-pid ] [ -L|--log :[,[,[..]]] ] [ -U|--debug ] [ -l|--lua-code ] [ -o|--output :[=[,=[..]]] ] [ -i|--input :[=[,=[..]]] ] .... 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 *:: 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 *:: run as this group. If no username is specified (*-u*) this gets ignored. The default is to not drop privileges. *-C, --chroot *:: Instruct *gcsd* to run in a chroot jail. The default is to not run in chroot. *-P, --write-pid *:: Instruct *gcsd* to write it's pid to this file. The default is to not create a pid file. *-L, --log :[,[,[..]]]*:: 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 has 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 than 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 [,[,]] *file*;; log to file, parameters [,] *stdout*;; log to standard output, parameters *stderr*;; log to standard error, parameters *-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 *:: 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 :[=[,=[..]]]*:: 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 :[=[,=[..]]]*:: 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 , Christian Pointner 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.