FreeBSD Porter's Handbook
Prev | Chapter 6 Special considerations | Next

# 6.22 Starting and stopping services (rc scripts)

`rc.d` scripts are used to start services on system startup, and to give administrators a standard way of stopping, starting and restarting the service. Ports integrate into the system `rc.d` framework. Details on its usage can be found in the rc.d Handbook chapter. Detailed explanation of available commands is provided in rc(8) and rc.subr(8). Finally, there is an article on practical aspects of `rc.d` scripting.

One or more `rc.d` scripts can be installed:

    USE_RC_SUBR=   doormand

Scripts must be placed in the `files` subdirectory and a `.in` suffix must be added to their filename. Standard `SUB_LIST` expansions will be used for this file. Use of the `%%PREFIX%%` and `%%LOCALBASE%%` expansions is strongly encouraged as well. More on `SUB_LIST` in the relevant section.

Prior to FreeBSD 6.1-RELEASE, integration with rcorder(8) is available by using `USE_RCORDER` instead of `USE_RC_SUBR`. However, use of this method is not necessary unless the port has an option to install itself in the base, or the service needs to run prior to the `FILESYSTEMS` `rc.d` script in the base.

As of FreeBSD 6.1-RELEASE, local `rc.d` scripts (including those installed by ports) are included in the overall rcorder(8) of the base system.

Example simple `rc.d` script:

    #!/bin/sh

    # $FreeBSD$
    #
    # PROVIDE: doormand
    # REQUIRE: LOGIN
    # KEYWORD: shutdown
    #
    # Add the following lines to /etc/rc.conf.local or /etc/rc.conf
    # to enable this service:
    #
    # doormand_enable (bool):   Set to NO by default.
    #               Set it to YES to enable doormand.
    # doormand_config (path):   Set to %%PREFIX%%/etc/doormand/doormand.cf
    #               by default.
    #

    . /etc/rc.subr

    name="doormand"
    rcvar=${name}_enable

    command=%%PREFIX%%/sbin/${name}
    pidfile=/var/run/${name}.pid

    load_rc_config $name

    : ${doormand_enable="NO"}
    : ${doormand_config="%%PREFIX%%/etc/doormand/doormand.cf"}

    command_args="-p $pidfile -f $doormand_config"

    run_rc_command "$1"

Unless there is a good reason to start the service earlier all ports scripts should use

    REQUIRE: LOGIN

If the service runs as a particular user (other than root) this is mandatory.

    KEYWORD: shutdown

is included in the script above because the mythical port we are using as an example starts a service, and should be shut down cleanly when the system shuts down. If the script is not starting a persistent service this is not necessary.

The "=" style of default variable assignment is preferable to the ":=" style here, since the former sets a default value only if the variable is unset, and the latter sets one if the variable is unset or null. A user might very well include something like

    doormand_flags=""

in their `rc.conf.local` file, and a variable substitution using ":=" would inappropriately override the user's intention.

> Note: No new scripts should be added with the `.sh` suffix. At some point there will be a mass repocopy of all the scripts that still have that suffix.

## 6.22.1 Stopping services at deinstall

It is possible to have a service stopped automatically as part of the deinstall routine. We advise using this feature only when it's absolutely necessary to stop a service before it's files go away. Usually, it's up to the administrator's discretion to decide, whether to stop the service on deinstall or not. Also note this affects upgrades, too.

Line like this goes to the `pkg-plist`:

    @stopdaemon doormand

The argument must match the content of `USE_RC_SUBR` variable.

Prev | Home | Next
Using databases | Up | Adding users and groups

For questions about the FreeBSD ports system, e-mail <ports@FreeBSD.org>.
For questions about this documentation, e-mail <doc@FreeBSD.org>.