Expand PMF_FN_* macros.
[netbsd-mini2440.git] / usr.sbin / mmcformat / mmcformat.8
bloba357c1163185c8ee8566942e7893212bc738f648
1 .\" $NetBSD: mmcformat.8,v 1.3 2008/11/04 19:43:04 wiz Exp $
2 .\"
3 .\" Copyright (c) 2008 Reinoud Zandijk
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in
13 .\"    the documentation and/or other materials provided with the
14 .\"    distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
17 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY
20 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
22 .\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
24 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
25 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
26 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 .\"
28 .\"
29 .Dd May 9, 2008
30 .Dt MMCFORMAT 8
31 .Os
32 .Sh NAME
33 .Nm mmcformat
34 .Nd format optical media
35 .Sh SYNOPSIS
36 .Nm
37 .Op Fl BDFGHhIMOpRrSsw
38 .Op Fl b Ar blockingnr
39 .Op Fl c Ar cert-num
40 .\" .Op X format is not implemented yet
41 .Ar special
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility formats optical media conforming to the MMC standard.
46 This includes CD, DVD, and Blu-Ray (BD) media.
47 .Pp
48 The options are as follows:
49 .Bl -tag -width XbXblockingnrXX
50 .It Fl B
51 Blank media when possible before formatting it.
52 .It Fl b Ar blockingnr
53 Explicitly select packet size in sectors
54 .Pq for CD-RW only .
55 It is not recommended to change this from its default of 32.
56 .It Fl c Ar cert-num
57 Certify media for DVD-RAM / DV-RE.
58 The argument cert-num specifies:
59 .Bl -tag -offset indent
60 .It 0
61 no certification
62 .It 1
63 full certification
64 .It 2
65 quick certification
66 .El
67 .It Fl D
68 Debug mode.
69 Print all SCSI/ATAPI command errors.
70 .It Fl F
71 Format media.
72 .It Fl G
73 Grow last CD-RW/DVD-RW session.
74 .It Fl H
75 Show help and print formatting choices for the inserted media.
76 .It Fl h
77 Show help and print formatting choices for the inserted media.
78 .It Fl I
79 Show help and print formatting choices for the inserted media.
80 .It Fl M
81 Select MRW (Mount Rainier) error correcting background format.
82 .It Fl O
83 Old style CD-RW formatting; recommended for CD-RW.
84 .It Fl p
85 Explicitly set packet format.
86 .It Fl R
87 Restart previously stopped MCD-MRW or DVD+RW background format.
88 .It Fl r
89 Recompile defect list for DVD-RAM.
90 .It Fl S
91 Grow spare space DVD-RAM / BD-RE.
92 .It Fl s
93 Format DVD+MRW / BD-RE with extra spare space.
94 .It Fl w
95 Wait until completion of background format.
96 .El
97 .Sh NOTES
98 Due to the enormous varieties in optical media,
99 .Nm
100 is made as generic as possible.
101 This can result in confusion.
102 .Sh EXAMPLES
103 .Dl Ic mmcformat -B -O /dev/rcd0d
105 Blanks and then formats a CD-RW disc using the
106 .Dq old style
107 format command.
108 It is recommended to use this
109 .Dq old style
110 command unless your drive reports that it's not supported; in that case, resort
111 to the default
112 .Fl F .
113 Note that a CD-RW disc can be reformatted without being blanked.
114 Blanking switches between sequential and fixed packet writing by
115 erasing the disc.
116 This can also help to revive old discs.
118 .Dl Ic mmcformat -F -M /dev/rcd0d
120 Format a CD-RW or a DVD+RW to use MRW (Mount Rainier).
121 This format tries to hide media flaws as much as possible by
122 relocation.
123 .Sh SEE ALSO
124 .Xr scsictl 8
125 .Sh HISTORY
128 command first appeared in
129 .Nx 5.0 .
130 .Sh AUTHORS
131 .An Reinoud Zandijk Aq reinoud@NetBSD.org
132 .Sh BUGS
134 could be merged with
135 .Xr scsictl 8
136 but that tool is very hard disk oriented.