srcpd(8)

πŸ“¦
version 2.1.7 Β· 2 versions
  • 2.1.7 Β· debian trixie, epel 10, epel 9, fedora 43, fedora 44, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 2.1.6 Β· ubuntu noble
, in debian trixie, epel 10, epel 9, fedora 43, fedora 44, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ‘‘ srcpd β€” the manual page, bestie edition πŸ‘‘

okay so you're holding the srcpd(8) page from the System Manager's Manual, and I'm gonna walk you through it like we're texting at 2am. it's giving "SRCP speaking daemon" and honestly? she's iconic for it. let's go πŸ’…


✨ NAME ✨

srcpd β€” the SRCP speaking daemon. that's the whole name section. short, sweet, main character energy. πŸŽ€


🌸 SYNOPSIS 🌸

srcpd [ options ]

yeah that's it. that's the whole vibe. options go in, daemon comes out. πŸ’–


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so first things first, and I need you to hear me on this one: this is not a complete manual. like, at all. if you want the full documentation you have to go consult the project home page at http://srcpd.sourceforge.net/. periodt. πŸ’€

so what is srcpd? she's a UNIX daemon speaking the Simple Railroad Command Protocol (SRCP). railroad girlies rise up πŸš‚βœ¨

upon start up she reads in the system wide configuration file named srcpd.conf. the contents and structure of this XML-file are explained in detail in the srcpd.conf (5) man page β€” yes bestie, there's a whole other man page, go read it. and the SRCP specification itself is published on http://srcpd.sourceforge.net/srcp. 🌈


πŸ’– OPTIONS πŸ’–

  • -h β€” prints some useful help about command line options and then dips. genuinely useful, no cap.
  • -n β€” do not daemonize upon start-up. srcpd does not switch into background mode. this one can be used with the Ubuntu upstart system. 🫢
  • -v β€” print program version, SRCP level, and exit. quick little vibe check on what you're running. ⭐
  • -f <filename> β€” use the specified filename as the configuration file. the default value is defined at compile time and can be displayed using the -h parameter. πŸ”₯

🧚 NOTES 🧚

🌱 Getting started 🌱

the srcpd 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 your system documentation. the following instructions are on a general level of information, so don't come for me if your distro does things differently πŸ™ˆ


πŸ’œ NOTES πŸ’œ

(part two, the practical one, this is where it gets real)

please first start assembling a configuration file (srcpd.conf) fitting exactly your needs to connect to your model railway controller interface. save this file to the directory for host specific system configuration (/etc). the default configuration file delivered with this software must be replaced by the new one. no shortcuts, bestie. πŸ’…

as soon as the adapted configuration file is at the right place, the daemon can be started using this command:

/etc/init.d/srcpd start

if the srcpd 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:

/etc/init.d/srcpd stop

under certain conditions it is also possible to get the daemon to 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 srcpd.conf 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. dialout). the ddl-s88 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 sys/io.h 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:

/etc/init.d/srcpd reload

the log file /var/log/messages or /var/log/syslog 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:

tail -f /var/log/messages

or

tail -f /var/log/syslog

the verbosity of these messages can be adjusted using the configuration file srcpd.conf. for more information refer to the adequate man page. πŸ‘‘


🌈 SEE ALSO 🌈

  • srcpd.conf (5)

πŸ’€ BUGS πŸ’€

possibly there are some bugs. please report them to the project developer mailing list. (not me personally, I'm just the messenger 🫢)


πŸ‘‘ AUTHORS πŸ‘‘

this man page was written by:

  • Matthias Trute (mtrute@users.sourceforge.net)
  • Frank Schmischke (schmischi@users.sourceforge.net)
  • Guido Scholz (gscholz@users.sourceforge.net)

absolute legends, every single one. 🌟


⭐ LICENSE ⭐

GNU General Public License, Version 2


and that's the whole page, bestie! this version of srcpd(8) is dated December 19, 2009 and lives in the System Manager's Manual section 8. go forth, start that daemon, and slay πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈ