Unleashed v1.4
[unleashed.git] / share / man / man8 / labelit_ufs.8
blobaf9eb9550461d5c916a6319d4128167553db2dd7
1 '\" te
2 .\" Copyright (c) 2003 Sun Microsystems, Inc.  All Rights Reserved.
3 .\" Copyright 1989 AT&T
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH LABELIT_UFS 8 "Apr 15, 2003"
8 .SH NAME
9 labelit_ufs \- provide and print labels for ufs file systems
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBlabelit\fR \fB-F\fR ufs [\fIgeneric_options\fR] \fIspecial\fR [\fIfsname\fR \fIvolume\fR]
14 .fi
16 .SH DESCRIPTION
17 .sp
18 .LP
19 \fBlabelit\fR is used to write labels on unmounted disk file systems. Such
20 labels may be used to uniquely identify volumes and are used by volume-oriented
21 programs such as \fBvolcopy\fR(8).
22 .SH OPTIONS
23 .sp
24 .LP
25 The following option is supported:
26 .sp
27 .ne 2
28 .na
29 \fB\fIgeneric_options\fR\fR
30 .ad
31 .RS 19n
32 options supported by the generic  \fBlabelit\fR command. See
33 \fBlabelit\fR(8).
34 .RE
36 .SH OPERANDS
37 .sp
38 .LP
39 The following operands are supported:
40 .sp
41 .ne 2
42 .na
43 \fB\fIspecial\fR\fR
44 .ad
45 .RS 11n
46 name should be the physical disk section (for example, \fB/dev/dsk/c0d0s6\fR).
47 The device may not be on a remote machine.
48 .RE
50 .sp
51 .ne 2
52 .na
53 \fB\fIfsname\fR\fR
54 .ad
55 .RS 11n
56 represents the mount point (for example, \fBroot\fR, \fBu1\fR, and so on) of
57 the file system.
58 .RE
60 .sp
61 .ne 2
62 .na
63 \fB\fIvolume\fR\fR
64 .ad
65 .RS 11n
66 may be used to represent the physical volume name.
67 .RE
69 .sp
70 .LP
71 If  \fIfsname\fR and  \fIvolume\fR are not specified, \fBlabelit\fR prints the
72 current values of these labels.  Both  \fIfsname\fR and  \fIvolume\fR are
73 limited to six or fewer characters.
74 .SH EXIT STATUS
75 .sp
76 .LP
77 The following exit values are returned:
78 .sp
79 .ne 2
80 .na
81 \fB\fB0\fR\fR
82 .ad
83 .RS 12n
84 Write or display of labels was successful.
85 .RE
87 .sp
88 .ne 2
89 .na
90 \fBnon-zero\fR
91 .ad
92 .RS 12n
93 An error occurred.
94 .RE
96 .SH SEE ALSO
97 .sp
98 .LP
99 \fBlabelit\fR(8), \fBvolcopy\fR(8), \fBattributes\fR(5), \fBufs\fR(7FS)