Skip to content

Commit 318d43f

Browse files
committed
add sbang-specific README, COPYRIGHT, LICENSE, NOTICE, etc. files
- [x] move docs from sbang to README.md - [x] add license, copyright, notice, etc. files
1 parent 7a58ad0 commit 318d43f

File tree

6 files changed

+386
-74
lines changed

6 files changed

+386
-74
lines changed

COPYRIGHT

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Intellectual Property Notice
2+
------------------------------
3+
4+
sbang is licensed under the Apache License, Version 2.0 (LICENSE-APACHE
5+
or http://www.apache.org/licenses/LICENSE-2.0) or the MIT license,
6+
(LICENSE-MIT or http://opensource.org/licenses/MIT), at your option.
7+
8+
Copyrights and patents in the sbang project are retained by contributors.
9+
No copyright assignment is required to contribute to sbang.
10+
11+
12+
SPDX usage
13+
------------
14+
15+
Individual files contain SPDX tags instead of the full license text.
16+
This enables machine processing of license information based on the SPDX
17+
License Identifiers that are available here: https://spdx.org/licenses/
18+
19+
Files that are dual-licensed as Apache-2.0 OR MIT contain the following
20+
text in the license header:
21+
22+
SPDX-License-Identifier: (Apache-2.0 OR MIT)

LICENSE-APACHE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

LICENSE-MIT

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2013-2020 LLNS, LLC and other sbang Project Developers.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

NOTICE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
This work was produced under the auspices of the U.S. Department of
2+
Energy by Lawrence Livermore National Laboratory under Contract
3+
DE-AC52-07NA27344.
4+
5+
This work was prepared as an account of work sponsored by an agency of
6+
the United States Government. Neither the United States Government nor
7+
Lawrence Livermore National Security, LLC, nor any of their employees
8+
makes any warranty, expressed or implied, or assumes any legal liability
9+
or responsibility for the accuracy, completeness, or usefulness of any
10+
information, apparatus, product, or process disclosed, or represents that
11+
its use would not infringe privately owned rights.
12+
13+
Reference herein to any specific commercial product, process, or service
14+
by trade name, trademark, manufacturer, or otherwise does not necessarily
15+
constitute or imply its endorsement, recommendation, or favoring by the
16+
United States Government or Lawrence Livermore National Security, LLC.
17+
18+
The views and opinions of authors expressed herein do not necessarily
19+
state or reflect those of the United States Government or Lawrence
20+
Livermore National Security, LLC, and shall not be used for advertising
21+
or product endorsement purposes.

README.md

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# sbang
2+
3+
`sbang` lets you run scripts with very long shebang (`#!`) lines.
4+
5+
Many operating systems limit the length and number of possible arguments
6+
in shebang lines, making it hard to use interpreters that are deep in the
7+
directory hierarchy or require special arguments.
8+
9+
To use, put the long shebang on the second line of your script, and
10+
make sbang the interpreter, like this:
11+
12+
#!/bin/sh /path/to/sbang
13+
#!/long/path/to/real/interpreter with arguments
14+
15+
`sbang` will run the real interpreter with the script as its argument.
16+
17+
## Longer explanation
18+
19+
Suppose you have a script, `long-shebang.sh`, like this:
20+
21+
1 #!/very/long/path/to/some/interp
22+
2
23+
3 echo "success!"
24+
25+
If `very/long/path` is actually very long, running this script will
26+
result in an error on some OS's. On Linux, you get this:
27+
28+
$ ./long-shebang.sh
29+
-bash: ./longshebang.sh: /very/long/path/to/some/interp: bad interpreter:
30+
No such file or directory
31+
32+
On macOS, the system simply assumes the interpreter is the shell and
33+
tries to run with it, which is not likely what you want.
34+
35+
36+
### `sbang` on the command line
37+
38+
You can use `sbang` in two ways. You can use it directly, from the
39+
command line, like this:
40+
41+
$ sbang ./long-shebang.sh
42+
success!
43+
44+
45+
### `sbang` as the interpreter
46+
47+
You can also use `sbang` *as* the interpreter for your script. Put
48+
`#!/bin/sh /path/to/sbang` on line 1, and move the original shebang to
49+
line 2 of the script:
50+
51+
1 #!/bin/sh /path/to/sbang
52+
2 #!/long/path/to/real/interpreter with arguments
53+
3
54+
4 echo "success!"
55+
56+
$ ./long-shebang.sh
57+
success!
58+
59+
On Linux, you could shorten line 1 to `#!/path/to/sbang`, but other
60+
operating systems like Mac OS X require the interpreter to be a binary,
61+
so it's best to use `sbang` as an argument to `/bin/sh`. Obviously, for
62+
this to work, `sbang` needs to have a short enough path that *it* will
63+
run without hitting OS limits.
64+
65+
### Other comment syntaxes
66+
67+
For Lua, node, and php scripts, the second line can't start with `#!`, as
68+
`#` is not the comment character in these languages (though they all
69+
ignore `#!` on the *first* line of a script). Instrument such scripts
70+
like this, using `--`, `//`, or `<?php ... ?>` instead of `#` on the
71+
second line, e.g.:
72+
73+
1 #!/bin/sh /path/to/sbang
74+
2 --!/long/path/to/lua with arguments
75+
3 print "success!"
76+
77+
1 #!/bin/sh /path/to/sbang
78+
2 //!/long/path/to/node with arguments
79+
3 print "success!"
80+
81+
1 #!/bin/sh /path/to/sbang
82+
2 <?php #/long/path/to/php with arguments ?>
83+
3 <?php echo "success!\n"; ?>
84+
85+
## How it works
86+
87+
`sbang` is a very simple posix shell script. It looks at the first two
88+
lines of a script argument and runs the last line starting with `#!`,
89+
with the script as an argument. It also forwards arguments.
90+
91+
92+
## Authors
93+
94+
`sbang` was created by Todd Gamblin, [email protected], as part of
95+
[Spack](https://github.com/spack/spack).
96+
97+
## License
98+
99+
`sbang` is distributed under the terms of both the MIT license and the
100+
Apache License (Version 2.0). Users may choose either license, at their
101+
option.
102+
103+
All new contributions must be made under both the MIT and Apache-2.0
104+
licenses.
105+
106+
See [LICENSE-MIT](https://github.com/spack/sbang/blob/develop/LICENSE-MIT),
107+
[LICENSE-APACHE](https://github.com/spack/sbang/blob/develop/LICENSE-APACHE),
108+
[COPYRIGHT](https://github.com/spack/sbang/blob/develop/COPYRIGHT), and
109+
[NOTICE](https://github.com/spack/sbang/blob/develop/NOTICE) for details.
110+
111+
SPDX-License-Identifier: (Apache-2.0 OR MIT)
112+
113+
LLNL-CODE-811652

0 commit comments

Comments
 (0)