system_cmds/cpuctl.tproj/cpuctl.8

   1 .\" Darwin cpuctl man page adapted from NetBSD (credits below):
   2 .\"
   3 .\"     $NetBSD: cpuctl.8,v 1.18 2018/01/14 00:45:54 mrg Exp $
   4 .\"
   5 .\" Copyright (c) 2007, 2008, 2012, 2015 The NetBSD Foundation, Inc.
   6 .\" All rights reserved.
   7 .\"
   8 .\" This code is derived from software contributed to The NetBSD Foundation
   9 .\" by Andrew Doran.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  22 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  24 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30 .\" POSSIBILITY OF SUCH DAMAGE.
  31 .\"
  32 .Dd March 18, 2019
  33 .Dt CPUCTL 8
  34 .Os Darwin
  35 .Sh NAME
  36 .Nm cpuctl
  37 .Nd program to control CPUs
  38 .Sh SYNOPSIS
  39 .Nm cpuctl
  40 .Ar command
  41 .Op Ar arguments
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 command can be used to control and inspect the state of CPUs in the system.
  46 .Pp
  47 The first argument,
  48 .Ar command ,
  49 specifies the action to take.
  50 Valid commands are:
  51 .Bl -tag -width offline
  52 .It list
  53 For each CPU in the system, display the current state and time of the last
  54 state change.
  55 .It offline Ar cpu Op Ar cpu ...
  56 Set the specified CPUs off line.
  57 .Pp
  58 At least one CPU in the system must remain on line.
  59 .It online Ar cpu Op Ar cpu ...
  60 Set the specified CPUs on line.
  61 .El
  62 .Sh EXAMPLES
  63 Run
  64 .Dl cpuctl offline 2
  65 and then
  66 .Dl cpuctl list
  67 The output should reflect the fact that CPU#2 was taken offline.