Move everything from /var/adm to /var/log
[unleashed.git] / share / man / man1 / rmmount.1
blobdc854826dbae2feea4ea532a9cc51bd659063d6f
1 '\" te
2 .\" Copyright (c) 2006, 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 RMMOUNT 1 "Sep 18, 2006"
7 .SH NAME
8 rmmount, rmumount \- mounts and unmounts removable media
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBrmmount\fR  [\fB-u\fR] [\fB-o\fR \fIoptions\fR] [\fInickname\fR | \fIdevice\fR] [\fImount_point\fR]
13 .fi
15 .LP
16 .nf
17 \fBrmmount\fR  [\fB-d\fR] [\fB-l\fR]
18 .fi
20 .LP
21 .nf
22 \fBrmumount\fR  [\fInickname\fR | \fImount_point\fR | \fIdevice\fR]
23 .fi
25 .LP
26 .nf
27 \fBrmumount\fR  [\fB-d\fR] [\fB-l\fR]
28 .fi
30 .SH DESCRIPTION
31 .sp
32 .LP
33 The \fBrmmount\fR and \fBrmumount\fR utilities mount and unmount removable or
34 hot-pluggable volumes. The optional argument can identify the volume by its
35 volume label, mount point or block device path.
36 .sp
37 .LP
38 \fBrmmount\fR can also take additional mount options if the user has sufficient
39 privileges to override the default mount options.
40 .sp
41 .LP
42 Unmounting removable media does not result in its ejection. Use \fBeject\fR(1)
43 to optionally unmount and eject the media.
44 .SH OPTIONS
45 .sp
46 .LP
47 The following options are supported for \fBrmmount\fR and \fBrmumount\fR:
48 .sp
49 .ne 2
50 .na
51 \fB\fB-d\fR\fR
52 .ad
53 .RS 6n
54 Display the device path of the default device. This device is used if no
55 arguments are supplied.
56 .RE
58 .sp
59 .ne 2
60 .na
61 \fB\fB-l\fR\fR
62 .ad
63 .RS 6n
64 Display the paths and nicknames of mountable devices.
65 .RE
67 .sp
68 .LP
69 The following options are supported for \fBrmmount\fR only:
70 .sp
71 .ne 2
72 .na
73 \fB\fB-o\fR \fIoptions\fR\fR
74 .ad
75 .RS 14n
76 Display mount options. This option can only be used by users that have
77 privileges to override the system default options.
78 .RE
80 .sp
81 .ne 2
82 .na
83 \fB\fB-u\fR\fR
84 .ad
85 .RS 14n
86 Unmounts the volume as opposed to mounting it.
87 .RE
89 .SH OPERANDS
90 .sp
91 .LP
92 The following operands are supported:
93 .sp
94 .ne 2
95 .na
96 \fB\fIdevice\fR\fR
97 .ad
98 .RS 15n
99 Specifies which device to mount or unmount, by the name it appears in the
100 directory \fB/dev\fR.
104 .ne 2
106 \fB\fImount_point\fR\fR
108 .RS 15n
109 Specifies which device to mount or unmount, by the name it appears in the
110 directory \fB/dev\fR.
114 .ne 2
116 \fB\fInickname\fR\fR
118 .RS 15n
119 Specifies which device to mount or unmount, by its nickname as known to  this
120 command.
123 .SH EXAMPLES
125 \fBExample 1 \fRMounting a USB disk
128 The following example mounts a USB disk with a volume label of \fBPHOTOS\fR:
131 .in +2
133 example% rmmount PHOTOS
135 .in -2
139 \fBExample 2 \fRUnmounting a \fBpcfs\fR Volume
142 The following example unmounts a \fBpcfs\fR volume by device path:
145 .in +2
147 example% rmumount /dev/dsk/c4t0d0p0:1
149 .in -2
152 .SH EXIT STATUS
155 The following exit values are returned:
157 .ne 2
159 \fB\fB0\fR\fR
161 .RS 6n
162 Successful completion.
166 .ne 2
168 \fB>\fB0\fR\fR
170 .RS 6n
171 An error occurred.
174 .SH FILES
176 .ne 2
178 \fB\fB/media\fR\fR
180 .RS 10n
181 Default mount root.
184 .SH ATTRIBUTES
187 See \fBattributes\fR(5) for descriptions of the following attributes:
192 box;
193 c | c
194 l | l .
195 ATTRIBUTE TYPE  ATTRIBUTE VALUE
197 Interface Stability     Uncommitted
200 .SH SEE ALSO
203 \fBeject\fR(1), \fBattributes\fR(5)