BSD 4_3_Net_2 release
[unix-history] / usr / src / usr.bin / cpio / cpioformat.5
index 412870c..1757c3c 100644 (file)
-.\"    @(#)cpio_format.5       5.2 (Berkeley) 3/29/88
+.\" Copyright 1991 The Regents of the University of California.
+.\" All rights reserved.
 .\"
 .\"
-.TH CPIO 5 "March 29, 1988"
-.UC 7
-.SH NAME
-cpio - format of cpio archive
-.SH DESCRIPTION
-The header structure, when the -c option of cpio(1) is not used, is:
-.sp 1
-.nf
-       struct {
-               short   h_magic,
-                               h_dev;
-               ushort  h_ino,
-                               h_mode,
-                               h_uid,
-                               h_gid;
-               short   h_nlink,
-                               h_rdev,
-                               h_mtime[2],
-                               h_namesize,
-                               h_filesize[2];
-               char    h_name[h_namesize rounded to word];
-       } Hdr;
-.sp 2
-When the -c option is used, the header information is described by:
-.sp
-       sscanf(Chdr,"%6o%6o%6o%6o%6o%6o%6o%6o%11lo%6o%11lo%s",
-               &Hdr.h_magic, &Hdr.h_dev, &Hdr.h_ino, &Hdr.h_mode,
-               &Hdr.h_uid, &Hdr.h_gid, &Hdr.h_nlink, &Hdr.h_rdev,
-               &Longtime, &Hdr.h_namesize,&Longfile,Hdr.h_name);
-.fi
-.sp
-Longtime and Longfile are equivalent to Hdr.h_mtime and
-Hdr.h_filesize, respectively.  The contents of each file are
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)cpioformat.5       5.3 (Berkeley) 5/10/91
+.\"
+.Dd May 10, 1991
+.Dt CPIO 5
+.Os
+.Sh NAME
+.Nm cpio
+.Nd format of cpio archive
+.Sh DESCRIPTION
+The header structure, when the
+.Fl c
+option of
+.Xr cpio 1
+is not used, is:
+.Bd -literal -offset indent
+struct {
+       short   h_magic,
+               h_dev;
+       ushort  h_ino,
+               h_mode,
+               h_uid,
+               h_gid;
+       short   h_nlink,
+               h_rdev,
+               h_mtime[2],
+               h_namesize,
+               h_filesize[2];
+       char    h_name[h_namesize rounded to word];
+} Hdr;
+.Ed
+.Pp
+When the
+.Fl c
+option is used, the header information is described by:
+.Bd -literal -offset indent
+sscanf(Chdr,"%6o%6o%6o%6o%6o%6o%6o%6o%11lo%6o%11lo%s",
+&Hdr.h_magic, &Hdr.h_dev, &Hdr.h_ino, &Hdr.h_mode,
+&Hdr.h_uid, &Hdr.h_gid, &Hdr.h_nlink, &Hdr.h_rdev,
+&Longtime, &Hdr.h_namesize,&Longfile,Hdr.h_name);
+.Ed
+.Pp
+.Fa Longtime
+and
+.Fa Longfile
+are equivalent to
+.Fa Hdr.h_mtime
+and
+.Fa Hdr.h_filesize ,
+respectively.
+The contents of each file are
 recorded in an element of the array of varying lenght
 structures, archive, together with other items describing
 recorded in an element of the array of varying lenght
 structures, archive, together with other items describing
-the file.  Every instance of h_magic contains the constant
-070707 (octal).  The itimes h_dev through h_mtime have
-meanings explained in stat(2).  The length of the null-
-terminated path name H_name, icluding the null byte, is
-given by h_namesize.
-.sp
+the file.
+Every instance of
+.Fa h_magic
+contains the constant
+070707 (octal).
+The itimes
+.Fa h_dev
+through
+.Fa h_mtime
+have
+meanings explained in
+.Xr stat 2 .
+The length of the null-terminated path name
+.Fa H_name ,
+icluding the null byte, is
+given by
+.Fa h_namesize .
+.Pp
 The last record of the archive always contains the name
 TRAILER!!!.  Special files, directories, and the trailer are
 The last record of the archive always contains the name
 TRAILER!!!.  Special files, directories, and the trailer are
-recorded with H_filesize equal to zero.
-.SH SEE ALSO
-cpio(1), find(1), stat(2)
+recorded with
+.Fa H_filesize
+equal to zero.
+.Sh SEE ALSO
+.Xr cpio 1 ,
+.Xr find 1 ,
+.Xr stat 2
+.Sh HISTORY
+A
+.Xr cpio 1
+command appeared in
+.At V .
+This file format is derived from the
+.At V
+sources which were contributed to the public domain by AT&T.