doc/remote-mcs.1

   1 .\"     Title: remote-mcs
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
   4 .\"      Date: 05/18/2008
   5 .\"    Manual: Re-Mote Testbed Framework
   6 .\"    Source: remote-mci 2.0.git
   7 .\"
   8 .TH "REMOTE\-MCS" "1" "05/18/2008" "remote\-mci 2\.0\.git" "Re\-Mote Testbed Framework"
   9 .\" disable hyphenation
  10 .nh
  11 .\" disable justification (adjust text to left margin only)
  12 .ad l
  13 .SH "NAME"
  14 remote-mcs - Re-Mote mote control server
  15 .SH "SYNOPSIS"
  16 remote\-mcs [options]
  17 .sp
  18 .SH "DESCRIPTION"
  19 The mote control server manages connections from mote control hosts and user clients and operates mainly as a "switch" by forwarding message from clients to host with motes controlled by the colient\. On startup the server cleans up the database by removing stale session, mote, and site data and starts listening for incoming connections from mote hosts and clients\.
  20 .sp
  21 The mote control server may be run both in the foreground and as a daemon\.
  22 .sp
  23 .SH "OPTIONS"
  24 The following options are only usable on the command line\.
  25 .PP
  26 \-\-config=<path>
  27 .RS 4
  28 Path to the configuration file\. Defaults to "/etc/remote\-mcs\.cfg"\.
  29 .RE
  30 .PP
  31 \-\-help
  32 .RS 4
  33 Print usage help and exit\.
  34 .RE
  35 .PP
  36 \-\-version
  37 .RS 4
  38 Print version info and exit\.
  39 .RE
  40 .SS "Configuration options"
  41 In addition, to the above options the mote control server accepts the following configuration options that can be specified either on the command line or in the configuration file\. An option set in the configuration file overrides any option set on the command line\.
  42 .sp
  43 On the command line use: \fI\-\-\fR <name> \fI=\fR <value>, e\.g\. \fI\-\-devicePath=/here\fR\. In the config file use: <name> \fI=\fR <value>, e\.g\. \fIdevicePath=/here\fR\. For boolean options the \fI=\fR and value may be left out to set the value to true\. See the example sections for more information\.
  44 .PP
  45 dbName <string>
  46 .RS 4
  47 Name of the infrastructure database\.
  48 .RE
  49 .PP
  50 dbHost <string>
  51 .RS 4
  52 Host name of the infrastructure database server\.
  53 .RE
  54 .PP
  55 dbUser <string>
  56 .RS 4
  57 User name for the infrastructure database\.
  58 .RE
  59 .PP
  60 dbPassword <string>
  61 .RS 4
  62 Password for the infrastructure database\.
  63 .RE
  64 .PP
  65 sessionPort <number>
  66 .RS 4
  67 Port number to use when listening for new sessions\. The default port is 10000\.
  68 .RE
  69 .PP
  70 hostPort <number>
  71 .RS 4
  72 Port number to use when listening for new mote hosts\. Defaults to port 10001\.
  73 .RE
  74 .PP
  75 pidFile <string>
  76 .RS 4
  77 Path to the file containing the PID of the mote host\. Defaults to "/var/run/remote\-mcs\.pid"\.
  78 .RE
  79 .PP
  80 logFile <string>
  81 .RS 4
  82 Path to the output log file when running as a daemon\. MCS will log to "/var/log/remote\-mcs\.log" by default\.
  83 .RE
  84 .PP
  85 errorFile <string>
  86 .RS 4
  87 Path to the error log file when running as a daemon\. Errors will be logged to "/var/log/remote\-mcs\-error\.log" by default\.
  88 .RE
  89 .PP
  90 daemonize <boolean>
  91 .RS 4
  92 Whether or not to run in the background as a daemon\. Defaults to false\.
  93 .RE
  94 .SH "FILES"
  95 The mote control server uses the following configurable files\.
  96 .PP
  97 /etc/remote\-mcs\.cfg
  98 .RS 4
  99 Default configuration file read on startup\.
 100 .RE
 101 .PP
 102 /var/run/remote\-mcs\.pid
 103 .RS 4
 104 Default PID file path\.
 105 .RE
 106 .SH "ENVIRONMENT VARIABLES"
 107 The mote control server does not use any environment variables\.
 108 .sp
 109 .SH "EXAMPLES"
 110 .PP
 111 Using configuration options on the command line
 112 .RS 4
 113 If you only need to override the default values for the database access and don\'t want to use a configuration file, specify all option on the command line\.
 114 .sp
 115 .RS 4
 116 .nf
 117 $ remote\-mcs \-\-dbName=REMOTE \-\-dbUser=remote_admin \-\-dbPassword=123
 118 .fi
 119 .RE
 120 .RE
 121 .PP
 122 A simple configuration file
 123 .RS 4
 124 The following configuration file sets the same values as the above example and also tells the mote control server to run as a daemon\.
 125 .sp
 126 .RS 4
 127 .nf
 128 # Database credentials
 129 dbName=REMOTE
 130 dbUser=remote_admin
 131 dbPassword=123
 132 # Run in the background
 133 daemonize
 134 .fi
 135 .RE
 136 .RE
 137 .SH "COPYRIGHT"
 138 .sp
 139 .RS 4
 140 .nf
 141 Copyright (c) 2005\-2006 Esben Zeuthen <zept@diku\.dk>
 142 Copyright (c) 2006\-2008 Jonas Fonseca <fonseca@diku\.dk>
 143 Copyright (c) 2007\-2008 Rosta Spinarr <rostislav\.spinar@cit\.ie>
 144 .fi
 145 .RE
 146 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 2 of the License, or (at your option) any later version\.
 147 .sp
 148 .SH "SEE ALSO"
 149 \fBremote\-mch(1)\fR
 150 .sp
 151 This program is part of the Re\-Mote Testbed Framework <http://remote\-testbed\.googlecode\.com/>\.
 152 .sp