wiki:Scripts/runscript

Version 3 (modified by Waldorf, 7 years ago) (diff)

append eend with $?

runscript

(for other scripts, see the Scripts page)

Description

This is the bootscript for Gentoo, for use with their init daemon.

Installation

This should be installed at /etc/init.d/ as transmission-daemon. Make the script executable:

chmod +x /etc/init.d/transmission-daemon

Configuration

It's recommended to run Transmission in it's own user. By default, the script is configured to 'transmission'. For the sake of security you shouldn't set a password on this user Try:

$ adduser --disabled-password transmission

However, you can set the USERNAME to any user you prefer.

For more information, visit the Running Transmission on a headless machine page

Use

Activate the use of the script (starts the daemon at boot time, stops it at shutdown)

$ rc-update add transmission default

Start and stop it manually by calling the init-script yourself.

$ /etc/init.d/transmission-daemon start

To stop transmission, just call the init-script with the "stop" parameter:

$ /etc/init.d/transmission-daemon stop

Script "transmission-daemon"

#!/sbin/runscript
#

#
# ----- CONFIGURATION -----
#
# For the default location Transmission uses, visit:
# http://trac.transmissionbt.com/wiki/ConfigFiles
# For a guide on how set the preferences, visit:
# http://trac.transmissionbt.com/wiki/EditConfigFiles
# For the available environement variables, visit:
# http://trac.transmissionbt.com/wiki/EnvironmentVariables
#
# The name of the user that should run Transmission.
# It's RECOMENDED to run Transmission in it's own user,
# by default, this is set to 'transmission'.
# For the sake of security you shouldn't set a password
# on this user
USERNAME=transmission


# ----- *ADVANCED* CONFIGURATION -----
# Only change these options if you know what you are doing!
#
# The folder where Transmission stores the config & web files.
# ONLY change this you have it at a non-default location
#TRANSMISSION_HOME="/var/config/transmission-daemon"
#TRANSMISSION_WEB_HOME="/usr/share/transmission/web"
#
# The arguments passed on to transmission-daemon.
# ONLY change this you need to, otherwise use the
# settings file as per above.
#TRANSMISSION_ARGS=""


# ----- END OF CONFIGURATION -----
#
# PATH should only include /usr/* if it runs after the mountnfs.sh script.
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
DESC="bittorrent client"
NAME=transmission-daemon
DAEMON=$(which $NAME)
PIDFILE=/var/run/$NAME.pid
SCRIPTNAME=/etc/init.d/$NAME

# Exit if the package is not installed
[ -x "$DAEMON" ] || exit 0

# Read configuration variable file if it is present
#[ -r /etc/conf.d/$NAME ] && . /etc/conf.d/$NAME <- not needed on entoo?

depend() {
   need net
}

#
# Function that starts the daemon/service
#
do_start()
{
    # Export the configuration/web directory, if set
    if [ -n "$TRANSMISSION_HOME" ]; then
          export TRANSMISSION_HOME
    fi
    if [ -n "$TRANSMISSION_WEB_HOME" ]; then
          export TRANSMISSION_WEB_HOME
    fi

    # Return
    #   0 if daemon has been started
    #   1 if daemon was already running
    #   2 if daemon could not be started
    start-stop-daemon --chuid $USERNAME --start --pidfile $PIDFILE --make-pidfile \
            --exec $DAEMON --background --test -- -f $TRANSMISSION_ARGS > /dev/null \
            || return 1
    start-stop-daemon --chuid $USERNAME --start --pidfile $PIDFILE --make-pidfile \
            --exec $DAEMON --background -- -f $TRANSMISSION_ARGS \
            || return 2
}

#
# Function that stops the daemon/service
#
do_stop()
{
        # Return
        #   0 if daemon has been stopped
        #   1 if daemon was already stopped
        #   2 if daemon could not be stopped
        #   other if a failure occurred
        start-stop-daemon --stop --quiet --retry=TERM/10/KILL/5 --pidfile $PIDFILE --name $NAME
        RETVAL="$?"
        [ "$RETVAL" = 2 ] && return 2

        # Wait for children to finish too if this is a daemon that forks
        # and if the daemon is only ever run from this initscript.
        # If the above conditions are not satisfied then add some other code
        # that waits for the process to drop all resources that could be
        # needed by services started subsequently.  A last resort is to
        # sleep for some time.

        start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
        [ "$?" = 2 ] && return 2

        # Many daemons don't delete their pidfiles when they exit.
        rm -f $PIDFILE

        return "$RETVAL"
}


start() {
    ebegin "Starting $DESC" "$NAME..."
    do_start
    case "$?" in
            0|1) eend $? "   Starting $DESC $NAME succeeded" ;;
            *)   eend $? "   Starting $DESC $NAME failed" ;;
    esac
    ;;
}

stop() {
    ebegin "Stopping $DESC $NAME..."
    do_stop
    case "$?" in
            0|1) eend $? "   Stopping $DESC $NAME succeeded" ;;
            *)   eend $? "   Stopping $DESC $NAME failed" ;;
    esac
    ;;
}

restart() {
  ebegin "Restarting $DESC $NAME..."
  do_stop
  case "$?" in
    0|1)
          do_start
          case "$?" in
              0|1) eend $? "   Restarting $DESC $NAME succeeded" ;;
              *)   eend $? "   Restarting $DESC $NAME failed: couldn't start $NAME" ;;
          esac
          ;;
    *)
          eend $? "   Restarting $DESC $NAME failed: couldn't stop $NAME" ;;
  esac
  ;;
}