usr/src/man/man1m/getvol.1m

   1 '\" te
   2 .\"  Copyright 1989 AT&T   Copyright (c) 1997 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 GETVOL 1M "Jul 5, 1990"
   7 .SH NAME
   8 getvol \- verifies device accessibility
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/bin/getvol\fR \fB-n\fR [\fB-l\fR \fIlabel\fR] \fIdevice\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/bin/getvol\fR [\fB-f\fR | \fB-F\fR] [\fB-ow\fR] [\fB-l\fR \fIlabel\fR | \fB-x\fR \fIlabel\fR] \fIdevice\fR
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 \fBgetvol\fR verifies that the specified device is accessible and that a volume
  24 of the appropriate medium has been inserted. The command is interactive and
  25 displays instructional prompts, describes errors, and shows required label
  26 information.
  27 .SH OPTIONS
  28 .sp
  29 .LP
  30 The following options are supported:
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fB-n\fR\fR
  35 .ad
  36 .RS 12n
  37 Runs the command in non-interactive mode. The volume is assumed to be inserted
  38 upon command invocation.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB-l\fR\fI label\fR\fR
  45 .ad
  46 .RS 12n
  47 Specifies that the label  \fIlabel\fR must exist on the inserted volume (can be
  48 overridden by the \fB-o\fR option).
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fB-f\fR\fR
  55 .ad
  56 .RS 12n
  57 Formats the volume after insertion, using the format command defined for this
  58 device in the device table.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-F\fR\fR
  65 .ad
  66 .RS 12n
  67 Formats the volume after insertion and places a file system on the device. Also
  68 uses the format command defined for this device in the device table.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB-o\fR\fR
  75 .ad
  76 .RS 12n
  77 Allows the administrator to override a label check.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB-w\fR\fR
  84 .ad
  85 .RS 12n
  86 Allows administrator to write a new label on the device. User is prompted to
  87 supply the label text. This option is ineffective if the  \fB-n\fR option is
  88 enabled.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-x\fR\fI label\fR\fR
  95 .ad
  96 .RS 12n
  97 Specifies that the label  \fIlabel\fR must exist on the device. This option
  98 should be used in place of the  \fB-l\fR option when the label can only be
  99 verified by visual means. Use of the option causes a message to be displayed
 100 asking the administrator to visually verify that the label is indeed
 101 \fIlabel\fR.
 102 .RE
 103
 104 .SH OPERANDS
 105 .sp
 106 .LP
 107 The following operands are supported:
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fIdevice\fR\fR
 112 .ad
 113 .RS 10n
 114 Specifies the device to be verified for accessibility.
 115 .RE
 116
 117 .SH EXIT STATUS
 118 .sp
 119 .LP
 120 The following exit values are returned:
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fB0\fR\fR
 125 .ad
 126 .RS 5n
 127 Successful completion.
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fB1\fR\fR
 134 .ad
 135 .RS 5n
 136 Command syntax was incorrect, invalid option was used, or an internal error
 137 occurred.
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fB3\fR\fR
 144 .ad
 145 .RS 5n
 146 Device table could not be opened for reading.
 147 .RE
 148
 149 .SH FILES
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fB/etc/device.tab\fR\fR
 154 .ad
 155 .RS 19n
 156
 157 .RE
 158
 159 .SH SEE ALSO
 160 .sp
 161 .LP
 162 \fBattributes\fR(5)
 163 .SH NOTES
 164 .sp
 165 .LP
 166 This command uses the device table to determine the characteristics of the
 167 device when performing the volume label checking.