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 November 9, 2021
  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 .Op Fl j Ar jail
  36 .Fl e
  37 .Nm
  38 .Op Fl j Ar jail
  39 .Fl R
  40 .Nm
  41 .Op Fl j Ar jail
  42 .Op Fl v
  43 .Fl l
  44 .Nm
  45 .Op Fl j Ar jail
  46 .Op Fl v
  47 .Fl r
  48 .Nm
  49 .Op Fl j Ar jail
  50 .Op Fl v
  51 .Op Fl E Ar var=value
  52 .Ar script
  53 .Ar command
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 command is an easy interface to the rc.d system.
  58 Its primary purpose is to start and stop services provided
  59 by the rc.d scripts.
  60 When used for this purpose it will set the same restricted
  61 environment that is in use at boot time
  62 .Po
  63 see
  64 .Sx ENVIRONMENT
  65 .Pc .
  66 It can also be used to list
  67 the scripts using various criteria.
  68 .Pp
  69 The options are as follows:
  70 .Bl -tag -width F1
  71 .It Fl E Ar var=value
  72 Set the environment variable
  73 .Ar var
  74 to the specified
  75 .Ar value
  76 before starting the script.
  77 This option can be used multiple times.
  78 .It Fl e
  79 List services that are enabled.
  80 The list of scripts to check is compiled using
  81 .Xr rcorder 8
  82 the same way that it is done in
  83 .Xr rc 8 ,
  84 then that list of scripts is checked for an
  85 .Qq rcvar
  86 assignment.
  87 If present the script is checked to see if it is enabled.
  88 .It Fl j Ar jail
  89 Perform the given actions under the named jail.
  90 The
  91 .Ar jail
  92 argument can be either a jail ID or a jail name.
  93 .It Fl l
  94 List all files in
  95 .Pa /etc/rc.d
  96 and the local startup directories.
  97 As described in
  98 .Xr rc.conf 5
  99 this is usually
 100 .Pa /usr/local/etc/rc.d .
 101 All files will be listed whether they are an actual
 102 rc.d script or not.
 103 .It Fl R
 104 Restart all enabled local services.
 105 .It Fl r
 106 Generate the
 107 .Xr rcorder 8
 108 as in
 109 .Fl e
 110 above, but list all of the files, not just what is enabled.
 111 .It Fl v
 112 Be slightly more verbose.
 113 .El
 114 .Sh ENVIRONMENT
 115 When used to run rc.d scripts the
 116 .Nm
 117 command sets
 118 .Ev HOME
 119 to
 120 .Pa /
 121 and
 122 .Ev PATH
 123 to
 124 .Pa /sbin:/bin:/usr/sbin:/usr/bin
 125 which is how they are set in
 126 .Pa /etc/rc
 127 at boot time.
 128 If the
 129 .Fl E
 130 option is used, the corresponding variable is set accordingly.
 131 .Sh EXIT STATUS
 132 .Ex -std
 133 .Sh EXAMPLES
 134 The following are examples of typical usage of the
 135 .Nm
 136 command:
 137 .Bd -literal -offset -ident
 138 service named status
 139 service -j dns named status
 140 service -E LC_ALL=C.UTF-8 named start
 141 service -rv
 142 .Ed
 143 .Pp
 144 The following programmable completion entry can be used in
 145 .Xr csh 1
 146 for the names and common commands of the rc.d scripts:
 147 .Bd -literal -offset indent
 148 complete service 'c/-/(e l r v)/' 'p/1/`service -l`/' \e
 149                  'n/*/(start stop reload restart \e
 150                  status rcvar onestart onestop)/'
 151 .Ed
 152 .Pp
 153 The following programmable completion entry can be used in
 154 .Xr bash 1
 155 for the names of the rc.d scripts:
 156 .Bd -literal -offset -ident
 157 _service () {
 158         local cur
 159         cur=${COMP_WORDS[COMP_CWORD]}
 160         COMPREPLY=( $( compgen -W '$( service -l )' -- $cur ) )
 161         return 0
 162 }
 163 complete -F _service service
 164 .Ed
 165 .Sh SEE ALSO
 166 .Xr bash 1 Pq Pa ports/shells/bash ,
 167 .Xr rc.conf 5 ,
 168 .Xr rc 8 ,
 169 .Xr rcorder 8
 170 .Sh HISTORY
 171 The
 172 .Nm
 173 utility first appeared in
 174 .Fx 7.3 .
 175 .Sh AUTHORS
 176 This
 177 manual page was written by
 178 .An Douglas Barton Aq Mt dougb@FreeBSD.org .