xref: /freebsd/bin/pax/options.h (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1992 Keith Muller.
5  * Copyright (c) 1992, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * Keith Muller of the University of California, San Diego.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. 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 
36 /*
37  * argv[0] names. Used for tar and cpio emulation
38  */
39 
40 #define NM_TAR  "tar"
41 #define NM_CPIO "cpio"
42 #define NM_PAX  "pax"
43 
44 /*
45  * Constants used to specify the legal sets of flags in pax. For each major
46  * operation mode of pax, a set of illegal flags is defined. If any one of
47  * those illegal flags are found set, we scream and exit
48  */
49 #define NONE	"none"
50 
51 /*
52  * flags (one for each option).
53  */
54 #define	AF	0x00000001
55 #define	BF	0x00000002
56 #define	CF	0x00000004
57 #define	DF	0x00000008
58 #define	FF	0x00000010
59 #define	IF	0x00000020
60 #define	KF	0x00000040
61 #define	LF	0x00000080
62 #define	NF	0x00000100
63 #define	OF	0x00000200
64 #define	PF	0x00000400
65 #define	RF	0x00000800
66 #define	SF	0x00001000
67 #define	TF	0x00002000
68 #define	UF	0x00004000
69 #define	VF	0x00008000
70 #define	WF	0x00010000
71 #define	XF	0x00020000
72 #define	CBF	0x00040000	/* nonstandard extension */
73 #define	CDF	0x00080000	/* nonstandard extension */
74 #define	CEF	0x00100000	/* nonstandard extension */
75 #define	CGF	0x00200000	/* nonstandard extension */
76 #define	CHF	0x00400000	/* nonstandard extension */
77 #define	CLF	0x00800000	/* nonstandard extension */
78 #define	CPF	0x01000000	/* nonstandard extension */
79 #define	CTF	0x02000000	/* nonstandard extension */
80 #define	CUF	0x04000000	/* nonstandard extension */
81 #define	CXF	0x08000000
82 #define	CYF	0x10000000	/* nonstandard extension */
83 #define	CZF	0x20000000	/* nonstandard extension */
84 
85 /*
86  * ascii string indexed by bit position above (alter the above and you must
87  * alter this string) used to tell the user what flags caused us to complain
88  */
89 #define FLGCH	"abcdfiklnoprstuvwxBDEGHLPTUXYZ"
90 
91 /*
92  * legal pax operation bit patterns
93  */
94 
95 #define ISLIST(x)	(((x) & (RF|WF)) == 0)
96 #define	ISEXTRACT(x)	(((x) & (RF|WF)) == RF)
97 #define ISARCHIVE(x)	(((x) & (AF|RF|WF)) == WF)
98 #define ISAPPND(x)	(((x) & (AF|RF|WF)) == (AF|WF))
99 #define	ISCOPY(x)	(((x) & (RF|WF)) == (RF|WF))
100 #define	ISWRITE(x)	(((x) & (RF|WF)) == WF)
101 
102 /*
103  * Illegal option flag subsets based on pax operation
104  */
105 
106 #define	BDEXTR	(AF|BF|LF|TF|WF|XF|CBF|CHF|CLF|CPF|CXF)
107 #define	BDARCH	(CF|KF|LF|NF|PF|RF|CDF|CEF|CYF|CZF)
108 #define	BDCOPY	(AF|BF|FF|OF|XF|CBF|CEF)
109 #define	BDLIST (AF|BF|IF|KF|LF|OF|PF|RF|TF|UF|WF|XF|CBF|CDF|CHF|CLF|CPF|CXF|CYF|CZF)
110