Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CATSITD(8)		    System Manager's Manual		    CATSITD(8)

NAME
       catsitd -- process supervisor

SYNOPSIS
       catsitd [-d] [-C	path] [-c control] [-f config] [-g group] [-p pidfile]
	       [-r reset] [-s stopexits] [-t restart] [-u user]

DESCRIPTION
       The catsitd daemon is a process supervisor for FreeBSD and OpenBSD.  It
       is designed to supervise	processes with the following behavior:

       1.   The	process	runs in	the foreground,	not as a daemon.

       2.   The	process	logs to	standard output	or standard error.

       3.   The	process	handles	errors by exiting and expects to be restarted.

       4.   The	process	indicates its reason for exiting with sysexits(3).

       The  catsitd  daemon spawns processes for a list	of services, redirects
       their output to syslog, and restarts the	processes when they  exit  ac-
       cording	to their exit status.  Exponential backoff is applied to auto-
       matic restarts.

       The list	of services is defined in a catsit.conf(5) file.  The services
       managed by catsitd  can	be  controlled	through	 a  named  pipe.   The
       catsit(8)  utility  is a	wrapper	for writing to the named pipe, and its
       manual page describes the control command syntax.

       The arguments are as follows:

       -C path
	       Change directory	to path	before starting	services.  By  default
	       the working directory is	/.

       -c control
	       Set the path of the named pipe used for service control.

       -d      Do  not run as a	daemon.	 Log to	standard error as well as sys-
	       log.

       -f config
	       Set the path of the catsit.conf(5) file.

       -g group
	       Change group to group before starting services.	If -u is  set,
	       the default group is the	user's group.

       -p pidfile
	       Write the PID of	the catsitd process to pidfile.

       -r reset
	       Set  the	interval in milliseconds for which a process must live
	       to have its service  restart  interval  reset  to  the  initial
	       value.  The default interval is 15 minutes.

       -s stopexits
	       Set  the	 list of exit statuses for which a restart will	not be
	       attempted.  The stopexits argument is a comma-separated list of
	       integers.  The default list contains the	 values	 of  EX_USAGE,
	       EX_DATAERR,  EX_NOINPUT,	 EX_OSFILE and EX_CANTCREAT defined in
	       sysexits(3).  The exit statuses 126 and 127 are always  treated
	       as stop exits.

       -t restart
	       Set  the	 initial  interval  in	milliseconds between automatic
	       restarts.  This interval	is doubled each	time a service is  au-
	       tomatically restarted.  The default interval is 1 second.

       -u user
	       Change  user  to	user before starting services.	Services which
	       are  privileged	are  started  without  changing	  user.	   The
	       catsit.conf(5) manual page describes privileged services.

       The catsitd daemon takes	the following actions in response to signals:

       HUP     The catsit.conf(5) file is reloaded.  Services are not automat-
	       ically  started,	stopped	or restarted.  Removed services	can be
	       dropped with catsit(8).

       TERM    The named pipe used for service control is closed and unlinked.
	       All services are	stopped, after which catsitd exits.

       INFO    The current status of all services is logged.

ENVIRONMENT
       Services	are started with empty environments apart from the following:

       USER    Set to the name of the user specified by	-u.

       HOME    Set to the home directory of the	user specified by -u.

       SHELL   Set to /bin/sh.

       PATH    Set  to	the  system  default  defined  by   _PATH_DEFPATH   in
	       <paths.h>.

FILES
       /usr/local/etc/catsit.conf
	       The default path	of the catsit.conf(5) file on FreeBSD.

       /etc/catsit.conf
	       The default path	of the catsit.conf(5) file on OpenBSD.

       /var/run/catsitd.pipe
	       The default path	of the named pipe used for service control.

SEE ALSO
       catsit.conf(5), catsit(8)

AUTHORS
       June Bug	<june@causal.agency>

FreeBSD	ports 15.0		August 16, 2020			    CATSITD(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=catsitd&sektion=8&manpath=FreeBSD+Ports+15.0>

home | help