diff options
Diffstat (limited to 'doc/gcsd.8.txt')
-rw-r--r-- | doc/gcsd.8.txt | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/gcsd.8.txt b/doc/gcsd.8.txt index e752dfe..523a2a9 100644 --- a/doc/gcsd.8.txt +++ b/doc/gcsd.8.txt @@ -30,12 +30,12 @@ gcsd DESCRIPTION ----------- -*gcsd* the generic command sequencer daemon can be used to serialize +*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 +*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. @@ -50,7 +50,7 @@ The following options can be passed to the *gcsd* daemon: 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 + 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>*:: @@ -58,20 +58,20 @@ The following options can be passed to the *gcsd* daemon: The default is to not drop privileges. *-C, --chroot <path>*:: - Instruct *gcsd* to run in a chroot jail. The default is + 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 + 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 + 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 + 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: @@ -81,13 +81,13 @@ The following options can be passed to the *gcsd* daemon: *stderr*;; log to standard error, parameters <level> *-U, --debug*:: - This option instructs *gcsd* to run in debug mode. It implicits *-D* + 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 + 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. @@ -100,7 +100,7 @@ The following options can be passed to the *gcsd* daemon: 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* + a single input module with the config *unix:file=/var/run/gcsd.sock,mode=660* is used. @@ -142,7 +142,7 @@ 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 +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. |