share/man/man8/locator.8

   1 '\" te
   2 .\" Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH LOCATOR 8 "Sep 4, 2001"
   7 .SH NAME
   8 locator \- location indicator control
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB /usr/sbin/locator\fR [\fB-f\fR | \fB-n\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The locator command sets or queries the state of the system locator if such a
  19 device exists.
  20 .sp
  21 .LP
  22 Without options, the locator command reports the current state of the system.
  23 .sp
  24 .LP
  25 The privileges required to use this command are hardware dependent. Typically,
  26 only the super user can get or set a locator.
  27 .SH OPTIONS
  28 .sp
  29 .LP
  30 The following options are supported:
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fB-f\fR\fR
  35 .ad
  36 .RS 6n
  37 Turns the locator off.
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fB-n\fR\fR
  44 .ad
  45 .RS 6n
  46 Turns the locator on.
  47 .RE
  48
  49 .SH EXAMPLES
  50 .LP
  51 \fBExample 1 \fRUsing the \fBlocator\fR Command on a Platform Which Has a
  52 System Locator LED
  53 .sp
  54 .LP
  55 When issued on a platform which has a system locator \fBLED\fR, the following
  56 command turns the locator on:
  57
  58 .sp
  59 .in +2
  60 .nf
  61 # \fBlocator \fR\fB-n\fR
  62 # \fBlocator\fR
  63 The 'system' locator is on
  64 .fi
  65 .in -2
  66 .sp
  67
  68 .LP
  69 \fBExample 2 \fRUsing the \fBlocator\fR Command on a Platform Which Does Not
  70 Have a System Locator LED
  71 .sp
  72 .LP
  73 When issued on a platform which does not have a system locator \fBLED\fR, the
  74 following command attempts to turn the locator on. The command returns an error
  75 message.
  76
  77 .sp
  78 .in +2
  79 .nf
  80 # \fBlocator \fR\fB-n\fR
  81 \&'system' locator not found
  82 .fi
  83 .in -2
  84 .sp
  85
  86 .SH EXIT STATUS
  87 .sp
  88 .LP
  89 The following exit values are returned:
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fB0\fR\fR
  94 .ad
  95 .RS 5n
  96 Successful completion.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fB1\fR\fR
 103 .ad
 104 .RS 5n
 105 Invalid command line input.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fB2\fR\fR
 112 .ad
 113 .RS 5n
 114 The requested operation failed.
 115 .RE
 116
 117 .SH SEE ALSO
 118 .sp
 119 .LP
 120 \fBattributes\fR(5)