Difference between revisions of "Initscripts/Writing rc.d scripts"

From ArchWiki
Jump to: navigation, search
m
(28 intermediate revisions by 11 users not shown)
Line 1: Line 1:
==Naming scheme==
+
[[Category:Boot process]]
The name of the rc.d script should follow the name of the executable, not the name of the package. It must reflect what it's going to do.
+
[[Category:Package development]]
 +
[[cs:Writing rc.d scripts]]
 +
[[es:Writing rc.d scripts]]
 +
[[zh-CN:Writing rc.d scripts]]
 +
{{Related articles start}}
 +
{{Related|Arch Boot Process}}
 +
{{Related|Daemon}}
 +
{{Related|rc.conf}}
 +
{{Related articles end}}
 +
{{Warning|Arch only supports [[systemd]]. Arch's old initscripts package is obsolete and is no longer supported. All Arch users need to move to systemd.}}
  
==Requirements==
+
[[Initscripts]] uses rc.d scripts to used to control the starting, stopping and restarting of [[Daemon|daemons]].
* If a daemon accepts arguments, the script must have its equivalent in /etc/conf.d.
+
* The rc.d script must have at least three methods, being start, stop and restart.
+
  
==Example==
+
== Guideline ==
A proper example for tftpd:
+
* Source {{ic|/etc/rc.conf}}, {{ic|/etc/rc.d/functions}}, and optionally {{ic|/etc/conf.d/DAEMON_NAME}}.
 +
* Arguments and other daemon options should be placed in {{ic|/etc/conf.d/DAEMON_NAME}}. This is done to separate configuration from logic and to keep a consistent style among daemon scripts.
 +
* Use functions in {{ic|/etc/rc.d/functions}} instead of duplicating their functionality.
 +
* Include at least start, stop and restart as arguments to the script.
  
/etc/conf.d/tftpd:
+
== Available functions ==
TFTPD_ARGS="-l -s /var/tftpboot -c"
+
* There are some functions provided by {{ic|/etc/rc.d/functions}}:
 +
** {{Ic|stat_busy "''message''"}}: set status ''busy'' for printed message (e.g. <nowiki>Starting daemon  [BUSY]</nowiki>)
 +
** {{Ic|stat_done}}: set status ''done'' (e.g. <nowiki>Starting daemon  [DONE]</nowiki>)
 +
** {{Ic|stat_fail}}: set status ''failed'' (e.g. <nowiki>Starting daemon  [FAILED]</nowiki>)
 +
** {{Ic|get_pid ''program''}}: get PID of the program
 +
** {{Ic|ck_pidfile ''PID-file'' ''program''}}: check whether PID-file is still valid for the program (e.g. <nowiki>ck_pidfile /var/run/daemon.pid daemon || rm -f /var/run/daemon.pid</nowiki>)
 +
** {{Ic|<nowiki>[add|rm]_daemon</nowiki> ''program''}}: add/remove program to running daemons (stored in {{ic|/run/daemons/}})
  
/etc/rc.d/tftpd
+
Full list of functions is much longer and most possibilities (like way to control whether or not non-root users can launch daemon) are still undocumented and can be learned only from {{ic|/etc/rc.d/functions}} source. See also {{Ic|man rc.d}}.
+
 
#!/bin/bash
+
== Example ==
. /etc/rc.conf
+
The following is an example for ''crond''. Look in {{ic|/etc/rc.d}} for greater variety.
. /etc/rc.d/functions
+
 
TFTPD_ARGS=
+
The configuration file:
[ -f /etc/conf.d/tftpd ] && . /etc/conf.d/tftpd
+
{{hc|/etc/conf.d/crond|2=<nowiki>ARGS="-S -l info"</nowiki>}}
PID=`pidof -o %PPID /usr/sbin/in.tftpd`
+
 
case "$1" in
+
The actual script:
  start)
+
{{hc|/etc/rc.d/crond|2=<nowiki>
    stat_busy "Starting TFTPD"
+
#!/bin/bash
    [ -z "$PID" ] && /usr/sbin/in.tftpd ${TFTPD_ARGS}
+
 
    if [ $? -gt 0 ]; then
+
. /etc/rc.conf
      stat_fail
+
. /etc/rc.d/functions
    else
+
 
      add_daemon in.tftpd
+
DAEMON=crond
      stat_done
+
ARGS=
    fi
+
 
    ;;
+
[ -r /etc/conf.d/$DAEMON ] && . /etc/conf.d/$DAEMON
  stop)
+
 
    stat_busy "Stopping TFTPD"
+
PID=$(get_pid $DAEMON)
    [ ! -z "$PID" ] && kill $PID &> /dev/null
+
 
    if [ $? -gt 0 ]; then
+
case "$1" in
      stat_fail
+
start)
    else
+
  stat_busy "Starting $DAEMON"
      rm_daemon in.tftpd
+
  [ -z "$PID" ] && $DAEMON $ARGS &>/dev/null
      stat_done
+
  if [ $? = 0 ]; then
    fi
+
    add_daemon $DAEMON
    ;;
+
    stat_done
  restart)
+
  else
    $0 stop
+
    stat_fail
    $0 start
+
    exit 1
    ;;
+
  fi
  *)
+
  ;;
    echo "usage: $0 {start|stop|restart}"   
+
stop)
esac
+
  stat_busy "Stopping $DAEMON"
exit 0
+
  [ -n "$PID" ] && kill $PID &>/dev/null
 +
  if [ $? = 0 ]; then
 +
    rm_daemon $DAEMON
 +
    stat_done
 +
  else
 +
    stat_fail
 +
    exit 1
 +
  fi
 +
  ;;
 +
restart)
 +
  $0 stop
 +
  sleep 1
 +
  $0 start
 +
  ;;
 +
*)
 +
  echo "usage: $0 {start|stop|restart}"   
 +
esac
 +
</nowiki>}}

Revision as of 13:35, 31 December 2013

Related articles

Warning: Arch only supports systemd. Arch's old initscripts package is obsolete and is no longer supported. All Arch users need to move to systemd.

Initscripts uses rc.d scripts to used to control the starting, stopping and restarting of daemons.

Guideline

  • Source /etc/rc.conf, /etc/rc.d/functions, and optionally /etc/conf.d/DAEMON_NAME.
  • Arguments and other daemon options should be placed in /etc/conf.d/DAEMON_NAME. This is done to separate configuration from logic and to keep a consistent style among daemon scripts.
  • Use functions in /etc/rc.d/functions instead of duplicating their functionality.
  • Include at least start, stop and restart as arguments to the script.

Available functions

  • There are some functions provided by /etc/rc.d/functions:
    • stat_busy "message": set status busy for printed message (e.g. Starting daemon [BUSY])
    • stat_done: set status done (e.g. Starting daemon [DONE])
    • stat_fail: set status failed (e.g. Starting daemon [FAILED])
    • get_pid program: get PID of the program
    • ck_pidfile PID-file program: check whether PID-file is still valid for the program (e.g. ck_pidfile /var/run/daemon.pid daemon || rm -f /var/run/daemon.pid)
    • [add|rm]_daemon program: add/remove program to running daemons (stored in /run/daemons/)

Full list of functions is much longer and most possibilities (like way to control whether or not non-root users can launch daemon) are still undocumented and can be learned only from /etc/rc.d/functions source. See also man rc.d.

Example

The following is an example for crond. Look in /etc/rc.d for greater variety.

The configuration file:

/etc/conf.d/crond
ARGS="-S -l info"

The actual script:

/etc/rc.d/crond
#!/bin/bash

. /etc/rc.conf
. /etc/rc.d/functions

DAEMON=crond
ARGS=

[ -r /etc/conf.d/$DAEMON ] && . /etc/conf.d/$DAEMON

PID=$(get_pid $DAEMON)

case "$1" in
 start)
   stat_busy "Starting $DAEMON"
   [ -z "$PID" ] && $DAEMON $ARGS &>/dev/null
   if [ $? = 0 ]; then
     add_daemon $DAEMON
     stat_done
   else
     stat_fail
     exit 1
   fi
   ;;
 stop)
   stat_busy "Stopping $DAEMON"
   [ -n "$PID" ] && kill $PID &>/dev/null
   if [ $? = 0 ]; then
     rm_daemon $DAEMON
     stat_done
   else
     stat_fail
     exit 1
   fi
   ;;
 restart)
   $0 stop
   sleep 1
   $0 start
   ;;
 *)
   echo "usage: $0 {start|stop|restart}"  
esac