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
149
150
151
152
153
154
155
156
157
158
159
160
|
'\" t
.\"
.\" Manual page for srcpd
.\" Process with:
.\" groff -man -Tlatin1 srcpd.8 | less
.\" or
.\" groff -man -Tutf8 srcpd.8 | less
.\"
.\" Get a printable version with:
.\" groff -mandoc -Tps srcpd.8 > srcpd.ps
.\"
.\"
.TH srcpd 8 "December 19, 2009"
.\"
.\"
.SH NAME
srcpd \- SRCP speaking daemon
.\"
.SH SYNOPSIS
.B srcpd
[ options ]
.\"
.SH DESCRIPTION
This is not a complete manual. You have to consult the project
home page at http://srcpd.sourceforge.net/ for full documentation!
.B srcpd
is a UNIX daemon speaking the Simple Railroad Command Protocol
(SRCP).
Upon start up it reads in the system wide configuration file named
\fBsrcpd.conf\fP. Contents and structure of this XML-file is explained
in detail in the \fBsrcpd.conf (5)\fP man page. The SRCP specification
is published on http://srcpd.sourceforge.net/srcp.
.\"
.SH OPTIONS
.TP
.BI \-h
Prints some useful help about command line options and exit
.TP
.BI \-n
Do not daemonize upon start-up. The srcpd does not switch into
background mode. This option can be used with the Ubuntu upstart
system.
.TP
.BI \-v
Print program version, SRCP level and exit
.TP
.BI \-f\ <filename>
Use the specified filename as the configuration file. The default
value will be defined at compile time and can be displayed using the
\fB-h\fP parameter.
.\"
.SH NOTES
.SS Getting started
The \fBsrcpd\fP system service (daemon) is compliant to the Filesystem
Hierarchy Standard (FHS, http://www.pathname.com/fhs/). For more
information and special options about daemon usage please refer to to
your system documentation. The following instructions are on a general
level of information.
.\"
.SH "NOTES"
Please first start assembling a configuration file (\fIsrcpd.conf\fP)
fitting exactly your needs to connect to your model railway controller
interface. Save this file to the directory for host specific system
configuration (\fI/etc\fP). The default configuration file delivered
with this software must be replaced by the new one.
As soon as the adapted configuration file is at the right place, the
daemon can be started using this command:
.RS
.nf
/etc/init.d/srcpd start
.fi
.RE
If the \fBsrcpd\fP is already running, the daemon first must be stopped
to get it aware of the new setup. Stopping the daemon is executed in
analogy to the start command:
.RS
.nf
/etc/init.d/srcpd stop
.fi
.RE
Under certain conditions it is also possible to get the daemon re-read
its configuration file without stopping it. With respect to hardware
access rules under UNIXlike systems, the group and/or user rights must
be properly set in \fIsrcpd.conf\fP to let the daemon access the
appropriate hardware resources at any time.
Common model railway interfaces will require access rights for serial
lines (RS232, USB), which can be achieved using the proper group rights
(e.g. \fBdialout\fR). The \fBddl-s88\fR module uses a special system
function (ioperm) which always needs root rights to perform
successfully. The ioperm() function is typically only available on x86
and x86-64 hardware. So if you are using other hardware and get an error about
missing \fIsys/io.h\fP while compiling srcpd source code, just disable the
ddl-s88 module. Refer to ./configure --help for more details about how
to disable special srcpd modules.
To let srcpd re-read its configuration file, assumed the setup
mentioned before is correct, the following command can be used:
.RS
.nf
/etc/init.d/srcpd reload
.fi
.RE
The log file \fI/var/log/messages\fP or \fI/var/log/syslog\fP of the
syslog daemon can be used to monitor occurring errors on daemon start
or during current operation. With root rights the upcoming messages
can be continuously watched in a separate terminal:
.RS
.nf
tail -f /var/log/messages
.fi
.RE
or
.RS
.nf
tail -f /var/log/syslog
.fi
.RE
The verbosity of these messages can be adjusted using the configuration
file \fIsrcpd.conf\fP. For more information refer to the adequate man
page.
.\"
.SH "SEE ALSO"
srcpd.conf (5)
.\"
.SH BUGS
Possibly there are some bugs. Please report them to the project
developer mailing list.
.\"
.SH AUTHORS
This man page was written by
Matthias Trute (mtrute@users.sourceforge.net),
Frank Schmischke (schmischi@users.sourceforge.net) and
Guido Scholz (gscholz@users.sourceforge.net).
.\"
.SH LICENSE
GNU General Public License, Version 2
|
