usr.sbin/service/service.8

   1 .\" Copyright (c) 2009 Douglas Barton
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd December 26, 2009
  28 .Dt service 8
  29 .Os
  30 .Sh NAME
  31 .Nm service
  32 .Nd "control (start/stop/etc.) or list system services"
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Fl e
  36 .Nm
  37 .Op Fl v
  38 .Fl l | r
  39 .Nm
  40 .Op Fl v
  41 .Ar <rc.d script> start|stop|etc.
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 command is an easy interface to the rc.d system.
  46 Its primary purpose is to start and stop services provided
  47 by the rc.d scripts.
  48 When used for this purpose it will set the same restricted
  49 environment that is in use at boot time (see below).
  50 It can also be used to list
  51 the scripts using various criteria.
  52 .Pp
  53 The options are as follows:
  54 .Bl -tag -width F1
  55 .It Fl e
  56 List services that are enabled.
  57 The list of scripts to check is compiled using
  58 .Xr rcorder 8
  59 the same way that it is done in
  60 .Xr rc 8 ,
  61 then that list of scripts is checked for an
  62 .Qq rcvar
  63 assignment.
  64 If present the script is checked to see if it is enabled.
  65 .It Fl l
  66 List all files in
  67 .Pa /etc/rc.d
  68 and the local startup directories.
  69 As described in
  70 .Xr rc.conf 5
  71 this is usually
  72 .Pa /usr/local/etc/rc.d .
  73 All files will be listed whether they are an actual
  74 rc.d script or not.
  75 .It Fl r
  76 Generate the
  77 .Xr rcorder 8
  78 as in
  79 .Fl e
  80 above, but list all of the files, not just what is enabled.
  81 .It Fl v
  82 Be slightly more verbose
  83 .El
  84 .Sh ENVIRONMENT
  85 When used to run rc.d scripts the
  86 .Nm
  87 command sets
  88 .Ev HOME
  89 to
  90 .Pa /
  91 and
  92 .Ev PATH
  93 to
  94 .Pa /sbin:/bin:/usr/sbin:/usr/bin
  95 which is how they are set in
  96 .Pa /etc/rc
  97 at boot time.
  98 .Sh EXIT STATUS
  99 .Ex -std
 100 .Sh EXAMPLES
 101 The following are examples of typical usage of the
 102 .Nm
 103 command:
 104 .Pp
 105 .Dl "service named status"
 106 .Dl "service -rv"
 107 .Pp
 108 The following programmable completion entry can be use in
 109 .Xr bash 1
 110 for the names of the rc.d scripts:
 111 .Dl "_service () {"
 112 .Dl "   local cur"
 113 .Dl "   cur=${COMP_WORDS[COMP_CWORD]}"
 114 .Dl "   COMPREPLY=( $( compgen -W '$( service -l )' -- $cur ) )"
 115 .Dl "   return 0"
 116 .Dl "}"
 117 .Dl "complete -F _service service"
 118 .Sh SEE ALSO
 119 .Xr bash 1 Pq Pa ports/shells/bash ,
 120 .Xr rc.conf 5 ,
 121 .Xr rc 8 ,
 122 .Xr rcorder 8
 123 .Sh HISTORY
 124 The
 125 .Nm
 126 manual page service first appeared in
 127 .Fx 7.3 .
 128 .Sh AUTHORS
 129 This
 130 manual page was written by
 131 .An Douglas Barton <dougb@FreeBSD.org> .