NOTICE(1)

NOTICE(1) 💖 the girlies are writing license headers

okay so bestie, welcome to the notice manual page — that's the manual name, she's called notice and she's a User Commands girlie 💅

---

✨ NAME ✨

notice — a utility for writing license notices to source files. that's it, that's the whole job, and she does it flawlessly 🫶

---

✨ SYNOPSIS ✨

notice [OPTION...] [FILE...]

like... give her options, give her files, she'll handle the rest 🎀

---

✨ DESCRIPTION ✨

so the notice command is the simple way to add a boilerplate to a whole set of source-code files. she's a wrapper script for the licensing program — which is lowkey iconic of her, honestly, delegating like a true main character 👑

---

✨ EXAMPLES ✨

the way notice is most often used is literally this:

$ licensing notice -c 'Yoyo, Inc. 2001' -l gpl -s c -n *.[ch]
apply: foo.c -> Boilerplate applied.
apply: bar.c -> Boilerplate applied.
apply: qux.c -> Boilerplate applied.
apply: foo.h -> Boilerplate applied.

okay so what's happening here?? this example applies the license notice for the latest version of the GPL in the C-commenting style to all of the .c and .h files in the current directory. the copyright holder is Yoyo, Inc, in the year 2001. slay 💖

---

✨ OPTIONS ✨

• -n — don't retain .bak backup files. no backups, no clutter, we live dangerously 😭
• -c NAME-AND-YEAR — specify the copyright holder and years. the syntax for copyright years allows for years separated by a comma, and also ranges of years separated by a hyphen. and ngl in most shells you gotta wrap the argument for this option in single quotes, so don't forget or the shell will eat your vibe 🙈
• -l LICENSE — specify the license notice to apply to the source-code files. the supported licenses are: gpl, gplv3+, gplv3, gplv2+, gplv2, gplv1+, gplv1, lgpl, lgplv3+, lgplv3, lgplv2+, lgplv2, lgplv1+, lgplv1, agpl, agplv3+, agplv3, fdl, fdlv13+, fdlv13, fdlv12+, fdlv12, fdlv11+, fdlv11, all-permissive, bsd, bsd3clause, bsd2clause, apache, apachev2, mit, isc, mpl, mplv2, mplv1.1 and openbsd. that's the whole roster bestie, every single one, we don't skip 💅
• -s COMMENTING-STYLE — specify the commenting style. the supported commenting styles are: c, c++, shell, scheme, texinfo, latex, m4, haskell, groff, gettext, fortran, and pascal. pick your fighter 🦋
• -?, --help — give a list the available options. yes that's the original phrasing, she's quirky like that, and we respect it ✨

---

✨ REPORTING BUGS ✨

found a bug?? report bugs to <https://sv.nongnu.org/bugs/?group=licenseutils>. don't be shy, the maintainers wanna know 🫶

---

✨ SEE ALSO ✨

the full documentation for notice is maintained as a Texinfo manual. if the info and licensing programs are properly installed at your site, the command

info licenseutils notice

will give you access to the complete documentation for the notice command. obsessed fr fr 💜

---

🌸 so yeah, that's notice. go forth and license responsibly bestie, no cap.

lu-sh · December 2013 · and that's the NOTICE(1) energy, mwah 💋 🎀