launchd/src/SystemStarter.8

   1 .Dd April 12, 2002
   2 .Dt SystemStarter 8
   3 .Os Darwin
   4 .Sh NAME
   5 .Nm SystemStarter
   6 .\" The following lines are read in generating the apropos(man -k) database. Use only key
   7 .\" words here as the database is built based on the words here and in the .ND line.
   8 .\" Use .Nm macro to designate other names for the documented program.
   9 .Nd Start, stop, and restart system services
  10 .Sh SYNOPSIS
  11 .Nm
  12 .Op Fl gvxdDqn
  13 .Op Ar action Op Ar service
  14 .Sh DESCRIPTION
  15 The
  16 .Nm
  17 utility may be used to start, stop, and restart the system services which
  18 are described in the
  19 .Pa /Library/StartupItems/
  20 and
  21 .Pa /System/Library/StartupItems/
  22 paths.
  23 .Pp
  24 The optional
  25 .Ar action
  26 argument specifies which action
  27 .Nm
  28 performs on the startup items.  The optional
  29 .Ar service
  30 argument specifies which startup items to perform the action on.  If no
  31 .Ar service
  32 is specified, all startup items will be acted on; otherwise, only the item providing the
  33 .Ar service ,
  34 any items it requires, or any items that depend on it will be acted on.
  35 .Pp
  36 During boot
  37 .Nm
  38 is invoked by
  39 .Nm rc
  40 (see rc(8)) and is responsible for
  41 starting all startup items in an order that satisfies each item's
  42 requirements.
  43 .Sh ACTIONS
  44 .Bl -tag -width -indent
  45 .It Nm start
  46 start all items, or start the item that provides the specified
  47 .Ar service
  48 and all items providing services it requires.
  49 .It Nm stop
  50 stop all items, or stop the item that provides the specified
  51 .Ar service
  52 and all items that depend on it.
  53 .It Nm restart
  54 restart all items, or restart the item providing the specified
  55 .Ar service .
  56 .El
  57 .Sh OPTIONS
  58 .Bl -tag -width -indent
  59 .It Fl g
  60 (ignored)
  61 .It Fl v
  62 verbose (text mode) startup
  63 .It Fl x
  64 (ignored)
  65 .It Fl r
  66 (ignored)
  67 .It Fl d
  68 print debugging output
  69 .It Fl D
  70 print debugging output and dependencies
  71 .It Fl q
  72 be quiet (disable debugging output)
  73 .It Fl n
  74 don't actually perform action on items (no-run mode)
  75 .El
  76 .Sh NOTES
  77 Unless an explicit call to
  78 .Nm ConsoleMessage
  79 is made,
  80 .Nm
  81 examines the exit status of the startup item scripts to determine the success or failure of the services provided by that script.
  82 .Pp
  83 In Darwin it is preferable to create custom startup items than to modify
  84 .Nm rc ,
  85 and at some point
  86 .Nm
  87 may entirely encompass the role of
  88 .Nm rc .
  89 .Sh FILES
  90 .Bl -tag -width -/System/Library/StartupItems -compact
  91 .It Pa /Library/StartupItems/
  92 User-installed startup items.
  93 .It Pa /System/Library/StartupItems/
  94 System-provided startup items.
  95 .El
  96 .Sh SEE ALSO
  97 .\" List links in ascending order by section, alphabetically within a section.
  98 .\" Please do not reference files that do not exist without filing a bug report
  99 .Xr ConsoleMessage 8
 100 .Pp
 101 .Xr rc 8
 102 .\" .Sh BUGS              \" Document known, unremedied bugs
 103 .Sh HISTORY
 104 The
 105 .Nm
 106 utility appeared in Darwin 1.0
 107 .Pp
 108 .Nm
 109 was extended in Darwin 6.0 to support partial startup and interprocess communication.