Update disklabel64.8:
[dragonfly.git] / sbin / disklabel64 / disklabel64.8
1 .\" Copyright (c) 1987, 1988, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Symmetric Computer Systems.
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 acknowledgment:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     @(#)disklabel.8 8.2 (Berkeley) 4/19/94
36 .\" $FreeBSD: src/sbin/disklabel/disklabel.8,v 1.15.2.22 2003/04/17 17:56:34 trhodes Exp $
37 .\" $DragonFly: src/sbin/disklabel64/disklabel64.8,v 1.8 2008/07/27 20:54:52 thomas Exp $
38 .\"
39 .Dd July 27, 2008
40 .Dt DISKLABEL64 8
41 .Os
42 .Sh NAME
43 .Nm disklabel64
44 .Nd read and write 64 bit disk pack label
45 .Sh SYNOPSIS
46 .Nm
47 .Op Fl r
48 .Ar disk
49 .Nm
50 .Fl w
51 .Op Fl r
52 .Op Fl n
53 .Ar disk Ar disktype/auto
54 .Oo Ar packid Oc
55 .Nm
56 .Fl e
57 .Op Fl r
58 .Op Fl n
59 .Ar disk
60 .Nm
61 .Fl R
62 .Op Fl r
63 .Op Fl n
64 .Ar disk Ar protofile
65 .Nm
66 .Op Fl NW
67 .Ar disk
68 .Pp
69 .Nm
70 .Fl B
71 .Oo
72 .Fl b Ar boot1
73 .Fl s Ar boot2
74 .Oc
75 .Ar disk
76 .Oo Ar disktype/auto Oc
77 .Nm
78 .Fl w
79 .Fl B
80 .Op Fl n
81 .Oo
82 .Fl b Ar boot1
83 .Fl s Ar boot2
84 .Oc
85 .Ar disk Ar disktype/auto
86 .Oo Ar packid Oc
87 .Nm
88 .Fl R
89 .Fl B
90 .Op Fl n
91 .Oo
92 .Fl b Ar boot1
93 .Fl s Ar boot2
94 .Oc
95 .Ar disk Ar protofile
96 .Oo Ar disktype/auto Oc
97 .Nm
98 .Fl f Ar slice_start_lba
99 .Oo Ar options Oc
100 .Sh DESCRIPTION
101 The
102 .Nm
103 utility
104 installs, examines or modifies a 64 bit label on a disk drive or pack.
105 When writing
106 the label, it can be used to change the drive identification, the disk
107 partitions on the drive, or to replace a damaged label.
108 There are several forms
109 of the command that read (display), install or edit the label on a disk.
110 In
111 addition,
112 .Nm
113 can install bootstrap code.
114 .Ss Raw or in-core label
115 The disk label resides close to or at the beginning of each disk slice.
116 For faster access, the kernel maintains a copy in core at all times.
117 By
118 default, most forms of the
119 .Nm
120 command access the in-core copy of the label.
121 To access the raw (on-disk)
122 copy, use the
123 .Fl r
124 option.
125 This option allows a label to be installed on a disk without kernel
126 support for a label, such as when labels are first installed on a system; it
127 must be used when first installing a label on a disk.
128 The specific effect of
129 .Fl r
130 is described under each command.
131 .Ss Disk device name
132 All
133 .Nm
134 forms require a disk device name, which should always be the raw
135 device name representing the disk or slice.
136 .Dx uses the following scheme for slice numbering:
137 If the disk doesn't use
138 .Xr gpt 8 ,
139 but e.g. MBR (typically laid out by
140 .Xr fdisk 8 ) ,
141 then slice 0, e.g.
142 .Pa da0s0 ,
143 represents the entire disk regardless of any DOS partitioning,
144 this is called the compatibility slice,
145 and slice 1 and onward, e.g.
146 .Pa da0s1 ,
147 represents a
148 .Bx
149 slice.
150 If the disk does use GPT (typically laid out by
151 .Xr gpt 8 ) ,
152 then all slices are
153 .Bx
154 slices, slice 0 isn't special, it is just the first slice on the disk.
155 You do not have to include the
156 .Pa /dev/
157 path prefix when specifying the device.
158 The
159 .Nm
160 utility will automatically prepend it.
161 .Ss Reading the disk label
162 To examine the label on a disk drive, use
163 .Nm
164 without options:
165 .Pp
166 .Nm
167 .Op Fl r
168 .Ar disk
169 .Pp
170 .Ar disk
171 represents the raw disk in question, and may be in the form
172 .Pa da0s1
173 or
174 .Pa /dev/da0s1 .
175 It will display all of the parameters associated with the drive and its
176 partition layout.
177 Unless the
178 .Fl r
179 flag is given,
180 the kernel's in-core copy of the label is displayed;
181 if the disk has no label, or the partition types on the disk are incorrect,
182 the kernel may have constructed or modified the label.
183 If the
184 .Fl r
185 flag is given,
186 .Nm
187 reads the label from the raw disk and displays it.
188 Both versions are usually
189 identical except in the case where a label has not yet been initialized or
190 is corrupt.
191 .Ss Writing a standard label
192 To write a standard label, use the form
193 .Pp
194 .Nm
195 .Fl w
196 .Op Fl r
197 .Op Fl n
198 .Ar disk Ar disktype/auto
199 .Oo Ar packid Oc
200 .Pp
201 .Nm
202 .Fl w
203 .Op Fl r
204 .Op Fl n
205 .Ar disk
206 auto
207 .Pp
208 The required arguments to
209 .Nm
210 are the drive to be labeled and the drive type as described in the
211 .Xr disktab 5
212 file.
213 The drive parameters and partitions are taken from that file.
214 If
215 different disks of the same physical type are to have different partitions, it
216 will be necessary to have separate disktab entries describing each, or to edit
217 the label after installation as described below.
218 The optional argument is a
219 pack identification string, up to 16 characters long.
220 The pack id must be
221 quoted if it contains blanks.
222 .Pp
223 If the
224 .Fl n
225 flag is given, no data will be written to the device, and instead the
226 disklabel that would have been written will be printed to stdout.
227 .Pp
228 If the
229 .Fl r
230 flag is given, the disk sectors containing the label and bootstrap
231 will be written directly.
232 A side-effect of this is that any existing bootstrap code will be overwritten
233 and the disk rendered unbootable.
234 See the boot options below for a method of
235 writing the label and the bootstrap at the same time.
236 If
237 .Fl r
238 is not specified,
239 the existing label will be updated via the in-core copy and any bootstrap
240 code will be unaffected.
241 If the disk does not already have a label, the
242 .Fl r
243 flag must be used.
244 In either case, the kernel's in-core label is replaced.
245 .Pp
246 For a virgin disk that is not known to
247 .Xr disktab 5 ,
248 .Ar disktype
249 can be specified as
250 .Dq auto .
251 In this case, the driver is requested to produce a virgin label for the
252 disk.
253 This might or might not be successful, depending on whether the
254 driver for the disk is able to get the required data without reading
255 anything from the disk at all.
256 It will likely succeed for all SCSI
257 disks, most IDE disks, and vnode devices.
258 Writing a label to the
259 disk is the only supported operation, and the
260 .Ar disk
261 itself must be provided as the canonical name, i.e.\& not as a full
262 path name.
263 .Pp
264 For most harddisks, a label based on percentages for most partitions (and
265 one partition with a size of
266 .Ql * )
267 will produce a reasonable configuration.
268 .Pp
269 PC-based systems have special requirements in order for the BIOS to properly
270 recognize a
271 .Dx
272 disklabel.
273 Older systems may require what is known as a
274 .Dq dangerously dedicated
275 disklabel, which creates a fake DOS partition to work around problems older
276 BIOSes have with modern disk geometries.
277 On newer systems you generally want
278 to create a normal DOS partition using
279 .Ar fdisk
280 and then create a
281 .Dx
282 disklabel within that slice.
283 This is described
284 later on in this page.
285 .Pp
286 Installing a new disklabel does not in of itself allow your system to boot
287 a kernel using that label.
288 You must also install boot blocks, which is
289 described later on in this manual page.
290 .Ss Editing an existing disk label
291 To edit an existing disk label, use the form
292 .Pp
293 .Nm
294 .Fl e
295 .Op Fl r
296 .Op Fl n
297 .Ar disk
298 .Pp
299 This command reads the label from the in-core kernel copy, or directly from the
300 disk if the
301 .Fl r
302 flag is also specified.
303 The label is written to a file in ASCII and then
304 supplied to an editor for changes.
305 If no editor is specified in an
306 .Ev EDITOR
307 environment variable,
308 .Xr vi 1
309 is used.
310 When the editor terminates, the label file is used to rewrite the disk
311 label.
312 Existing bootstrap code is unchanged regardless of whether
313 .Fl r
314 was specified.
315 If
316 .Fl n
317 is specified, no data will be written to the device, and instead the
318 disklabel that would have been written will be printed to stdout.
319 This is
320 useful to see how a partitioning scheme will work out for a specific disk.
321 .Ss Restoring a disk label from a file
322 To restore a disk label from a file, use the form
323 .Pp
324 .Nm
325 .Fl R
326 .Op Fl r
327 .Op Fl n
328 .Ar disk Ar protofile
329 .Pp
330 .Nm
331 is capable of restoring a disk label that was previously saved in a file
332 in ASCII format.
333 The prototype file used to create the label should be in the same format
334 as that produced when reading or editing a label.
335 Comments are delimited by
336 .Ar \&#
337 and newline.
338 As when writing a new label, any existing bootstrap code will be
339 clobbered if
340 .Fl r
341 is specified and will be unaffected otherwise.
342 See the boot options below for a
343 method of restoring the label and writing the bootstrap at the same time.
344 If
345 .Fl n
346 is used, no data will be written to the device, and instead the
347 disklabel that would have been written will be printed to stdout.
348 This is
349 useful to see how a partitioning scheme will work out for a specific disk.
350 .Ss Enabling and disabling writing to the disk label area
351 By default, it is not possible to write to the disk label area at the beginning
352 of a disk.
353 The disk driver arranges for
354 .Xr write 2
355 and similar system calls
356 to return
357 .Er EROFS
358 on any attempt to do so.
359 If you need
360 to write to this area (for example, to obliterate the label), use the form
361 .Pp
362 .Nm
363 .Fl W
364 .Ar disk
365 .Pp
366 To disallow writing to the label area after previously allowing it, use the
367 command
368 .Pp
369 .Nm
370 .Fl N
371 .Ar disk
372 .Ss Installing bootstraps
373 The final three forms of
374 .Nm
375 are used to install bootstrap code.
376 If you are creating a
377 .Dq dangerously-dedicated
378 slice for compatibility with older PC systems,
379 you generally want to specify the compatibility slice, such as
380 .Pa da0s0 .
381 If you are creating a label within an existing DOS slice,
382 you should specify
383 the slice name such as
384 .Pa da0s1 .
385 Making a slice bootable can be tricky.
386 If you are using a normal DOS
387 slice you typically install (or leave) a standard MBR on the base disk and
388 then install the
389 .Dx
390 bootblocks in the slice.
391 .Pp
392 .Nm
393 .Fl B
394 .Oo
395 .Fl b Ar boot1
396 .Fl s Ar boot2
397 .Oc
398 .Ar disk
399 .Oo Ar disktype Oc
400 .Pp
401 This form installs the bootstrap only.
402 It does not change the disk label.
403 You should never use this command on the compatibility slice unless you
404 intend to create a
405 .Dq dangerously-dedicated
406 disk, such as
407 .Ar da0s0 .
408 This command is typically run on a
409 .Bx
410 slice such as
411 .Ar da0s1 .
412 .Pp
413 .Nm
414 .Fl w
415 .Fl B
416 .Op Fl n
417 .Oo
418 .Fl b Ar boot1
419 .Fl s Ar boot2
420 .Oc
421 .Ar disk Ar disktype
422 .Oo Ar packid Oc
423 .Pp
424 This form corresponds to the
425 .Dq write label
426 command described above.
427 In addition to writing a new volume label, it also installs the bootstrap.
428 If run on the compatibility slice this command will create a
429 .Dq dangerously-dedicated
430 label.
431 This command is normally run on a
432 .Bx
433 slice rather than the compatibility
434 slice.
435 If
436 .Fl n
437 is used, no data will be written to the device, and instead the
438 disklabel that would have been written will be printed to stdout.
439 .Pp
440 .Nm
441 .Fl R
442 .Fl B
443 .Op Fl n
444 .Oo
445 .Fl b Ar boot1
446 .Fl s Ar boot2
447 .Oc
448 .Ar disk Ar protofile
449 .Oo Ar disktype Oc
450 .Pp
451 This form corresponds to the
452 .Dq restore label
453 command described above.
454 In addition to restoring the volume label, it also installs the bootstrap.
455 If run on the compatibility slice this command will create a
456 .Dq dangerously-dedicated
457 label.
458 This command is normally run on a
459 .Bx
460 slice rather than the compatibility
461 slice.
462 .Pp
463 The bootstrap commands always access the disk directly, so it is not necessary
464 to specify the
465 .Fl r
466 flag.
467 If
468 .Fl n
469 is used, no data will be written to the device, and instead the
470 disklabel that would have been written will be printed to stdout.
471 .Pp
472 The bootstrap code is comprised of two boot programs.
473 Specify the name of the
474 boot programs to be installed in one of these ways:
475 .Bl -enum
476 .It
477 Specify the names explicitly with the
478 .Fl b
479 and
480 .Fl s
481 flags.
482 .Fl b
483 indicates the primary boot program and
484 .Fl s
485 the secondary boot program.
486 The boot programs are located in
487 .Pa /boot .
488 .It
489 If the
490 .Fl b
491 and
492 .Fl s
493 flags are not specified, but
494 .Ar disktype
495 was specified, the names of the programs are taken from the
496 .Dq b0
497 and
498 .Dq b1
499 parameters of the
500 .Xr disktab 5
501 entry for the disk if the disktab entry exists and includes those parameters.
502 .It
503 Otherwise, the default boot image names are used:
504 .Pa /boot/boot1
505 and
506 .Pa /boot/boot2
507 for the standard stage1 and stage2 boot images.
508 .El
509 .Ss Initializing/Formatting a bootable disk from scratch
510 To initialize a disk from scratch the following sequence is recommended.
511 Please note that this will wipe everything that was previously on the disk,
512 including any
513 .No non- Ns Dx
514 slices.
515 .Bl -enum
516 .It
517 Use
518 .Xr fdisk 8
519 to initialize the hard disk, and create a slice table, referred to
520 as the
521 .Dq "partition table"
522 in
523 .Tn DOS .
524 .It
525 Use
526 .Nm
527 to define partitions on
528 .Dx
529 slices created in the previous step.
530 .It
531 Finally use
532 .Xr newfs 8
533 to create file systems on new partitions.
534 .El
535 .Pp
536 A typical partitioning scheme would be to have an
537 .Ql a
538 partition
539 of approximately 512MB to hold the root file system, a
540 .Ql b
541 partition for
542 swap (usually 4GB), a
543 .Ql d
544 partition for
545 .Pa /var
546 (usually 2GB), an
547 .Ql e
548 partition
549 for
550 .Pa /var/tmp
551 (usually 2GB), an
552 .Ql f
553 partition for
554 .Pa /usr
555 (usually around 4GB),
556 and finally a
557 .Ql g
558 partition for
559 .Pa /home
560 (usually all remaining space).
561 Your mileage may vary.
562 .Pp
563 .Nm fdisk Fl BI Pa da0
564 .Pp
565 .Nm
566 .Fl w B
567 .Pa da0s1
568 .Cm auto
569 .Pp
570 .Nm
571 .Fl e
572 .Pa da0s1
573 .Sh FILES
574 .Bl -tag -width ".Pa /etc/disktab" -compact
575 .It Pa /boot/boot1
576 Default stage1 boot image.
577 .It Pa /boot/boot2
578 Default stage2 boot image.
579 .It Pa /etc/disktab
580 Disk description file.
581 .El
582 .Sh SAVED FILE FORMAT
583 The
584 .Nm
585 utility
586 uses an
587 .Tn ASCII
588 version of the label when examining, editing, or restoring a disk
589 label.
590 The format is:
591 .Bd -literal -offset 4n
592 # /dev/ad4s4:
593 #
594 # Informational fields calculated from the above
595 # All byte equivalent offsets must be aligned
596 #
597 # boot space:      32768 bytes
598 # data space:  121790552 blocks # 118936.09 MB (124713525248 bytes)
599 #
600 diskid: 5e3ef4db-4e24-11dd-8318-010e0cd0bad1
601 label:
602 boot2 data base:      0x000000001000
603 partitions data base: 0x000000009000
604 partitions data stop: 0x001d0981f000
605 backup label:         0x001d0981f000
606 total size:           0x001d09820000    # 118936.12 MB
607 alignment: 4096
608 display block size: 1024        # for partition display only
609
610 16 partitions:
611 #          size     offset    fstype   fsuuid
612   a:     524288          0    4.2BSD    #     512.000MB
613   b:    4194304     524288      swap    #    4096.000MB
614   d:    2097152    4718592    4.2BSD    #    2048.000MB
615   e:    2097152    6815744    4.2BSD    #    2048.000MB
616   f:    4194304    8912896    4.2BSD    #    4096.000MB
617   g:    4194304   13107200    4.2BSD    #    4096.000MB
618   h:   94003288   17301504    HAMMER    #   91800.086MB
619   i:    5242880  111304792       ccd    #    5120.000MB
620   j:    5242880  116547672     vinum    #    5120.000MB
621   a-stor_uuid: 4370efdb-4e25-11dd-8318-010e0cd0bad1
622   b-stor_uuid: 4370eff4-4e25-11dd-8318-010e0cd0bad1
623   d-stor_uuid: 4370f00b-4e25-11dd-8318-010e0cd0bad1
624   e-stor_uuid: 4370f024-4e25-11dd-8318-010e0cd0bad1
625   f-stor_uuid: 4370f03a-4e25-11dd-8318-010e0cd0bad1
626   g-stor_uuid: 4370f053-4e25-11dd-8318-010e0cd0bad1
627   h-stor_uuid: 4370f06a-4e25-11dd-8318-010e0cd0bad1
628   i-stor_uuid: 4370f083-4e25-11dd-8318-010e0cd0bad1
629   j-stor_uuid: 4370f099-4e25-11dd-8318-010e0cd0bad1
630 .Ed
631 .Pp
632 Lines starting with a
633 .Ql #
634 mark are comments.
635 The specifications which can be changed are:
636 .Bl -inset
637 .It Ar label
638 is an optional label, set by the
639 .Ar packid
640 option when writing a label.
641 .It Ar "the partition table"
642 is the
643 .Ux
644 partition table, not the
645 .Tn DOS
646 partition table described in
647 .Xr fdisk 8 .
648 .El
649 .Pp
650 The partition table can have up to 16 entries.
651 It contains the following information:
652 .Bl -tag -width indent
653 .It Ar #
654 The partition identifier is a single letter in the range
655 .Ql a
656 to
657 .Ql p .
658 By convention, partition
659 .Ql c
660 is reserved to describe the entire disk.
661 .It Ar size
662 The size of the partition in sectors,
663 .Cm K
664 (kilobytes - 1024),
665 .Cm M
666 (megabytes - 1024*1024),
667 .Cm G
668 (gigabytes - 1024*1024*1024),
669 .Cm %
670 (percentage of free space
671 .Em after
672 removing any fixed-size partitions),
673 .Cm *
674 (all remaining free space
675 .Em after
676 fixed-size and percentage partitions).
677 Lowercase versions of
678 .Cm K , M ,
679 and
680 .Cm G
681 are allowed.
682 Size and type should be specified without any spaces between them.
683 .Pp
684 Example: 2097152, 1G, 1024M and 1048576K are all the same size
685 (assuming 512-byte sectors).
686 .It Ar offset
687 The offset of the start of the partition from the beginning of the
688 drive in sectors, or
689 .Cm *
690 to have
691 .Nm
692 calculate the correct offset to use (the end of the previous partition plus
693 one.
694 .It Ar fstype
695 Describes the purpose of the partition.
696 The example shows all currently used partition types.
697 For
698 .Tn UFS
699 file systems, use type
700 .Cm 4.2BSD .
701 For
702 .Xr HAMMER 5
703 file systems, use type
704 .Cm HAMMER .
705 For
706 .Xr ccd 4
707 partitions, use type
708 .Cm ccd .
709 For Vinum drives, use type
710 .Cm vinum .
711 Other common types are
712 .Cm swap
713 and
714 .Cm unused .
715 The
716 .Nm
717 utility
718 also knows about a number of other partition types,
719 none of which are in current use.
720 (See
721 .Dv fstypenames
722 in
723 .In sys/dtype.h
724 for more details).
725 .El
726 .Pp
727 The remainder of the line is a comment and shows the size of the partition
728 in MB.
729 .Pp
730 .Dx
731 no longer snoop-adjusts the on-disklabel when reading or writing
732 raw labels.
733 .Nm
734 is now responsible for adjusting the label when operating in raw mode.
735 Traditional (32 bit
736 .Bx )
737 disklabels store offsets as absolute block numbers
738 rather than slice-relative block numbers.
739 If
740 .Nm
741 is unable to issue the
742 .Dv DIOCGPART
743 ioctl to get slice information it will
744 refuse to read or write the label in raw mode.
745 The
746 .Fl f
747 option may be used to force the operation by supplying a manual offset.
748 .Sh EXAMPLES
749 .Dl "disklabel64 da0s1"
750 .Pp
751 Display the in-core label for the first slice of the
752 .Pa da0
753 disk, as obtained via
754 .Pa /dev/da0s1 .
755 (If the disk is
756 .Dq dangerously-dedicated ,
757 the compatibility slice name should be specified, such as
758 .Pa da0s0 . )
759 .Pp
760 .Dl "disklabel64 da0s1 > savedlabel"
761 .Pp
762 Save the in-core label for
763 .Pa da0s1
764 into the file
765 .Pa savedlabel .
766 This file can be used with the
767 .Fl R
768 option to restore the label at a later date.
769 .Pp
770 .Dl "disklabel64 -w -r /dev/da0s1 da2212 foo"
771 .Pp
772 Create a label for
773 .Pa da0s1
774 based on information for
775 .Dq da2212
776 found in
777 .Pa /etc/disktab .
778 Any existing bootstrap code will be clobbered
779 and the disk rendered unbootable.
780 .Pp
781 .Dl "disklabel64 -e -r da0s1"
782 .Pp
783 Read the on-disk label for
784 .Pa da0s1 ,
785 edit it, and reinstall in-core as well as on-disk.
786 Existing bootstrap code is unaffected.
787 .Pp
788 .Dl "disklabel64 -e -r -n da0s1"
789 .Pp
790 Read the on-disk label for
791 .Pa da0s1 ,
792 edit it, and display what the new label would be (in sectors).
793 It does
794 .Em not
795 install the new label either in-core or on-disk.
796 .Pp
797 .Dl "disklabel64 -r -w da0s1 auto"
798 .Pp
799 Try to auto-detect the required information from
800 .Pa da0s1 ,
801 and write a new label to the disk.
802 Use another
803 .Nm Fl e
804 command to edit the
805 partitioning and file system information.
806 .Pp
807 .Dl "disklabel64 -R da0s1 savedlabel"
808 .Pp
809 Restore the on-disk and in-core label for
810 .Pa da0s1
811 from information in
812 .Pa savedlabel .
813 Existing bootstrap code is unaffected.
814 .Pp
815 .Dl "disklabel64 -R -n da0s1 label_layout"
816 .Pp
817 Display what the label would be for
818 .Pa da0s1
819 using the partition layout in
820 .Pa label_layout .
821 This is useful for determining how much space would be allotted for various
822 partitions with a labelling scheme using
823 .Cm % Ns -based
824 or
825 .Cm *
826 partition sizes.
827 .Pp
828 .Dl disklabel64 -B da0s1
829 .Pp
830 Install a new bootstrap on
831 .Pa da0s1 .
832 The boot code comes from
833 .Pa /boot/boot1
834 and possibly
835 .Pa /boot/boot2 .
836 On-disk and in-core labels are unchanged.
837 .Pp
838 .Dl disklabel64 -w -B /dev/da0s1 -b newboot1 -s newboot2 da2212
839 .Pp
840 Install a new label and bootstrap.
841 The label is derived from disktab information for
842 .Dq da2212
843 and installed both in-core and on-disk.
844 The bootstrap code comes from the files
845 .Pa /boot/newboot1
846 and
847 .Pa /boot/newboot2 .
848 .Pp
849 .Dl dd if=/dev/zero of=/dev/da0 bs=512 count=32
850 .Dl fdisk -BI da0
851 .Dl dd if=/dev/zero of=/dev/da0s1 bs=512 count=32
852 .Dl disklabel64 -w -B da0s1 auto
853 .Dl disklabel64 -e da0s1
854 .Pp
855 Completely wipe any prior information on the disk, creating a new bootable
856 disk with a DOS partition table containing one
857 .Dq whole-disk
858 slice.
859 Then
860 initialize the slice, then edit it to your needs.
861 The
862 .Pa dd
863 commands are optional, but may be necessary for some BIOSes to properly
864 recognize the disk.
865 .Pp
866 This is an example disklabel that uses some of the new partition size types
867 such as
868 .Cm % , M , G ,
869 and
870 .Cm * ,
871 which could be used as a source file for
872 .Pp
873 .Dl disklabel64 -R ad0s1 new_label_file
874 .Bd -literal -offset 4n
875 # /dev/ad4s4:
876 #
877 # Informational fields calculated from the above
878 # All byte equivalent offsets must be aligned
879 #
880 # boot space:      32768 bytes
881 # data space:  121790552 blocks # 118936.09 MB (124713525248 bytes)
882 #
883 diskid: b1db58a3-4e26-11dd-8318-010e0cd0bad1
884 label:
885 boot2 data base:      0x000000001000
886 partitions data base: 0x000000009000
887 partitions data stop: 0x001d0981f000
888 backup label:         0x001d0981f000
889 total size:           0x001d09820000    # 118936.12 MB
890 alignment: 4096
891 display block size: 1024        # for partition display only
892
893 16 partitions:
894 #          size     offset    fstype   fsuuid
895   a:       512M          0    4.2BSD
896   b:         4G          *      swap
897   d:         2G          *    4.2BSD
898   e:      2048M          *    4.2BSD
899   f:         4G          *    4.2BSD
900   g:         4G          *    4.2BSD
901   h:          *          *    HAMMER
902   i:         5g          *       ccd
903   j:      5120m          *     vinum
904 .Ed
905 .Sh DIAGNOSTICS
906 The kernel device drivers will not allow the size of a disk partition
907 to be decreased or the offset of a partition to be changed while it is open.
908 Some device drivers create a label containing only a single large partition
909 if a disk is unlabeled; thus, the label must be written to the
910 .Dq a
911 partition of the disk while it is open.
912 This sometimes requires the desired
913 label to be set in two steps, the first one creating at least one other
914 partition, and the second setting the label on the new partition while
915 shrinking the
916 .Dq a
917 partition.
918 .Pp
919 On some machines the bootstrap code may not fit entirely in the area
920 allocated for it by some file systems.
921 As a result, it may not be possible to have file systems on some partitions
922 of a
923 .Dq bootable
924 disk.
925 When installing bootstrap code,
926 .Nm
927 checks for these cases.
928 If the installed boot code would overlap a partition of type
929 .Dv FS_UNUSED
930 it is marked as type
931 .Dv FS_BOOT .
932 The
933 .Xr newfs 8
934 utility will disallow creation of file systems on
935 .Dv FS_BOOT
936 partitions.
937 Conversely, if a partition has a type other than
938 .Dv FS_UNUSED
939 or
940 .Dv FS_BOOT ,
941 .Nm
942 will not install bootstrap code that overlaps it.
943 .Sh SEE ALSO
944 .Xr uuid 3 ,
945 .Xr ccd 4 ,
946 .Xr disklabel64 5 ,
947 .Xr disktab 5 ,
948 .Xr boot0cfg 8 ,
949 .Xr diskinfo 8 ,
950 .Xr disklabel 8 ,
951 .Xr fdisk 8 ,
952 .Xr gpt 8 ,
953 .Xr vinum 8
954 .Sh BUGS
955 Installing a
956 .Xr disklabel 8
957 label on a slice with a
958 .Nm
959 label installed requires reboot. First the existing label
960 has to be overwritten, eg. by
961 .Xr dd 1 ,
962 see above, then a reboot is required before the new label can be installed.
963 .Pp
964 For the i386 architecture, the primary bootstrap sector contains
965 an embedded
966 .Em fdisk
967 table.
968 The
969 .Nm
970 utility takes care to not clobber it when installing a bootstrap only
971 .Pq Fl B ,
972 or when editing an existing label
973 .Pq Fl e ,
974 but it unconditionally writes the primary bootstrap program onto
975 the disk for
976 .Fl w
977 or
978 .Fl R ,
979 thus replacing the
980 .Em fdisk
981 table by the dummy one in the bootstrap program.
982 This is only of
983 concern if the disk is fully dedicated, so that the
984 .Bx
985 disklabel
986 starts at absolute block 0 on the disk.
987 .Pp
988 The
989 .Nm
990 utility
991 does not perform all possible error checking.
992 Warning
993 .Em is
994 given if partitions
995 overlap; if an absolute offset does not match the expected offset;
996 if a
997 partition runs past the end of the device; and a number of other errors; but
998 no warning is given if space remains unused.
999 .Pp
1000 .Dx
1001 doesn't support booting from
1002 .Nm
1003 partitions.