add .Mt to man pages in usr.sbin/
[dragonfly.git] / usr.sbin / burncd / burncd.8
1 .\"
2 .\" Copyright (c) 2000,2001,2002 Søren Schmidt <sos@FreeBSD.org>
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer,
10 .\"    without modification, immediately at the beginning of the file.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. The name of the author may not be used to endorse or promote products
15 .\"    derived from this software without specific prior written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD: src/usr.sbin/burncd/burncd.8,v 1.6.2.8 2003/03/12 22:08:13 trhodes Exp $
29 .\"
30 .Dd December 4, 2001
31 .Dt BURNCD 8
32 .Os
33 .Sh NAME
34 .Nm burncd
35 .Nd control the ATAPI CD-R/RW driver
36 .Sh SYNOPSIS
37 .Nm
38 .Op Fl delmnpqtv
39 .Op Fl f Ar device
40 .Op Fl s Ar speed
41 .Op Ar command
42 .Op Ar command Ar
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility is used to burn CD-R/RW media using the ATAPI cd driver.
47 .Pp
48 Available options and operands:
49 .Bl -tag -width XXXXXXXXXXXX
50 .It Fl d
51 burn the CD-R/RW in DAO (disk at once) mode.
52 .It Fl e
53 eject the media when done.
54 .It Fl f Ar device
55 set the device to use for the burning process.
56 .It Fl l
57 read a list of image files from filename.
58 .It Fl m
59 close disk in multisession mode (otherwise disk is closed as singlesession).
60 .It Fl n
61 do not write gaps between data tracks in DAO mode.
62 .It Fl p
63 use preemphasis on audio tracks.
64 .It Fl q
65 quiet, do not print progress messages.
66 .It Fl s Ar speed
67 set the speed of the burner device.
68 Defaults to 1.
69 Specify
70 .Dq Li max
71 to use the drive's fastest speed.
72 .It Fl t
73 test write, do not actually write on the media.
74 .It Fl v
75 verbose, print extra progress messages.
76 .El
77 .Pp
78 .Ar command
79 may be one of:
80 .Bl -tag -width XXXXXXXXXXXX
81 .It Cm msinfo
82 Show the first LBA of the last track on the media
83 and the next writeable address on the media for use with the
84 .Xr mkisofs 8 Ns 's
85 .Fl C
86 switch when adding additional data to ISO file systems with extra sessions.
87 .It Cm blank
88 Blank a CD-RW medium.
89 This uses the fast blanking method, so data are not physically overwritten,
90 only those areas that make the media appear blank for further usage are erased.
91 .It Cm erase
92 Erase a CD-RW medium.
93 This erases the entire media.
94 Can take up to 1 hour to finish.
95 .It Cm fixate
96 Fixate the medium so that the TOC is generated and the media can be used
97 in an ordinary CD drive.
98 The driver defaults to creating singlesession media (see
99 .Fl m
100 option).
101 Should be the last command to
102 .Nm
103 as the program exits when this has been done.
104 Ignored in DAO mode (see
105 .Fl d
106 option).
107 .It Cm raw | audio
108 Set the write mode to produce audio (raw mode) tracks for the following
109 images on the command line.
110 .It Cm data | mode1
111 Set the write mode to produce data (mode1) tracks for the following
112 image files
113 on the command line.
114 .It Cm mode2
115 Set the write mode to produce data (mode2) tracks for the following
116 image files
117 on the command line.
118 .It Cm XAmode1
119 Set the write mode to produce data (XAmode1) tracks for the following image
120 files on the command line.
121 .It Cm XAmode2
122 Set the write mode to produce data (XAmode2) tracks for the following image
123 files on the command line.
124 .It Cm vcd
125 Set the write mode to produce VCD/SVCD tracks for the following image files
126 on the command line.
127 This automatically sets DAO
128 .Pq Fl d
129 and
130 .Dq "no gaps"
131 .Pq Fl n
132 modes.
133 .It Ar file
134 All other arguments are treated as filenames of images to write to the media,
135 or in case the
136 .Fl l
137 option is used as files containing lists of images.
138 .El
139 .Pp
140 Files whose length are not a multiple of the current media blocksize are
141 quietly zero padded to fit the blocksize requirement.
142 The conventional filename
143 .Fl
144 refers to stdin, and can only be used once.
145 .Sh EXAMPLES
146 The typical usage for burning a data CD-R:
147 .Pp
148 .Dl "burncd -f /dev/acd0c data file1 fixate"
149 .Pp
150 The typical usage for burning an audio CD-R:
151 .Pp
152 .Dl "burncd -f /dev/acd0c audio file1 file2 file3 fixate"
153 .Pp
154 The typical usage for burning an audio CD-R in DAO mode:
155 .Pp
156 .Dl "burncd -f /dev/acd0c -d audio file1 file2 file3"
157 .Pp
158 The typical usage for burning a mixed mode CD-R:
159 .Pp
160 .Dl "burncd -f /dev/acd0c data file1 audio file2 file3 fixate"
161 .Pp
162 The typical usage for burning from a compressed image file on stdin:
163 .Pp
164 .Dl "gunzip -c file.iso.gz | burncd -f /dev/acd0c data - fixate"
165 .Pp
166 In the examples above, the files burned to data CD-Rs are assumed to
167 be ISO9660 file systems.
168 .Xr mkisofs 8 ,
169 available in the
170 .Xr dports 7
171 collection, is commonly used to create ISO9660 file system images
172 from a given directory tree.
173 .Sh HISTORY
174 The
175 .Nm
176 utility appeared in
177 .Fx 4.0 .
178 .Sh AUTHORS
179 The
180 .Nm
181 utility and this manpage was contributed by
182 .An S\(/oren Schmidt Aq Mt sos@FreeBSD.org ,
183 Denmark.
184 .Sh BUGS
185 Probably, please report when found.