No empty .Rs/.Re
[netbsd-mini2440.git] / sbin / apmlabel / apmlabel.8
blob718e39c19e8d438ba01342524a3b018246a1bc05
1 .\"     $NetBSD: apmlabel.8,v 1.2 2007/05/19 14:23:25 wiz Exp $
2 .\"
3 .\" Copyright (C) 1998 Wolfgang Solfrank.
4 .\" Copyright (C) 1998 TooLs GmbH.
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by TooLs GmbH.
18 .\" 4. The name of TooLs GmbH may not be used to endorse or promote products
19 .\"    derived from this software without specific prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
22 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 .\" IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
30 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 .\"
32 .Dd May 19, 2007
33 .Dt APMLABEL 8
34 .Os
35 .Sh NAME
36 .Nm apmlabel
37 .Nd update disk label from Apple Partition Map
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl fqrw
41 .Ar device
42 .Sh DESCRIPTION
43 .Nm
44 is used to update a
45 .Nx
46 disk label from the Apple Partition Map found
47 on disks that were previously used on Mac OS systems (or
48 other APM using systems).
49 .Pp
50 .Nm
51 scans the APM contained in the first blocks of the disk and generates
52 additional partition entries for the disk from the entries found.
53 Driver and patches partitions are ignored.
54 .Pp
55 Each APM entry which does not have an equivalent partition in the
56 disk label (equivalent in having the same size and offset) is added to
57 the first free partition slot in the disk label.
58 A free partition slot is defined as one with an
59 .Dv fstype
61 .Sq Li unused
62 and a
63 .Dv size
64 of zero
65 .Pq Sq 0 .
66 If there are not enough free slots in the disk label, a warning
67 will be issued.
68 .Pp
69 The raw partition (typically partition
70 .Em c ,
71 but
72 .Em d
73 on i386 and some other platforms) is left alone during this process.
74 .Pp
75 By default, the proposed changed disk label will be displayed and no
76 disk label update will occur.
77 .Pp
78 Available options:
79 .Pp
80 .Bl -tag -width sX
81 .It Fl f
82 Force an update, even if there has been no change.
83 .It Fl q
84 Performs operations in a quiet fashion.
85 .It Fl r
86 In conjunction with
87 .Fl w ,
88 also update the on-disk label.
89 .It Fl w
90 Update the in-core label if it has been changed.
91 .El
92 .Sh SEE ALSO
93 .Xr disklabel 8 ,
94 .Xr dkctl 8 ,
95 .Xr pdisk 8
96 .Sh HISTORY
97 The
98 .Nm
99 command appeared in
100 .Nx 5.0 .