date and time created 90/11/08 20:02:59 by bill
[unix-history] / .ref-BSD-3 / usr / man / man5 / dump.5
CommitLineData
65824f48
BJ
1.TH DUMP 5
2.SH NAME
3dump, ddate \- incremental dump format
4.SH SYNOPSIS
5.B #include <sys/types.h>
6.br
7.B #include <sys/ino.h>
8.br
9.B # include <dumprestor.h>
10.SH DESCRIPTION
11Tapes used by
12.I dump
13and
14.IR restor (1)
15contain:
16.nf
17.IP ""
18a header record
19two groups of bit map records
20a group of records describing directories
21a group of records describing files
22.fi
23.PP
24The format of the header record and of the first
25record of each description as given in the
26include file
27.I <dumprestor.h>
28is:
29.PP
30.nf
31.ta .5i \w'#define\ TS_INODE\ 'u
32.so /usr/include/dumprestor.h
33.fi
34.PP
35.I NTREC
36is the number of 1024 byte records in a physical
37tape block.
38.I MLEN
39is the number of bits in a bit map word.
40.I MSIZ
41is the number of bit map words.
42.PP
43The
44.I TS_
45entries are used in the
46.I c_type
47field to indicate what sort of header
48this is.
49The types and their meanings are as follows:
50.TP \w'CHECKSUM\|'u
51TS_TAPE
52Tape volume label
53.PD 0
54.TP
55TS_INODE
56A file or directory follows.
57The
58.I c_dinode
59field is a copy of the disk inode and contains
60bits telling what sort of file this is.
61.TP
62TS_BITS
63A bit map follows.
64This bit map has a one bit
65for each inode that was dumped.
66.TP
67TS_ADDR
68A subrecord of a file description.
69See
70.I c_addr
71below.
72.TP
73TS_END
74End of tape record.
75.TP
76TS_CLRI
77A bit map follows.
78This bit map contains a zero bit for
79all inodes that were empty on the file system when dumped.
80.TP
81MAGIC
82All header records have this number in
83.I c_magic.
84.TP
85CHECKSUM
86Header records checksum to this value.
87.PD
88.PP
89The fields of the header structure are as follows:
90.TP \w'TS_INODE\ 'u
91c_type
92The type of the header.
93.PD 0
94.TP
95c_date
96The date the dump was taken.
97.TP
98c_ddate
99The date the file system was dumped from.
100.TP
101c_volume
102The current volume number of the dump.
103.TP
104c_tapea
105The current number of this (1024-byte) record.
106.TP
107c_inumber
108The number of the inode being dumped if this
109is of type
110.I TS_INODE.
111.TP
112c_magic
113This contains the value
114.I MAGIC
115above, truncated as needed.
116.TP
117c_checksum
118This contains whatever value is needed to
119make the record sum to
120.I CHECKSUM.
121.TP
122c_dinode
123This is a copy of the inode as it appears on the
124file system; see
125.IR filsys (5).
126.TP
127c_count
128The count of characters in
129.I c_addr.
130.TP
131c_addr
132An array of characters describing the blocks of the
133dumped file.
134A character is zero if the block associated with that character was not
135present on the file system, otherwise the character is non-zero.
136If the block was not present on the file system, no block was dumped;
137the block will be restored as a hole in the file.
138If there is not sufficient space in this record to describe
139all of the blocks in a file,
140.I TS_ADDR
141records will be scattered through the file, each one
142picking up where the last left off.
143.PD
144.PP
145Each volume except the last ends with a tapemark (read as an end
146of file).
147The last volume ends with a
148.I TS_END
149record and then the tapemark.
150.PP
151The structure
152.I idates
153describes an entry of the file
154.I /etc/ddate
155where dump history is kept.
156The fields of the structure are:
157.TP \w'TS_INODE\ 'u
158id_name
159The dumped filesystem is
160.RI `/dev/ id_nam'.
161.PD 0
162.TP
163id_incno
164The level number of the dump tape;
165see
166.IR dump (1).
167.TP
168id_ddate
169The date of the incremental dump in system format
170see
171.IR types (5).
172.PD
173.SH FILES
174/etc/ddate
175.SH "SEE ALSO"
176dump(1), dumpdir(1), restor(1), filsys(5), types(5)