launchd/src/ConsoleMessage.8

   1 .Dd April 12, 2002
   2 .Dt ConsoleMessage 8
   3 .Os Darwin
   4 .Sh NAME
   5 .Nm ConsoleMessage
   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 Send a message to
  10 .Nm SystemStarter
  11 .Sh SYNOPSIS
  12 .Nm
  13 .Op Fl v
  14 .Ar message
  15 .Nm
  16 .Op Fl v
  17 .Fl S
  18 .Nm
  19 .Op Fl v
  20 .Fl F
  21 .Nm
  22 .Op Fl v
  23 .Fl s Ar service
  24 .Nm
  25 .Op Fl v
  26 .Fl f Ar service
  27 .Nm
  28 .Op Fl v
  29 .Fl q Ar setting
  30 .Nm
  31 .Op Fl v
  32 .Fl b Ar path
  33 .Nm
  34 .Op Fl v
  35 .Fl u
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 utility may be used by startup item scripts to send messages to
  40 .Nm SystemStarter
  41 (see SystemStarter(8)).
  42 .Pp
  43 The default behavior is to send the specified
  44 .Ar message
  45 to
  46 .Nm SystemStarter
  47 to be displayed on the console.
  48 .Nm SystemStarter
  49 will attempt to localize the string using the current startup item's localization dictionaries.
  50 .Pp
  51 .Nm
  52 may also be used to give feedback to
  53 .Nm SystemStarter
  54 indicating which services provided by the startup item have succeeded or failed.
  55 .Sh OPTIONS
  56 .Bl -tag -width -indent
  57 .It Fl v
  58 verbose mode (prints errors to stdout)
  59 .It Fl S
  60 mark all services provided by this item as successful
  61 .It Fl F
  62 mark all services provided by this item as failed
  63 .It Fl s
  64 mark the
  65 .Ar service
  66 as successful
  67 .It Fl f
  68 mark the
  69 .Ar service
  70 as failed
  71 .It Fl q
  72 query
  73 .Nm SystemStarter
  74 for the value of the configuration variable
  75 .Ar setting
  76 (result will be printed to stdout).
  77 .It Fl b
  78 Tell
  79 .Nm SystemStarter
  80 to load the display bundle at the specified
  81 .Ar path
  82 .It Fl u
  83 Tell
  84 .Nm SystemStarter
  85 to unload the current display bundle
  86 .El
  87 .Sh NOTES
  88 When a
  89 .Ar service
  90 name is not specified,
  91 .Nm
  92 assumes its parent process identification (see getppid(2)) is that of a startup item script, and uses that token to find the correct list of services provided by the current item. If the process calling
  93 .Nm
  94 is not a startup item script, it is necessary to explicitly provide
  95 .Ar service
  96 names.
  97 .Sh SEE ALSO
  98 .\" List links in ascending order by section, alphabetically within a section.
  99 .\" Please do not reference files that do not exist without filing a bug report
 100 .Xr SystemStarter 8
 101 .\" .Sh BUGS              \" Document known, unremedied bugs
 102 .Sh HISTORY
 103 The
 104 .Nm
 105 utility appeared in Darwin 6.0