sbin/conscontrol/conscontrol.8

   1 .\"
   2 .\" Copyright (c) 2001 Jonathan Lemon <jlemon@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd April 14, 2011
  29 .Dt CONSCONTROL 8
  30 .Os
  31 .Sh NAME
  32 .Nm conscontrol
  33 .Nd control physical console devices
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Cm list
  37 .Nm
  38 .Cm mute on | off
  39 .Nm
  40 .Cm add | delete
  41 .Ar console
  42 .Nm
  43 .Cm set | unset Ar console
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility is used to examine and modify the physical devices which back
  48 the virtual console devices.
  49 If no arguments
  50 (or only the
  51 .Cm list
  52 command)
  53 are specified,
  54 the current console settings are shown.
  55 .Pp
  56 There are two types of logical consoles; a high level console which
  57 is represented by
  58 .Pa /dev/console ,
  59 and a low level console.
  60 The low level console is used for kernel
  61 .Xr printf 9
  62 and
  63 .Xr ddb 4
  64 debugger support,
  65 while the high level console is used by user programs like
  66 .Xr syslogd 8 .
  67 Multiple device support is implemented only for the low level console;
  68 the high level console is set to the first device in the console list.
  69 .Pp
  70 Multiple console support may be invoked by passing the kernel the
  71 .Fl D
  72 flag from the boot loader, or by using
  73 .Nm
  74 to change the list of console devices after the system has booted.
  75 .Pp
  76 The following options are available:
  77 .Bl -tag -width indent
  78 .It Cm add | delete Ar console
  79 Add or delete a physical device from the logical console.
  80 The device must support low-level console operations.
  81 Adding a device will place it at the front of the list of console
  82 devices; the first device is used for the high level console.
  83 .Pp
  84 The
  85 .Ar console
  86 argument
  87 is the name of a console device in
  88 .Pa /dev ;
  89 the name of the directory may be omitted.
  90 .It Cm mute on | off
  91 Change the state of console muting.
  92 All console output is suppressed when console muting is
  93 .Cm on .
  94 .It Cm set | unset Ar console
  95 Set or unset the virtual console.
  96 When unset, output from the system, such as the kernel
  97 .Xr printf 9 ,
  98 always goes out to the real main console.
  99 When set, it goes to another.
 100 This is an interface to the tty ioctl
 101 .Dv TIOCCONS .
 102 .El
 103 .Sh SEE ALSO
 104 .Xr sio 4 ,
 105 .Xr syscons 4 ,
 106 .Xr tty 4 ,
 107 .Xr boot 8 ,
 108 .Xr loader 8
 109 .Sh HISTORY
 110 The
 111 .Nm
 112 utility first appeared in
 113 .Fx 5.0 .
 114 .Sh AUTHORS
 115 .An Jonathan Lemon