1srcpd(8)                    System Manager's Manual                   srcpd(8)
2
3
4

NAME

6       srcpd - SRCP speaking daemon
7
8

SYNOPSIS

10       srcpd [ options ]
11
12

DESCRIPTION

14       This  is  not  a  complete manual. You have to consult the project home
15       page at http://srcpd.sourceforge.net/ for full documentation!
16
17       srcpd is a UNIX daemon speaking the Simple  Railroad  Command  Protocol
18       (SRCP).
19
20       Upon  start  up  it  reads  in the system wide configuration file named
21       srcpd.conf. Contents and structure of this  XML-file  is  explained  in
22       detail  in  the srcpd.conf (5) man page. The SRCP specification is pub‐
23       lished on http://srcpd.sourceforge.net/srcp.
24
25

OPTIONS

27       -h     Prints some useful help about command line options and exit
28
29       -n     Do not daemonize upon start-up. The srcpd does not  switch  into
30              background mode. This option can be used with the Ubuntu upstart
31              system.
32
33       -v     Print program version, SRCP level and exit
34
35       -f <filename>
36              Use the  specified  filename  as  the  configuration  file.  The
37              default  value  will  be defined at compile time and can be dis‐
38              played using the -h parameter.
39
40

NOTES

42   Getting started
43       The srcpd system service (daemon) is compliant to the Filesystem  Hier‐
44       archy  Standard  (FHS, http://www.pathname.com/fhs/). For more informa‐
45       tion and special options about daemon usage please  refer  to  to  your
46       system documentation. The following instructions are on a general level
47       of information.
48
49

NOTES

51       Please first start assembling a configuration file (srcpd.conf) fitting
52       exactly  your  needs to connect to your model railway controller inter‐
53       face. Save this file to the directory for host specific system configu‐
54       ration (/etc). The default configuration file delivered with this soft‐
55       ware must be replaced by the new one.
56
57       As soon as the adapted configuration file is at the  right  place,  the
58       daemon can be started using this command:
59
60              /etc/init.d/srcpd start
61
62       If  the  srcpd  is already running, the daemon first must be stopped to
63       get it aware of the new setup. Stopping the daemon is executed in anal‐
64       ogy to the start command:
65
66              /etc/init.d/srcpd stop
67
68       Under  certain conditions it is also possible to get the daemon re-read
69       its configuration file without stopping it. With  respect  to  hardware
70       access  rules under UNIXlike systems, the group and/or user rights must
71       be properly set in srcpd.conf to let the daemon access the  appropriate
72       hardware resources at any time.
73
74       Common  model  railway interfaces will require access rights for serial
75       lines (RS232, USB), which can be achieved using the proper group rights
76       (e.g. dialout). The ddl-s88 module uses a special system function (iop‐
77       erm) which always needs root rights to perform successfully.  The  iop‐
78       erm()  function is typically only available on x86 and x86-64 hardware.
79       So if you are using other hardware  and  get  an  error  about  missing
80       sys/io.h  while  compiling  srcpd source code, just disable the ddl-s88
81       module. Refer to ./configure --help for more details about how to  dis‐
82       able special srcpd modules.
83
84       To  let  srcpd  re-read  its configuration file, assumed the setup men‐
85       tioned before is correct, the following command can be used:
86
87              /etc/init.d/srcpd reload
88
89       The log file /var/log/messages or /var/log/syslog of the syslog  daemon
90       can  be used to monitor occurring errors on daemon start or during cur‐
91       rent operation.  With root rights the upcoming messages can be continu‐
92       ously watched in a separate terminal:
93
94              tail -f /var/log/messages
95
96       or
97
98              tail -f /var/log/syslog
99
100       The verbosity of these messages can be adjusted using the configuration
101       file srcpd.conf. For more information refer to the adequate man page.
102
103

SEE ALSO

105       srcpd.conf (5)
106
107

BUGS

109       Possibly there are some bugs. Please report them to the project  devel‐
110       oper mailing list.
111
112

AUTHORS

114       This  man  page  was  written  by  Matthias Trute (mtrute@users.source‐
115       forge.net),  Frank  Schimschke  (schmischi@users.sourceforge.net)   and
116       Guido Scholz (gscholz@users.sourceforge.net).
117
118

LICENSE

120       GNU General Public License, Version 2
121
122
123
124                               December 19, 2009                      srcpd(8)
Impressum