]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - bin/pax/options.h
trim(8): Fix a few issues reported by mandoc
[FreeBSD/FreeBSD.git] / bin / pax / options.h
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  *      @(#)options.h   8.2 (Berkeley) 4/18/94
36  * $FreeBSD$
37  */
38
39 /*
40  * argv[0] names. Used for tar and cpio emulation
41  */
42
43 #define NM_TAR  "tar"
44 #define NM_CPIO "cpio"
45 #define NM_PAX  "pax"
46
47 /*
48  * Constants used to specify the legal sets of flags in pax. For each major
49  * operation mode of pax, a set of illegal flags is defined. If any one of
50  * those illegal flags are found set, we scream and exit
51  */
52 #define NONE    "none"
53
54 /*
55  * flags (one for each option).
56  */
57 #define AF      0x00000001
58 #define BF      0x00000002
59 #define CF      0x00000004
60 #define DF      0x00000008
61 #define FF      0x00000010
62 #define IF      0x00000020
63 #define KF      0x00000040
64 #define LF      0x00000080
65 #define NF      0x00000100
66 #define OF      0x00000200
67 #define PF      0x00000400
68 #define RF      0x00000800
69 #define SF      0x00001000
70 #define TF      0x00002000
71 #define UF      0x00004000
72 #define VF      0x00008000
73 #define WF      0x00010000
74 #define XF      0x00020000
75 #define CBF     0x00040000      /* nonstandard extension */
76 #define CDF     0x00080000      /* nonstandard extension */
77 #define CEF     0x00100000      /* nonstandard extension */
78 #define CGF     0x00200000      /* nonstandard extension */
79 #define CHF     0x00400000      /* nonstandard extension */
80 #define CLF     0x00800000      /* nonstandard extension */
81 #define CPF     0x01000000      /* nonstandard extension */
82 #define CTF     0x02000000      /* nonstandard extension */
83 #define CUF     0x04000000      /* nonstandard extension */
84 #define CXF     0x08000000
85 #define CYF     0x10000000      /* nonstandard extension */
86 #define CZF     0x20000000      /* nonstandard extension */
87
88 /*
89  * ascii string indexed by bit position above (alter the above and you must
90  * alter this string) used to tell the user what flags caused us to complain
91  */
92 #define FLGCH   "abcdfiklnoprstuvwxBDEGHLPTUXYZ"
93
94 /*
95  * legal pax operation bit patterns
96  */
97
98 #define ISLIST(x)       (((x) & (RF|WF)) == 0)
99 #define ISEXTRACT(x)    (((x) & (RF|WF)) == RF)
100 #define ISARCHIVE(x)    (((x) & (AF|RF|WF)) == WF)
101 #define ISAPPND(x)      (((x) & (AF|RF|WF)) == (AF|WF))
102 #define ISCOPY(x)       (((x) & (RF|WF)) == (RF|WF))
103 #define ISWRITE(x)      (((x) & (RF|WF)) == WF)
104
105 /*
106  * Illegal option flag subsets based on pax operation
107  */
108
109 #define BDEXTR  (AF|BF|LF|TF|WF|XF|CBF|CHF|CLF|CPF|CXF)
110 #define BDARCH  (CF|KF|LF|NF|PF|RF|CDF|CEF|CYF|CZF)
111 #define BDCOPY  (AF|BF|FF|OF|XF|CBF|CEF)
112 #define BDLIST (AF|BF|IF|KF|LF|OF|PF|RF|TF|UF|WF|XF|CBF|CDF|CHF|CLF|CPF|CXF|CYF|CZF)