getopt.rs(3): better Opt return

CONDUCT

@@ -1,83 +0,0 @@
-Code of Conduct
-
-This Code of Conduct is derived from the 10 Pāramitās of Theravadin Buddhism.
-You can read more about them in Ṭhānissaro Bhikkhu’s Ten Perfections: A Study
-Guide [0].
-
-1. Generosity (Dāna)
-
-Give contributions freely and willingly under the terms of the GNU Affero
-General Public License, version 3 or later, or a compatible license.
-
-2. Ethics (Sīla)
-
-Do not use nonfree code or uncredited code in contributions. Do not contribute
-code of dubious origins, such as code generated by large language models or
-unlicensed snippets found online [1]. Do not take credit for others’
-contributions. Make sure to utilize the copyright header and license notice on
-source files to credit yourself and others for their work.
-
-3. Renunciation (Nekkhamma)
-
-Stay committed to the principles of simplicity and interoperability embodied by
-the project. Keep your personal will and desire out of the project, for it can
-only prove harmful to its success.
-
-4. Wisdom (Pañña)
-
-Look to established sources for standards, best practices, and important
-implementation details when setting new precedence. Follow the existing
-precedence where it applies.
-
-5. Energy (Viriya)
-
-Focus on the currently-open, currently-assigned, and currently-in-progress
-issues, pull requests, and other endeavors in order to keep yourself and others
-from being overwhelmed with responsibility, either from your zeal or your
-negligence.
-
-If you notice an issue, open an issue as soon as you can. If you see a neglected
-branch, open a pull request or comment on an existing one, if applicable. Be
-diligent in your commitment to making this project work.
-
-6. Patience (Khanti)
-
-Be patient with maintainers and other contributors. We all have our own lives
-going on and may need significant time to get to things.
-
-7. Truthfulness (Sacca)
-
-Communicate honestly and openly. Do not embellish facts to get your way. Make
-sure to let maintainers know about any issues along the way and keep ample
-communication channels open.
-
-8. Determination (Adhiṭṭhāna)
-
-Stay focused on long-term objectives and cultivate attainment to that
-achievement by utilizing to the fullest extent possible the tools available to
-you for managing the workload.
-
-9. Loving-Kindness (Mettā)
-
-Treat everyone with respect, even if they treat you poorly. This does not mean
-you have to put up with abuse, but make sure to respond with kindness and with
-love in your heart. Support and uplift maintainers and other contributors with
-your words and actions.
-
-Do not use angry or hateful language toward contributors, such as demeaning
-phrases and slurs. Make sure that if you do not know the pronouns of a
-contributor to ask for them and, in the meantime, use gender-neutral they/them
-or equivalent pronouns.
-
-10. Equanimity (Upekkhā)
-
-Keep a balanced perspective on all suggestions and contributions and make
-judgements not from a place of ego and personal preference but on their
-usefulness and suitability to the project. Make sure to keep an eye on the
-bigger picture as implementing individual features may seem intuitive at first
-but scale poorly in practical use. Keep a level head about your own work: it is
-not shameful to make a mistake in this vein, and fixing it usually leads to
-more insight.
-
-[0] <https://www.dhammatalks.org/books/#/books/TenPerfections/Section0001.html>
-[1] <https://www.fsf.org/news/publication-of-the-fsf-funded-white-papers-on-questions-around-copilot>

CONTRIBUTING

@@ -1,5 +1,3 @@
-Make sure to read our code of conduct in the CONDUCT file.
-
 When contributing a pull request to the main branch, please sign your commits
 with a PGP key and add your name and the year to the bottom of the list of
 copyright holders for the file. For example, an existing copyright header might

COPYING.GPL

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

Makefile

@@ -8,16 +8,15 @@
 # permitted in any medium without royalty provided the copyright notice and this
 # notice are preserved.  This file is offered as-is, without any warranty.
 
-# The octal escape \043 is utilized twice in this file as make(1p) will
-# interpret a hash in a rule as an inline comment.
-
 .POSIX:
 
+# if using BSD make(1), remove these pragmas because they break it
+.PRAGMA: posix_202x # future POSIX standard support à la pdpmake(1)
+.PRAGMA: command_comment # breaks without this?
+
 DESTDIR ?= dist
 PREFIX ?= /usr/local
 
-MANDIR != [ $(PREFIX) = / ] && printf '/usr/share/man\n' \
-	|| printf '/share/man\n'
 SYSEXITS != printf '\043include <sysexits.h>\n' | cpp -M - | sed 's/ /\n/g' \
 	| sed -n 's/sysexits\.h//p' || printf 'include\n'
 
@@ -29,11 +28,11 @@ RUSTLIBS = --extern getopt=build/o/libgetopt.rlib \
 CFLAGS += -I$(SYSEXITS)
 
 .PHONY: all
-all: dj eep false fop hru intcmp mm npc rpn scrut str strcmp swab true
+all: dj false fop hru intcmp mm npc rpn scrut str strcmp swab true
 
-# keep build/include until bindgen(1) has stdin support
-# https://github.com/rust-lang/rust-bindgen/issues/2703
 build:
+	# keep build/include until bindgen(1) has stdin support
+	# https://github.com/rust-lang/rust-bindgen/issues/2703
 	mkdir -p build/bin build/include build/lib build/o build/test
 
 .PHONY: clean
@@ -43,7 +42,7 @@ clean:
 dist: all
 	mkdir -p $(DESTDIR)/$(PREFIX)/bin $(DESTDIR)/$(PREFIX)/share/man/man1
 	cp build/bin/* $(DESTDIR)/$(PREFIX)/bin
-	cp docs/*.1 $(DESTDIR)/$(PREFIX)/$(MANDIR)/man1
+	cp docs/*.1 $(DESTDIR)/$(PREFIX)/share/man/man1
 
 .PHONY: install
 install: dist
@@ -52,23 +51,22 @@ install: dist
 .PHONY: test
 test: build
 	tests/posix-compat.sh
-	$(RUSTC) --test src/getopt-rs/lib.rs -o build/test/getopt
 
 .PHONY: rustlibs
 rustlibs: build/o/libsysexits.rlib build/o/libgetopt.rlib \
 	build/o/libstrerror.rlib
 
-build/o/libgetopt.rlib: build src/getopt-rs/lib.rs
+build/o/libgetopt.rlib: build src/getopt.rs
 	$(RUSTC) $(RUSTFLAGS) --crate-type=lib --crate-name=getopt \
-		-o $@ src/getopt-rs/lib.rs
+		-o $@ src/getopt.rs
 
 build/o/libstrerror.rlib: build src/strerror.rs
 	$(RUSTC) $(RUSTFLAGS) --crate-type=lib -o $@ \
 		src/strerror.rs
 
-# bandage solution until bindgen(1) gets stdin support
 build/o/libsysexits.rlib: build $(SYSEXITS)sysexits.h
-	printf '\043define EXIT_FAILURE 1\n' | cat - $(SYSEXITS)sysexits.h \
+	# bandage solution until bindgen(1) gets stdin support
+	printf '#define EXIT_FAILURE 1\n' | cat - $(SYSEXITS)sysexits.h \
 		> build/include/sysexits.h 
 	bindgen --default-macro-constant-type signed --use-core --formatter=none \
 		build/include/sysexits.h | $(RUSTC) $(RUSTFLAGS) --crate-type lib -o $@ -
@@ -103,6 +101,7 @@ mm: build/bin/mm
 build/bin/mm: src/mm.c build
 	$(CC) $(CFLAGS) -o $@ src/mm.c
 
+
 .PHONY: npc
 npc: build/bin/npc
 build/bin/npc: src/npc.c build
@@ -118,11 +117,6 @@ scrut: build/bin/scrut
 build/bin/scrut: src/scrut.c build
 	$(CC) $(CFLAGS) -o $@ src/scrut.c
 
-.PHONY: eep
-eep: build/bin/eep
-build/bin/eep: src/eep.rs build rustlibs
-	$(RUSTC) $(RUSTFLAGS) -o $@ src/eep.rs
-
 .PHONY: str
 str: build/bin/str
 build/bin/str: src/str.c build

README

@@ -1,11 +1,9 @@
 “Seek not to walk the path of the masters; seek what they sought.”
 – Matsuo Basho
 
-The Bonsai core utilities are a replacement for standard POSIX utilities which
-aim to fill its niche while expanding on their capabilities. These new tools are
-the result of the careful examination of the current state of POSIX and Unix
-utilies. The Unix Philosophy of “do one thing and do it well” are their core but
-they avoid clinging to the past.
+The Bonsai core utilities are the result of the careful examination of the
+current state of POSIX and Unix utilies. The Unix Philosophy, “do one thing and
+do it well” is its core but these tools do not cling to the names of the past.
 
 The era of the original Unix tools has been long and fruitful, but they have
 their flaws. The new, non-POSIX era of this project started with frustration
@@ -22,9 +20,9 @@ See docs/ for more on the specific utilities currently implemented.
 Building
 
 The coreutils require a POSIX-compliant environment to compile, including a C
-compiler and preprocessor (cc(1) and cpp(1) by default), an edition 2023 Rust
-compiler (rustc(1) by default), bindgen(1), and a POSIX-compliant make(1)
-utility.
+compiler and preprocessor (cc(1) and cpp(1) by default) with the -idirafter
+flag, a Rust compiler (rustc(1) by default), bindgen(1), and a POSIX-compliant
+make(1) utility.
 
 To build and install:
 
@@ -40,7 +38,7 @@ To test the utilities:
 
 $ make test
 
-To remove all build and distributable files:
+To remove all untracked files:
 
 $ make clean
 

docs/dj.1

@@ -1,13 +1,14 @@
 .\" Copyright (c) 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH DJ 1 2024-06-17 "Bonsai Core Utilites 0.13.11"
+
+.TH dj 1
+
 .SH NAME
+
 dj \(en disk jockey
-.\"
+
 .SH SYNOPSIS
 
 dj
@@ -18,172 +19,142 @@ dj
 .RB [ count ])
 
 .RB ( -i
-[\fBinput file\fP])
+.R [
+.B input file
+.R ])
 .RB ( -b
-[\fBinput block size\fP])
+.R [
+.B input block size
+.R ])
 .RB ( -s
-[\fBinput offset\fP])
+.R [
+.B input offset
+.R ])
 
 .RB ( -o
-[\fBoutput file\fP])
+.R [
+.B output file
+.R ])
 .RB ( -B
-[\fBoutput block size\fP])
+.R [
+.B output block size
+.R ])
 .RB ( -S
-[\fBoutput offset\fP])
-.\"
-.SH DESCRIPTION
+.R [
+.B output offset
+.R ])
 
-Perform precise read and write operations on files. This utility is useful for
-reading and writing binary data to and from disks.
+.SH USAGE
 
-This manual page uses the terms \(lqskip\(rq and \(lqseek\(rq to refer to moving
-to a specified byte by index in the input and output of the program
-respectively. This language is inherited from the
-.BR dd (1p)
-utility and used here to decrease ambiguity.
-
-When seeking or skipping to a byte, writing or reading starts at the byte
-immediately subsequent to the specified byte.
-.\"
-.SH OPTIONS
-
-.IP \fB-i\fP
-Takes a file path as an argument and opens it for use as an input.
-.IP \fB-b\fP
-Takes a numeric argument as the size in bytes of the input buffer, the default
-being 1024.
-.IP \fB-s\fP
-Takes a numeric argument as the number of bytes to skip into the input
-before starting to read. If the standard input is used, bytes read to this point
-are discarded.
-.IP \fB-o\fP
-Takes a file path as an argument and opens it for use as an output.
-.IP \fB-B\fP
-Does the same as
+The
+.B -i
+option takes a path as an argument to open and use in place of standard input.
+The
+.B -o
+option does the same in place of standard output. Dj does not truncate output
+files and instead writes over the bytes in the existing file.
+.PP
+The
 .B -b
-but for the output buffer.
-.IP \fB-S\fP
-Seeks a number of bytes through the output before starting to write from
-the input. If the output is a stream, null characters are printed.
-.IP \fB-a\fP
-Accepts a single literal byte with which the input buffer is padded in the event
-of an incomplete read from the input file.
-.IP \fB-A\fP
-Specifying this option pads the input buffer with null bytes in the event of an
-incomplete read. This is equivalent to specifying
+option takes a numeric argument as the size in bytes of the input buffer and
+the
+.B -B
+option does the same for the output buffer, the default for both being 1024
+bytes, or one kibibyte (KiB).
+.PP
+The
+.B -s
+option takes a numeric argument as the number of bytes to skip into the input
+before starting to read, and the
+.B -S
+option skips a number of bytes through the output before starting to write from
+the input. If the input is a stream the bytes are read and discarded. If the
+output is a stream, nul characters are printed.
+.PP
+The
 .B -a
-with a null byte instead of a character.
-.IP \fB-c\fP
-Specifies a number of reads to make. The default is 0, in which case the
-input is read until a partial or empty read is made.
-.IP \fB-d\fP
-Prints invocation information before program execution as described in the
-DIAGNOSTICS section. Each invocation increments the debug level of the
-program.
-.IP \fB-H\fP
-Prints diagnostics messages in a human-readable manner as described in the
-DIAGNOSTICS section.
-.IP \fB-n\fP
-Retries failed reads once before exiting.
-.IP \fB-q\fP
-Suppresses error messages which print when a read or write is partial or
-empty. Each invocation decrements the debug level of the program.
-.\"
-.SH STANDARD INPUT
+option takes one argument of one byte in length and pads the input buffer with
+that byte in the event that a read doesn't fill the input buffer, and the
+.B -A
+option takes no arguments and pads with nuls.
+The
+.B -c
+option specifies an amount of reads to make, and if 0 (the default) dj will
+continue reading until a partial or empty read.
+.PP
+On a partial or empty read, dj prints a diagnostic message (unless the
+.B -q
+option is specified) and exits (unless the
+.B -n
+option is specified, in which case only two consecutive empty reads will cause
+dj to exit).
+At exit, usage statistics are printed unless the option
+.B -q
+is specified a second time. The
+.B -H
+option will make these diagnostics human-readable.
 
-The standard input shall be used as an input if no inputs are specified or if
-one or more of the input files is \(lq-\(rq.
-.\"
-.SH STANDARD OUTPUT
-The standard output shall be used as an output if no inputs are specified or if
-one or more of the input files is \(lq-\(rq.
-.\"
 .SH DIAGNOSTICS
 
-On a partial or empty read, unless the
-.B -q
-option is specified, a diagnostic message is printed. Then, the program exits
-unless the
-.B -n
-option is specified.
-
-By default, statistics are printed for input and output to the standard error in
-the following format:
-
-.RS
-{records read} {ASCII unit separator} {partial records read}
-{ASCII record separator} {records written} {ASCII unit separator}
-{partial records written} {ASCII group separator} {bytes read}
-{ASCII record separator} {bytes written} {ASCII file separator}
-.RE
-
-This format for diagnostic output is designed to be machine-parseable for
-convenience. For a more human-readable format, the
-.B -H
-option may be specified. In this event, the following format is used instead:
-
-.RS
-{records read} '+' {partial records read} '>' {records written}
-'+' {partial records written} ';' {bytes read} '>' {bytes written}
-{ASCII line feed}
-.RE
-
+The
+.B -d
+option prints all information, user-specified or otherwise, before program
+execution.
+.PP
+When dj exits, by default statistics are printed for input and output to
+standard error in the following format:
+.PP
+.R {records read} {ASCII unit separator} {partial records read}
+.R {ASCII record separator} {records written} {ASCII unit separator}
+.R {partial records written} {ASCII group separator} {bytes read}
+.R {ASCII record separator} {bytes written} {ASCII file separator}
+.PP
 If the
-.B -d
-option is specified, debug information will be printed at the beginning of
-execution. This output contains information regarding how the program was
-invoked. The following example is the result of running the program with
-.B -d
-as the only argument:
-
-.RS
-argv0=dj
-in=<stdin>      ibs=1024        skip=0  align=ff       count=0
-out=<stdout>    obs=1024        seek=0  debug= 3       noerror=0
-.RE
-
-In non-recoverable errors that don\(cqt pertain to the read-write cycle, a
-diagnostic message is printed and the program exits with the appropriate
-.BR sysexits.h (3)
+.B -H
+option is specified dj instead uses this following format:
+.PP
+.R {records read} '+' {partial records read} '>' {records written}
+.R '+' {partial records written} ';' {bytes read} '>' {bytes written}
+.R {ASCII line feed}
+.PP
+The
+.B -q
+option suppresses error messages which print when a read or write is partial or
+empty and when used twice suppresses diagnostic output entirely.
+.PP
+In non-recoverable errors that don't pertain to dj's read-write cycle, a
+diagnostic message is printed and dj exits with the appropriate sysexits(3)
 status.
-.\"
+
 .SH BUGS
 
 If
 .B -n
-is specified along with the
-.B -c
-option and a count, actual byte output is the product of the count and the input
-block size and therefore may be lower than expected. If the
+is specified along with a specified count, actual byte output may be lower than
+expected (the product of the count multiplied by the input block size). If the
 .B -a
 or
 .B -A
-options are specified, this could make written data nonsensical.
-.\"
-.SH CAVEATS
-
-Existing files are not truncated on ouput and are instead overwritten.
-
+options are used this could make data written nonsensical.
+.PP
 Many lowercase options have capitalized variants and vice-versa which can be
 confusing. Capitalized options tend to affect output or are more intense
 versions of lowercase options.
-.\"
+
 .SH RATIONALE
 
-This program was based on the
-.BR dd (1p)
-utility as specified in POSIX. While character conversion may have been the
-original intent of
-.BR dd (1p),
-it is irrelevant to its modern use. Because of this, this program eschews
-character conversion and adds typical option formatting, allowing seeks to be
-specified in bytes rather than in blocks, allowing arbitrary bytes as padding,
-and printing in a format that\(cqs easy for machines to parse.
-.\"
+Dj was modeled after the dd utility specified in POSIX but adds additional
+features: typical option formatting, allowing seeks to be specified in bytes
+rather than in blocks, allowing arbitrary bytes as padding, and printing in a
+format that's easy to parse for machines. It also neglects character
+conversion, which may be dd's original intent but is irrelevant to its modern
+use.
+
 .SH COPYRIGHT
 
-Copyright \(co 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright (C) 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-.\"
+
 .SH SEE ALSO
-.BR dd (1p)
+
+dd(1)

docs/eep.1

@@ -1,43 +0,0 @@
-.\" Copyright (c) 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
-.\"
-.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
-.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH EEP 1
-.SH NAME
-eep \(en wait a moment
-.\"
-.SH SYNOPSIS
-
-eep
-.RB [ seconds ]
-.\"
-.SH DESCRIPTION
-
-Wait a specified number of seconds before exiting.
-.\"
-.SH DIAGNOSTICS
-
-If the specified time fails to elapse or in the case of incorrect invocation,
-the program will exit unsuccessfully. In the latter scenario, a debug message
-will be printed.
-.\"
-.SH CAVEATS
-
-User may still be tired after invocation.
-.\"
-.SH AUTHOR
-
-Written by DTB
-.MT trinity@trinity.moe
-.ME .
-.\"
-.SH COPYRIGHT
-
-Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
-<https://gnu.org/licenses/gpl.html>.
-.\"
-.SH SEE ALSO
-.BR sleep (3p)
-.BR sleep (1p)

docs/false.1

@@ -1,35 +1,35 @@
 .\" Copyright (c) 2022, 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH FALSE 1 2024-06-06 "Bonsai Core Utilites 0.13.11"
+
+.TH FALSE 1
+
 .SH NAME
+
 false \(en do nothing, unsuccessfully
-.\"
+
 .SH DESCRIPTION
 
-Do nothing regardless of operands or standard input. An exit code of 1 will
-always be returned.
-.\"
+False does nothing regardless of operands or standard input.
+False will always return an exit code of 1.
+
 .SH RATIONALE
 
-In POSIX.1-2017,
-.BR false (1p)
-exists for the construction of control flow and loops based on a failure. This
-implementation functions as described in that standard.
-.\"
+False exists for the construction of control flow and loops based on a failure.
+
+False functions as described in POSIX.1-2017.
+
 .SH AUTHOR
 
-Written by Emma Tebibyte
-.MT emma@tebibyte.media
-.ME .
-.\"
+Written by Emma Tebibyte <emma@tebibyte.media>.
+
 .SH COPYRIGHT
 
 This work is marked with CC0 1.0. To see a copy of this license, visit
 <http://creativecommons.org/publicdomain/zero/1.0>.
-.\"
+
 .SH SEE ALSO
-.BR true (1p)
+
+true(1p)

docs/fop.1

@@ -1,62 +0,0 @@
-.\" Copyright (c) 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
-.\"
-.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
-.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH FOP 1 2024-06-17 "Bonsai Core Utilites 0.13.11"
-.SH NAME
-fop \(en field operator
-.\"
-.SH SYNOPSIS
-
-fop
-.RB ( -d )
-.RB [ delimiter ]
-.RB index 
-.RB program...
-.\"
-.SH DESCRIPTION
-
-Performs operations on specified fields in data read from the standard input.
-.\"
-.SH OPTIONS
-
-.IP \fB-d\fP
-Sets a delimiter by which the input data will be split into fields. The default
-is an ASCII record separator.
-.\"
-.SH CAVEATS
-
-Field indices are zero-indexed, which may be unexpected behavior for some users.
-.\"
-.SH RATIONALE
-
-With the assumption that tools will output data separated with ASCII field
-separators, there is a need for the ability to modify select fields in this data
-easily and quickly.
-
-The idea for this utility originated in the fact that the GNU
-.BR ls (1)
-utility contains a
-.B -h
-option which enables human-readable units in file size outputs. This
-functionality was broken out into
-.BR hru (1),
-but there was no easy way to modify the field in the ouput of
-.BR ls (1p)
-without creating a new tool.
-.\"
-.SH AUTHOR
-
-Written by Emma Tebibyte
-.MT emma@tebibyte.media
-.ME .
-.\"
-.SH COPYRIGHT
-
-Copyright \(co 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
-<https://gnu.org/licenses/agpl.html>.
-.\"
-.SH SEE ALSO
-.BR sed (1p)

docs/hru.1

@@ -2,68 +2,56 @@
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH HRU 1 2024-06-17 "Bonsai Core Utilites 0.13.11"
+
+.TH rpn 1
+
 .SH NAME
+
 hru \(en human readable units
-.\"
+
 .SH SYNOPSIS
 
 hru
-.\"
+
 .SH DESCRIPTION
 
-Convert counts to higher units.
-
-Byte counts will be read in the form of whole numbers from the standard input
-and be written to the standard output the same number converted to a higher unit
-of data as defined by the \fIInternational System of Units\fP.
+Hru reads byte counts in the form of whole numbers from the standard input and
+writes to the standard output the same number converted one of the units of data
+defined by the International System of Units.
 
 The program will convert the byte count to the highest unit possible where the
 value is greater than one.
-.\"
+
 .SH DIAGNOSTICS
 
-If encountering non-integer characters in the standard input, the program will
-exit with the appropriate error code as defined by
-.BR sysexits.h (3)
-and print an error message.
-.\"
+If encountering non-integer characters in the standard input, hru will exit with
+the appropriate error code as defined by sysexits.h(3) and print an error
+message.
+
 .SH RATIONALE
 
-The GNU project\(cqs
-.BR ls (1)
-implementation contains a human-readable option (\fB-h\fP) that, when specified,
-makes the tool print size information in a format more immediately
-readable. This functionality is useful not only in this context, so the decision
-was made to split it into a new tool. The original functionality from GNU\(cqs
-.BR ls (1)
-can be emulated with
-.BR fop (1)
-combined with this program.
-.\"
+The GNU project’s ls(1) implementation contains a human-readable option (-h)
+that, when specified, makes the tool print size information in a format more
+immediately readable. This functionality is useful not only in the context of
+ls(1) so the decision was made to split it into a new tool. The original
+functionality in GNU’s ls(1) can be emulated with fop(1) combined with this
+program.
+
 .SH STANDARDS
 
-The standard unit prefixes as specified by the
-.I Bureau International des Poids et Mesures
-.RI ( BIPM )
-in the ninth edition of
-.I The International System of Units
-.RI ( SI )
-are utilized for the ouput of conversions.
-.\"
+Hru follows the standard unit prefixes as specified by the Bureau International
+des Poids et Mesures (BIPM) in the ninth edition of The International System of
+Units (SI).
+
 .SH AUTHOR
 
-Written by Emma Tebibyte
-.MT emma@tebibyte.media
-.ME .
-.\"
+Written by Emma Tebibyte <emma@tebibyte.media>.
+
 .SH COPYRIGHT
 
-Copyright \(co 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
+Copyright (c) 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-.\"
+
 .SH SEE ALSO
-GNU
-.BR ls (1),
-.I The International System of Units (SI) 9th Edition
+
+GNU ls(1), The International System of Units (SI) 9th Edition

docs/intcmp.1

@@ -1,105 +1,78 @@
 .\" Copyright (c) 2023–2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH INTCMP 1 2024-06-06 "Bonsai Core Utilites 0.13.11"
+
+.TH intcmp 1
+
 .SH NAME
+
 intcmp \(en compare integers
-.\"
+
 .SH SYNOPSIS
 
 intcmp
-.RB ( -egl )
+.RB ( -eghl )
 .RB [ integer ]
 .RB [ integer... ]
+
 .SH DESCRIPTION
-Compare integers to each other.
-.\"
-.SH OPTIONS
 
-.IP \fB-e\fP
-Permits given integers to be equal to each other.
-.IP \fB-g\fP
-Permits a given integer to be greater than the following integer.
-.IP \fB-l\fP
-Permits a given integer to be less than the following integer.
-.\"
-.SH EXAMPLES
+Intcmp compares integers.
+
+.SH USAGE
+
+The -e option permits given integers to be equal to each other. If combined
+with -g or -l, only adjacent integers in the argument sequence can be equal.
+.PP
+The -g option permits a given integer to be greater than the following integer.
+.PP
+The -l option permits a given integer to be less than the following integer.
+.PP
+It may help to think of the -e, -g, and -l options as equivalent to the
+infix algebraic “=”, “>”, and “<” operators respectively, with each option
+putting its symbol between every given integer. For example,
+.R intcmp -l 1 2 3
+is equivalent to evaluating "1 < 2 < 3".
 
-It may help to think of the
-.BR -e ,
-.BR -g ,
-and
-.B -l
-options as equivalent to the infix algebraic \(lq=\(rq, \(lq>\(rq, and \(lq<\(rq
-operators respectively, with each option putting its symbol between every given
-integer. The following example is equivalent to evaluating \(lq1 < 2 < 3\(rq:
-\"
-.RS
-intcmp -l 1 2 3
-.RE
-.\"
 .SH DIAGNOSTICS
 
-The program will exit with a successfully for a valid expression and with an
-error code of 1 for an invalid expression.
+Intcmp exits 0 for a valid expression and 1 for an invalid expression.
+.PP
+Intcmp prints a debug message and exits with the appropriate sysexits(3) error
+code in the event of an error.
 
-In the event of an error, a debug message will be printed and the program will
-exit with the appropriate
-.BR sysexits.h (3)
-error code.
-.\"
 .SH BUGS
 
-.BR -egl ,
-\(lqequal to or less than or greater than\(rq, always exits successfully for
-valid program usage and may be abused to function as an integer validator. Use
-.BR str (1)
-instead.
-.\"
-.SH CAVEATS
+There are multiple ways to express compound comparisons; “less than or equal
+to” can be -le or -el, for example.
+.PP
+The inequality comparison is -gl or -lg for “less than or greater than”; this
+is elegant but unintuitive.
+.PP
+-egl, "equal to or less than or greater than", exits 0 no matter what for valid
+program usage and may be abused to function as an integer validator.
+Use str(1) instead.
 
-There are multiple ways to express compound comparisons; \(lqless than or equal
-to\(rq can be
-.B -le
-or
-.BR -el ,
-for example.
-
-The inequality comparison is
-.B -gl
-.B or
-.B -lg
-for \(lqless than or greater than\(rq;
-this is elegant but unintuitive.
-.\"
 .SH RATIONALE
 
 The traditional tool for integer comparisons in POSIX and other Unix shells has
-been
-.BR test (1).
-This tool also handles string comparisons and file scrutiny. These parts of its
-functionality have been broken out into multiple utilities.
+been test(1). This tool also handles string comparisons and file scrutiny.
+These parts of its functionality have been broken out into multiple utilities.
+
+Strcmp’s functionality may be performed on a POSIX-compliant system with
+test(1p).
 
-This program\(cqs functionality may be performed on a POSIX-compliant system
-with
-.BR test (1p).
-.\"
 .SH AUTHOR
 
-Written by DTB
-.MT trinity@trinity.moe
-.ME .
-.\"
+Written by DTB <trinity@trinity.moe>.
+
 .SH COPYRIGHT
-.\"
-Copyright \(co 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
+
+Copyright © 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/gpl.html>.
-.\"
+
 .SH SEE ALSO
-.BR scrut (1),
-.BR strcmp (1),
-.BR str (1),
-.BR test (1p)
+
+strcmp(1), scrut(1), str(1), test(1p)

docs/mm.1

@@ -2,11 +2,13 @@
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH MM 1 2024-06-17 "Bonsai Core Utilites 0.13.11"
+
+.TH mm 1
+
 .SH NAME
+
 mm \(en middleman
-.\"
+
 .SH SYNOPSIS
 
 mm
@@ -15,59 +17,60 @@ mm
 .RB [ input ])
 .RB ( -o
 .RB [ output ])
-.\"
+
 .SH DESCRIPTION
 
-Catenate input files and write them to the start of each output file or stream.
-.\"
+Mm catenates input files and writes them to the start of each output file.
+
 .SH OPTIONS
 
-.IP \fB-a\fP
-Opens subsequent outputs for appending rather than updating.
-.IP \fB-e\fP
-Use the standard error as an output.
-.IP \fB-i\fP
-Opens a path as an input. If one or more of the input files is \(lq-\(rq or if
-no inputs are specified, the standard input shall be used.
-.IP \fB-o\fP
-Opens a path as an output. If one or more of the output files is \(lq-\(rq or if
-no outputs are specified, the standard output shall be used.
-.IP \fB-u\fP
-Ensures neither input or output will be buffered.
-.IP \fB-n\fP
-Causes SIGINT signals to be ignored.
-.\"
+Mm, upon receiving the
+.B -a
+option, will open subsequent outputs for appending rather than updating.
+.PP
+The
+.B -i
+option opens a path as an input. Without any inputs specified mm will use
+standard input. Standard input itself can be specified by giving the path '-'.
+.PP
+The
+.B -o
+option opens a path as an output. Without any outputs specified mm will use
+standard output. Standard output itself can be specified by giving the
+path '-'. Standard error itself can be specified with the
+.B -e
+option.
+.PP
+The
+.B -u
+option ensures neither input or output will be buffered.
+.PP
+The
+.B -n
+option tells mm to ignore SIGINT signals.
+
 .SH DIAGNOSTICS
 
-If an output cannot be written to, an error occurs; however, exiting will be 
-deferred until writing to any other specified outputs completes.
+If an output can no longer be written mm prints a diagnostic message, ceases
+writing to that particular output, and if there are more outputs specified,
+continues, eventually exiting unsuccessfully.
+.PP
+On error mm prints a diagnostic message and exits with the appropriate
+sysexits.h(3) status.
 
-When an error is encountered, a diagnostic message is printed and the program
-exits with the appropriate
-.BR sysexits.h (3)
-status.
-.\"
-.SH CAVEATS
+.SH BUGS
+
+Mm does not truncate existing files, which may lead to unexpected results.
 
-Existing files are not truncated on ouput and are instead overwritten.
-.\"
 .SH RATIONALE
 
-The
-.BR cat (1p)
-and
-.BR tee (1p)
-programs specified in POSIX together provide similar functionality. The
-separation of the two sets of functionality into separate APIs seemed
-unncessary.
-.\"
+Mm was modeled after the cat and tee utilities specified in POSIX.
+
 .SH COPYRIGHT
 
-Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright (c) 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-.\"
+
 .SH SEE ALSO
-.BR cat (1p),
-.BR dd (1),
-.BR dj (1),
-.BR tee (1p)
+
+cat(1p), dd(1), dj(1), tee(1p)

docs/npc.1

@@ -1,74 +1,68 @@
 .\" Copyright (c) 2023–2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH NPC 1 2024-06-17 "Bonsai Core Utilites 0.13.11"
+
+.TH npc 1
+
 .SH NAME
+
 npc \(en show non-printing characters
-.\"
+
 .SH SYNOPSIS
 
 npc
-.RB ( -et )
-.\"
+.RB ( -eht )
+
 .SH DESCRIPTION
 
-Print normally non-printing characters.
-
-The program reads from standard input and writes to standard output, replacing
-non-printing characters with printable equivalents. Control characters print as
-a carat ('^') followed by the character '@' through '_' corresponding to the
-character replaced (e.g. control-X becomes '^X'). The delete character (0x7F)
-becomes '^?'. Characters with the high bit set (>127) are printed as 'M-'
+Npc reads from standard input and writes to standard output, replacing non-
+printing characters with printable equivalents. Control characters print as a
+carat ('^') followed by the character '@' through '_' corresponding to the
+character replaced (e.g. control-X becomes "^X"). The delete character (0x7F)
+becomes "^?". Characters with the high bit set (>127) are printed as "M-"
 followed by the graphical representation for the same character without the
 high bit set.
-.\"
-.SH OPTIONS
+.PP
+The
+.B -e
+option prints a currency sign ('$') before each line ending.
+.PP
+The
+.B -t
+option prints tab characters as "^I" rather than a literal horizontal tab.
 
-.IP \fB-e\fP
-Prints a dollar sign ('$') before each newline.
-.IP \fB-t\fP
-Prints tab characters as '^I' rather than a literal horizontal tab.
-.\"
 .SH DIAGNOSTICS
 
-In the event of an error, a debug message will be printed and the program will
-exit with the appropriate
-.BR sysexits.h (3)
-error code.
-.\"
+Npc prints a debug message and exits with the appropriate sysexits(3) error
+code in the event of an error, otherwise it exits successfully.
+
 .SH BUGS
 
-The program operates in single-byte chunks regardless of intended encoding.
-.\"
+Npc operates in single-byte chunks regardless of intended encoding.
+
 .SH RATIONALE
 
 POSIX currently lacks a way to display non-printing characters in the terminal
-using a standard tool. A popular extension to
-.BR cat (1p),
-the
-.B -v
-option, is the bandage solution GNU and other software suites use.
+using a standard tool. A popular extension to cat(1p), the -v option, is the
+bandage solution GNU and other software suites use.
+
+This functionality should be a separate tool because its usefulness extends
+beyond that of cat(1p).
 
-This functionality is included in a separate tool because its usefulness extends
-beyond that of
-.BR cat (1p).
-.\"
 .SH AUTHOR
 
-Written by DTB
-.MT trinity@trinity.moe
-.ME .
-.\"
+Written by DTB <trinity@trinity.moe>.
+
 .SH COPYRIGHT
 
 Copyright © 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-.\"
+
 .SH SEE ALSO
-.BR cat (1p),
-.BR cat-v (1),
+
+cat(1p), cat-v(1)
+
 .I UNIX Style, or cat -v Considered Harmful
 by Rob Pike

docs/rpn.1

@@ -3,84 +3,68 @@
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH RPN 1 2024-06-17 "Bonsai Core Utilites 0.13.11"
+
+.TH rpn 1
+
 .SH NAME
+
 rpn \(en reverse polish notation evaluation
-.\"
+
 .SH SYNOPSIS
 
 rpn
-.RB [ numbers... ]
-.RB [ operators... ]
-.\"
+.RB [numbers...]\ [operators...]
+
 .SH DESCRIPTION
 
-Evaluate reverse polish notation.
+Rpn evaluates reverse polish notation expressions either read from the standard
+input or parsed from provided arguments. See the STANDARD INPUT section.
 
-The program evaluates reverse polish notation expressions read either from the
-standard input or parsed from provided arguments. See the STANDARD INPUT
-section.
-
-Upon evaluation, the resulting number on the stack will be printed to the
-standard output. Any further numbers specified will be placed at the end of the
+Upon evaluation, rpn will print the resulting number on the stack to the
+standard output. Any further specified numbers will be placed at the end of the
 stack.
 
-For information on for reverse polish notation syntax, see
-.BR rpn (7).
-.\"
+For information on for reverse polish notation syntax, see rpn(7).
+
 .SH STANDARD INPUT
 
-If arguments are specified, they are interpreted as an expression to be
-evaluated. Otherwise, whitespace-delimited numbers and operations are read from
+If arguments are passed to rpn, it interprets them as an expression to be
+evaluated. Otherwise, it reads whitespace-delimited numbers and operations from
 the standard input.
-.\"
+
 .SH DIAGNOSTICS
 
-In the event of an error, a debug message will be printed and the program will
-exit with the appropriate
-.BR sysexits.h (3)
-error code; however, in the event of a syntax error, the program will print an
-error message and continue accepting input.
-.\"
+If encountering a syntax error, rpn will exit with the appropriate error code
+as defined by sysexits.h(3) and print an error message.
+
 .SH CAVEATS
 
 Due to precision constraints and the way floats are represented in accordance
-with the
-.I IEEE Standard for Floating Point Arithmetic
-(\fIIEEE 754\fP), floating-point arithmetic has rounding errors. This is
-somewhat curbed by using the machine epsilon as provided by the Rust standard
-library to which numbers are rounded. Because of this, variation is expected in
-the number of decimal places the program can handle based on the platform and
-hardware of any given machine.
-.\"
+with the IEEE Standard for Floating Point Arithmetic (IEEE 754), floating-point
+arithmetic has rounding errors. This is somewhat curbed by using the
+machine epsilon as provided by the Rust standard library to which to round
+numbers. Because of this, variation is expected in the number of decimal places 
+rpn can handle based on the platform and hardware of any given machine.
+
 .SH RATIONALE
 
-An infix notation calculation utility,
-.BR bc (1p),
-is included in the POSIX standard, but does not accept expressions as arguments;
-in scripts, any predefined, non-interactive input must be piped into the
-program. A
-.BR dc (1)
-pre-dates the standardized
-.BR bc (1p),
-the latter originally being a preprocessor for the former, and was included in
-Second Edition UNIX and onward. While it implements reverse polish notation, it
-still suffers from being unable to accept an expression as an argument.
-.\"
+An infix notation calculation utility, bc(1p), is included in the POSIX
+standard, but does not accept expressions as arguments; in scripts, any
+predefined, non-interactive input must be piped into the program. A dc(1)
+pre-dates the standardized bc(1p), the latter originally being a preprocessor
+for the former, and was included in UNIX v2 onward. While it implements reverse
+polish notation, it still suffers from being unable to accept an expression as
+an argument.
+
 .SH AUTHOR
 
-Written by Emma Tebibyte
-.MT emma@tebibyte.media
-.ME .
-.\"
+Written by Emma Tebibyte <emma@tebibyte.media>.
+
 .SH COPYRIGHT
 
 Copyright (c) 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-.\"
+
 .SH SEE ALSO
-.BR bc (1p),
-.BR dc (1),
-.BR rpn (7),
-.I IEEE 754
+
+bc(1p), dc(1), rpn(7), IEEE 754

docs/scrut.1

@@ -1,86 +1,93 @@
 .\" Copyright (c) 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH SCRUT 1 2024-06-06 "Bonsai Core Utilites 0.13.11"
+
+.TH scrut 1
+
 .SH NAME
+
 scrut \(en scrutinize file properties
+
 .SH SYNOPSIS
 
 scrut
-.RB ( -LSbcdefgkprsuwx )
+.RB ( -bcdefgkprsuwxLS )
 .RB [ file... ]
-.\"
+
 .SH DESCRIPTION
 
-Determine if files comply with requirements. If the given files comply with the
-specified requirements, the program will exit successfully. Otherwise, it exits
-unsuccessfully.
-.\"
+Scrut determines if given files comply with the opted requirements.
+
 .SH OPTIONS
 
-.IP \fB-L\fB
-Requires the given files to exist and be symbolic links.
-.IP \fB-S\fP
-Requires the given files to exist and be sockets.
-.IP \fB-b\fP
-Requires the given files to exist and be block special files.
-.IP \fB-c\fP
-Requires the given files to exist and be character special files.
-.IP \fB-d\fP
-Requires the given files to exist and be directories.
-.IP \fB-e\fP
-Requires the given files to exist, and is redundant to any other option.
-.IP \fB-f\fP
-Requires the given files to exist and be regular files.
-.IP \fB-g\fP
-Requires the given files to exist and have their set group ID flags set.
-.IP \fB-k\fP
-Requires the given files to exist and have their sticky bit set.
-.IP \fB-p\fP
-Requires the given files to exist and be named pipes.
-.IP \fB-r\fP
-Requires the given files to exist and be readable.
-.IP \fB-u\fP
-Requires the given files to exist and have their set user ID flags set.
-.IP \fB-w\fP
-Requires the given files to exist and be writable.
-.IP \fB-x\fP
-Requires the given files to exist and be executable.
-.\"
-.SH DIAGNOSTICS
+.B -b
+requires the given files to exist and be block special files.
+.PP
+.B -c
+requires the given files to exist and be character special files.
+.PP
+.B -d
+requires the given files to exist and be directories.
+.PP
+.B -e
+requires the given files to exist, and is redundant to any other option.
+.PP
+.B -e
+requires the given files to exist and be regular files.
+.PP
+.B -g
+requires the given files to exist and have their set group ID flags set.
+.PP
+.B -k
+requires the given files to exist and have their sticky bit set.
+.PP
+.B -p
+requires the given files to exist and be named pipes.
+.PP
+.B -r
+requires the given files to exist and be readable.
+.PP
+.B -u
+requires the given files to exist and have their set user ID flags set.
+.PP
+.B -w
+requires the given files to exist and be writable.
+.PP
+.B -x
+requires the given files to exist and be executable.
+.PP
+.B -L
+requires the given files to exist and be symbolic links.
+.PP
+.B -S
+requires the given files to exist and be sockets.
 
-When invoked incorrectly, a debug message will be printed and the program will
-exit with the appropriate
-.BR sysexits.h (3)
-error code.
-.\"
-.SH RATIONALE 
+.SH EXIT STATUS
 
-The 
-.BR test (1p)
-utility contains functionality that was broken out into separate programs. Thus,
-the scope of this program is narrower than it. Notably, the
+Scrut prints a debug message and exits unsuccessfully with the appropriate
+sysexits.h(3) error code if invoked incorrectly. Scrut exits successfully if
+the given files comply with their requirements and unsuccessfully otherwise.
+
+.SH STANDARDS
+
+Scrut is nearly compatible with POSIX's test utility though it is narrower in
+scope. Notably, the
 .B -h
 option is now invalid and therefore shows usage information instead of being an
 alias to the modern
 .B -L
 option.
-.\"
+
 .SH AUTHOR
 
-Written by DTB
-.MT trinity@trinity.moe
-.ME .
-.\"
+Written by DTB <trinity@trinity.moe>.
+
 .SH COPYRIGHT
 
-Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright © 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-.\"
+
 .SH SEE ALSO
-.BR access (3p),
-.BR lstat (3p),
-.BR test (1p)
+
+access(3p), lstat(3p), test(1p)

docs/str.1

@@ -1,60 +1,58 @@
 .\" Copyright (c) 2023–2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH STR 1 2024-06-17 "Bonsai Core Utilites 0.13.11"
+
+.TH STR 1
+
 .SH NAME
-str \(en test string arguments
-.\"
+
+str \(en test the character types of string arguments
+
 .SH SYNOPSIS
 
 str
 .RB [ type ]
 .RB [ string... ]
-.\"
+
 .SH DESCRIPTION
 
-Test the character types of string arguments.
+Str tests each character in an arbitrary quantity of string arguments against
+the function of the same name within ctype(3).
 
-The tests in this program are equivalent to the functions with the same names in
-.BR ctype.h (0p)
-and are the methods by which string arguments are tested.
-.\"
 .SH DIAGNOSTICS
 
-If all tests pass, the program will exit successfully. If any of the tests fail,
-the program will exit unsuccessfully with an error code of 1.
+Str exits successfully if all tests pass and unsuccessfully if a test failed.
+.PP
+Str will exit unsuccessfully if a string is empty, as none of its contents
+passed the test.
+.PP
+Str will print a message to standard error and exit unsuccessfully if used
+improperly.
 
-When invoked incorrectly, a debug message will be printed and the program will
-exit with the appropriate
-.BR sysexits.h (3)
-error code.
-.\"
-.SH CAVEATS
+.SH DEPRECATED FEATURES
 
-None of an empty string\(cqs contents pass any of the tests, so the program will
-exit unsuccessfully if one is specified.
+Str used to have an "isvalue" type as an extension to ctype(3). This was
+removed in favor of using strcmp(1) to compare strings against the empty string
+('').
 
-There\(cqs no way of knowing which argument failed the test without re-testing
+.SH BUGS
+
+There's no way of knowing which argument failed the test without re-testing
 arguments individually.
+.PP
+If a character in a string isn't valid ASCII str will exit unsuccessfully.
 
-If a character in a string isn\(cqt valid ASCII, the program will exit
-unsuccessfully.
-.\"
 .SH AUTHOR
 
-Written by DTB
-.MT trinity@trinity.moe
-.ME .
-.\"
+Written by DTB <trinity@trinity.moe>.
+
 .SH COPYRIGHT
 
-Copyright \(co 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright © 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/gpl.html>.
-.\"
+
 .SH SEE ALSO
-.BR ctype (3p),
-.BR strcmp(1),
-.BR ascii(7)
+
+ctype(3p), strcmp(1), ascii(7)

docs/strcmp.1

@@ -1,76 +1,62 @@
 .\" Copyright (c) 2023–2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH STRCMP 1 2024-06-17 "Bonsai Core Utilites 0.13.11"
+
+.TH STRCMP 1
+
 .SH NAME
+
 strcmp \(en compare strings
-.\"
+
 .SH SYNOPSIS
 
 strcmp
 .RM [ string ]
 .RB [ strings... ]
-.\"
+
 .SH DESCRIPTION
 
-Check whether string arguments are the same.
-.\"
+Strcmp checks whether the given strings are the same.
+Strcmp exits successfully if the strings are identical. Otherwise, strcmp exits
+with the value 1 if an earlier string has a greater byte value than a later
+string (e.g.
+.R strcmp b a
+)
+and 255 if an earlier string has a lesser byte value (e.g.
+.R strcmp a b
+).
+
 .SH DIAGNOSTICS
 
-The program will exit successfully if the strings are identical. Otherwise, it
-will exit with an error code of 1 if a string passed has a lesser byte value
-than one of the prior strings:
+Strcmp will print an error message and exit unsuccessfully with a status
+described in sysexits(3) if used incorrectly (given less than two operands).
 
-.RS
-strcmp b a
-.RE
+.SH UNICODE
 
-or with an error code of 255 if it has a greater byte value than one of the
-prior strings:
+Strcmp will exit unsuccessfully if the given strings are not identical;
+Unicode strings may need to be normalized if the intent is to check visual
+similarity and not byte similarity.
 
-.RS
-strcmp a b
-.RE
-
-When invoked incorrectly, a debug message will be printed and the program will
-exit with the appropriate
-.BR sysexits.h (3)
-error code.
-.\"
-.SH CAVEATS
-
-The program will exit unsuccessfully if the given strings are not identical;
-therefore, Unicode strings may need to be normalized if the intent is to check
-visual similarity and not byte similarity.
-.\"
 .SH RATIONALE
 
 The traditional tool for string comparisons in POSIX and other Unix shells has
-been
-.BR test (1).
-This tool also handles integer comparisons and file scrutiny. These parts of its
-functionality have been broken out into multiple utilities.
+been test(1). This tool also handles integer comparisons and file scrutiny.
+These parts of its functionality have been broken out into multiple utilities.
+
+Strcmp’s functionality may be performed on a POSIX-compliant system with
+test(1p).
 
-This program\(cqs functionality may be performed on a POSIX-compliant system
-with
-.BR test (1p).
-.\"
 .SH AUTHOR
 
-Written by DTB 
-.MT trinity@trinity.moe
-.ME .
-.\"
+Written by DTB <trinity@trinity.moe>.
+
 .SH COPYRIGHT
 
-Copyright \(co 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright © 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/gpl.html>.
-.\"
+
 .SH SEE ALSO
-.BR strcmp (3),
-.BR intcmp (1),
-.BR scrut (1),
-.BR test (1p)
+
+strcmp(3), intcmp(1), scrut(1), test(1p)

docs/swab.1

@@ -1,13 +1,14 @@
 .\" Copyright (c) 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH SWAB 1 2024-06-17 "Bonsai Core Utilites 0.13.11"
+
+.TH swab 1
+
 .SH NAME
+
 swab \(en swap bytes
-.\"
+
 .SH SYNOPSIS
 
 swab
@@ -16,66 +17,55 @@ swab
 .R [
 .B word size
 .R ])
-.\"
-.SH DESCRIPTION
 
-Swap the latter and former halves of a block of bytes.
-.\"
-.SH OPTIONS
+.SH USAGE
+
+Swab swaps the latter and former halves of a block of bytes.
 
-.IP \fB-f\fP
-Ignore SIGINT signal.
-.IP \fB-w\fP
-Configures the word size; that is, the size in bytes of the block size
-on which to operate. The default word size is 2. The word size must be
-cleanly divisible by 2, otherwise the block of bytes being processed can\(cqt be
-halved.
-.\"
 .SH EXAMPLES
 
-The following
-.BR sh (1p)
-line:
+The following sh(1p) line:
 
-.RS
-printf 'hello world!\(rsn' | swab
-.RE
+.R printf 'hello world!\n' | swab
 
 Produces the following output:
 
-.RS
-ehll oowlr!d
-.RE
-.\"
+.R ehll oowlr!d
+
+.SH OPTIONS
+
+The
+.B -f
+option ignores system call interruptions.
+.PP
+The
+.B -w
+option configures the word size; that is, the size in bytes of the block size
+on which to operate. By default the word size is 2. The word size must be
+cleanly divisible by 2, otherwise the block of bytes being processed can't be
+halved.
+
 .SH DIAGNOSTICS
 
-In the event of an error, a debug message will be printed and the program will
-exit with the appropriate
-.BR sysexits.h (3)
-error code.
-.\"
+If an error is encountered in input, output, or invocation, a diagnostic
+message will be written to standard error and swab will exit with the
+appropriate status from sysexits.h(3).
+
 .SH RATIONALE
 
-This program was modeled and named after the
-.B conv=swab
-functionality specified
-in the
-.BR dd (1p)
-utility. It additionally allows the word size to be configured.
+Swab was modeled after the
+.R conv=swab
+functionality specified in the POSIX dd utility but additionally allows the
+word size to be configured.
+.PP
+Swab is useful for fixing the endianness of binary files produced on other
+machines.
 
-This functionality is useful for fixing the endianness of binary files produced
-on other machines.
-.\"
-.SH AUTHOR
-
-Written by DTB
-.MT trinity@trinity.moe
-.ME .
-.\"
 .SH COPYRIGHT
 
-Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright (c) 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-.\"
+
 .SH SEE ALSO
-.BR dd (1p)
+
+dd(1p)

docs/true.1

@@ -1,36 +1,35 @@
 .\" Copyright (c) 2022, 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-.\"
-.TH TRUE 1 2024-06-06 "Bonsai Core Utilites 0.13.11"
+
+.TH TRUE 1
+
 .SH NAME
+
 true \(en do nothing, successfully
-.\"
+
 .SH DESCRIPTION
 
-Do nothing regardless of operands or standard input. An exit code of 0 will
-always be returned.
-.\"
+True does nothing regardless of operands or standard input.
+True will always return an exit code of 0.
+
 .SH RATIONALE
 
-In \fIPOSIX.1-2017\fP,
-.BR true (1p)
-exists for the construction of control flow and loops based on a success. This
-implementation functions as described in that standard.
-.\"
+True exists for the construction of control flow and loops based on a success.
+
+True functions as described in POSIX.1-2017.
+
 .SH AUTHOR
 
-Written by Emma Tebibyte
-.MT emma@tebibyte.media
-.ME .
-.\"
+Written by Emma Tebibyte <emma@tebibyte.media>.
+
 .SH COPYRIGHT
 
 This work is marked with CC0 1.0. To see a copy of this license, visit
 <http://creativecommons.org/publicdomain/zero/1.0>.
-.\"
+
 .SH SEE ALSO
-.BR false (1p),
-.BR true (1p)
+
+false(1p)

src/eep.rs

@@ -1,47 +0,0 @@
-/*
- * Copyright (c) 2024 DTB <trinity@trinity.moe>
- * SPDX-License-Identifier: AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, either version 3 of the License, or (at your option) any
- * later version.
- *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see https://www.gnu.org/licenses/.
- */
-
-use std::{
-	env::args,
-	process::ExitCode,
-	thread::sleep,
-	time::Duration
-};
-
-extern crate sysexits;
-use sysexits::EX_USAGE;
-
-fn usage(s: &str) -> ExitCode {
-	eprintln!("Usage: {} [seconds]", s);
-	ExitCode::from(EX_USAGE as u8)
-}
-
-fn main() -> ExitCode {
-	let argv = args().collect::<Vec<String>>();
-
-	if argv.len() == 2 {
-		if let Ok(s) = argv[1].parse::<u64>() {
-			sleep(Duration::from_secs(s)); /* from_secs needs u64 */
-			ExitCode::SUCCESS
-		} else {
-			usage(&argv[0])
-		}
-	} else {
-		usage(&argv[0])
-	}
-}

src/fop.rs

@@ -26,27 +26,43 @@ extern crate getopt;
 extern crate strerror;
 extern crate sysexits;
 
-use getopt::{ Opt, Parser };
+use getopt::GetOpt;
 use strerror::StrError;
 use sysexits::{ EX_DATAERR, EX_IOERR, EX_UNAVAILABLE, EX_USAGE };
 
 fn main() {
 	let argv = args().collect::<Vec<String>>();
-	let mut d = '\u{1E}'.to_string();
-	let mut arg_parser = Parser::new(&argv, "d:");
+	let mut d = '␞';
+	let usage = format!(
+		"Usage: {} [-d delimiter] index command [args...]",
+		argv[0],
+	);
+	let mut index_arg = 0;
 
-	while let Some(opt) = arg_parser.next() {
+	while let Some(opt) = argv.getopt("d:") {
 		match opt {
-			Ok(Opt('d', Some(arg))) => d = arg,
-			_ => {},
+			Ok(o) => {
+				/* unwrap because Err(OptError::MissingArg) will be returned if
+				 * o.arg is None */
+				let arg = o.arg.unwrap();
+				let arg_char = arg.chars().collect::<Vec<char>>();
+				if arg_char.len() > 1 {
+					eprintln!("{}: {}: Not a character.", argv[0], arg);
+					exit(EX_USAGE);
+				} else { d = arg_char[0]; }
+				index_arg = o.ind as usize;
+			},
+			Err(_) => {
+				eprintln!("{}", usage);
+				exit(EX_USAGE);
+			}
 		};
 	}
 
-	let index_arg = arg_parser.index();
-	let command_arg = arg_parser.index() + 1;
+	let command_arg = index_arg as usize + 1;
 
 	argv.get(command_arg).unwrap_or_else(|| {
-		eprintln!("Usage: {} [-d delimiter] index command [args...]", argv[0]);
+		eprintln!("{}", usage);
 		exit(EX_USAGE);
 	});
 
@@ -57,7 +73,7 @@ fn main() {
 
 	let mut buf = String::new();
 	let _ = stdin().read_to_string(&mut buf);
-	let mut fields = buf.split(&d).collect::<Vec<&str>>();
+	let mut fields = buf.split(d).collect::<Vec<&str>>();
 
 	let opts = argv
 		.iter()

src/getopt-rs/error.rs

@@ -1,95 +0,0 @@
-/*
- * Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
- * SPDX-License-Identifier: AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, either version 3 of the License, or (at your option) any
- * later version.
- * 
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see https://www.gnu.org/licenses/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * 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.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
- *     HOLDER 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.
- */
-
-use std::{ error, fmt };
-
-use crate::ErrorKind::{ self, * };
-
-/// A basic error type for [`Parser`](struct.Parser.html)
-#[derive(Debug, Eq, PartialEq)]
-pub struct Error {
-    culprit: char,
-    kind: ErrorKind,
-}
-
-impl Error {
-    /// Creates a new error using a known kind and the character that caused the
-	/// issue.
-    pub fn new(kind: ErrorKind, culprit: char) -> Self {
-        Self { culprit, kind }
-    }
-
-    /// Returns the [`ErrorKind`](enum.ErrorKind.html) for this error.
-    pub fn kind(self) -> ErrorKind {
-        self.kind
-    }
-}
-
-impl fmt::Display for Error {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        match self.kind {
-            MissingArgument => write!(
-				f, 
-				"option requires an argument -- {:?}",
-				self.culprit,
-			),
-            UnknownOption => write!(f, "unknown option -- {:?}", self.culprit),
-        }
-    }
-}
-
-impl error::Error for Error {
-    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
-        None
-    }
-}

src/getopt-rs/errorkind.rs

@@ -1,61 +0,0 @@
-/*
- * Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
- * SPDX-License-Identifier: AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, either version 3 of the License, or (at your option) any
- * later version.
- * 
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see https://www.gnu.org/licenses/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * 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.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
- *     HOLDER 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.
- */
-
-/// What kinds of errors [`Parser`](struct.Parser.html) can return.
-#[derive(Debug, Eq, PartialEq)]
-pub enum ErrorKind {
-    /// An argument was not found for an option that was expecting one.
-    MissingArgument,
-    /// An unknown option character was encountered.
-    UnknownOption,
-}

src/getopt-rs/lib.rs

@@ -1,72 +0,0 @@
-/*
- * Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
- * SPDX-License-Identifier: AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, either version 3 of the License, or (at your option) any
- * later version.
- * 
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see https://www.gnu.org/licenses/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * 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.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
- *     HOLDER 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.
- */
-
-//! # getopt
-//!
-//! `getopt` provides a minimal, (essentially) POSIX-compliant option parser.
-
-pub use crate::{
-	error::Error,
-	errorkind::ErrorKind,
-	opt::Opt,
-	parser::Parser,
-	result::Result
-};
-
-mod error;
-mod errorkind;
-mod opt;
-mod parser;
-mod result;
-#[cfg(test)]
-mod tests;

src/getopt-rs/opt.rs

@@ -1,89 +0,0 @@
-/*
- * Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
- * SPDX-License-Identifier: AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, either version 3 of the License, or (at your option) any
- * later version.
- * 
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see https://www.gnu.org/licenses/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * 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.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
- *     HOLDER 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.
- */
-
-use std::fmt;
-
-/// A single option.
-///
-/// For `Opt(x, y)`:
-///   - `x` is the character representing the option.
-///   - `y` is `Some` string, or `None` if no argument was expected.
-///
-/// # Example
-///
-/// ```
-/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
-/// use getopt::Opt;
-///
-/// // args = ["program", "-abc", "foo"];
-/// # let args: Vec<String> = vec!["program", "-abc", "foo"]
-/// #     .into_iter()
-/// #     .map(String::from)
-/// #     .collect();
-/// let optstring = "ab:c";
-/// let mut opts = getopt::Parser::new(&args, optstring);
-///
-/// assert_eq!(Opt('a', None), opts.next().transpose()?.unwrap());
-/// assert_eq!(Opt('b', Some("c".to_string())), opts.next().transpose()?.unwrap());
-/// assert_eq!(None, opts.next().transpose()?);
-/// # Ok(())
-/// # }
-/// ```
-#[derive(Debug, Eq, Ord, PartialEq, PartialOrd)]
-pub struct Opt(pub char, pub Option<String>);
-
-impl fmt::Display for Opt {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(f, "Opt({:?}, {:?})", self.0, self.1)
-    }
-}

src/getopt-rs/parser.rs

@@ -1,382 +0,0 @@
-/*
- * Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
- * SPDX-License-Identifier: AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, either version 3 of the License, or (at your option) any
- * later version.
- * 
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see https://www.gnu.org/licenses/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * 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.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
- *     HOLDER 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.
- */
-
-use std::collections::HashMap;
-
-use crate::{ error::Error, errorkind::ErrorKind, opt::Opt, result::Result };
-
-/// The core of the `getopt` crate.
-///
-/// `Parser` is implemented as an iterator over the options present in the given
-/// argument vector.
-///
-/// The method [`next`](#method.next) does the heavy lifting.
-///
-/// # Examples
-///
-/// ## Simplified usage:
-/// ```
-/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
-/// use getopt::Opt;
-///
-/// // args = ["program", "-abc", "foo"];
-/// # let args: Vec<String> = vec!["program", "-abc", "foo"]
-/// #     .into_iter()
-/// #     .map(String::from)
-/// #     .collect();
-/// let mut opts = getopt::Parser::new(&args, "ab:c");
-///
-/// assert_eq!(Some(Opt('a', None)), opts.next().transpose()?);
-/// assert_eq!(1, opts.index());
-/// assert_eq!(Some(Opt('b', Some("c".to_string()))), opts.next().transpose()?);
-/// assert_eq!(2, opts.index());
-/// assert_eq!(None, opts.next());
-/// assert_eq!(2, opts.index());
-/// assert_eq!("foo", args[opts.index()]);
-/// # Ok(())
-/// # }
-/// ```
-///
-/// ## A more idiomatic example:
-/// ```
-/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
-/// use getopt::Opt;
-///
-/// // args = ["program", "-abc", "-d", "foo", "-e", "bar"];
-/// # let mut args: Vec<String> = vec!["program", "-abc", "-d", "foo", "-e", "bar"]
-/// #     .into_iter()
-/// #     .map(String::from)
-/// #     .collect();
-/// let mut opts = getopt::Parser::new(&args, "ab:cd:e");
-///
-/// let mut a_flag = false;
-/// let mut b_flag = String::new();
-/// let mut c_flag = false;
-/// let mut d_flag = String::new();
-/// let mut e_flag = false;
-///
-/// loop {
-///     match opts.next().transpose()? {
-///         None => break,
-///         Some(opt) => match opt {
-///             Opt('a', None) => a_flag = true,
-///             Opt('b', Some(arg)) => b_flag = arg.clone(),
-///             Opt('c', None) => c_flag = true,
-///             Opt('d', Some(arg)) => d_flag = arg.clone(),
-///             Opt('e', None) => e_flag = true,
-///             _ => unreachable!(),
-///         },
-///     }
-/// }
-///
-/// let new_args = args.split_off(opts.index());
-///
-/// assert_eq!(true, a_flag);
-/// assert_eq!("c", b_flag);
-/// assert_eq!(false, c_flag);
-/// assert_eq!("foo", d_flag);
-/// assert_eq!(true, e_flag);
-///
-/// assert_eq!(1, new_args.len());
-/// assert_eq!("bar", new_args.first().unwrap());
-/// # Ok(())
-/// # }
-/// ```
-#[derive(Debug, Eq, PartialEq)]
-pub struct Parser {
-    opts: HashMap<char, bool>,
-    args: Vec<Vec<char>>,
-    index: usize,
-    point: usize,
-}
-
-impl Parser {
-    /// Create a new `Parser`, which will process the arguments in `args`
-	/// according to the options specified in `optstring`.
-    ///
-    /// For compatibility with
-	/// [`std::env::args`](https://doc.rust-lang.org/std/env/fn.args.html),
-    /// valid options are expected to begin at the second element of `args`, and
-	/// `index` is
-    /// initialised to `1`.
-    /// If `args` is structured differently, be sure to call
-	/// [`set_index`](#method.set_index) before the first invocation of
-	/// [`next`](#method.next).
-    ///
-    /// `optstring` is a string of recognised option characters; if a character
-	/// is followed by a colon (`:`), that option takes an argument.
-    ///
-    /// # Note:
-    /// Transforming the OS-specific argument strings into a vector of `String`s
-	/// is the sole responsibility of the calling program, as it involves some
-	/// level of potential information loss (which this crate does not presume
-	/// to handle unilaterally) and error handling (which would complicate the
-	/// interface).
-    pub fn new(args: &[String], optstring: &str) -> Self {
-        let optstring: Vec<char> = optstring.chars().collect();
-        let mut opts = HashMap::new();
-        let mut i = 0;
-        let len = optstring.len();
-
-        while i < len {
-            let j = i + 1;
-
-            if j < len && optstring[j] == ':' {
-                opts.insert(optstring[i], true);
-                i += 1;
-            } else {
-                opts.insert(optstring[i], false);
-            }
-            i += 1;
-        }
-
-        Self {
-            opts,
-            // "explode" the args into a vector of character vectors, to allow
-			// indexing
-            args: args.iter().map(|e| e.chars().collect()).collect(),
-            index: 1,
-            point: 0,
-        }
-    }
-
-    /// Return the current `index` of the parser.
-    ///
-    /// `args[index]` will always point to the the next element of `args`; when
-	/// the parser is
-    /// finished with an element, it will increment `index`.
-    ///
-    /// After the last option has been parsed (and [`next`](#method.next) is
-	/// returning `None`),
-    /// `index` will point to the first non-option argument.
-    pub fn index(&self) -> usize {
-        self.index
-    }
-
-    // `point` must be reset to 0 whenever `index` is changed
-
-    /// Modify the current `index` of the parser.
-    pub fn set_index(&mut self, value: usize) {
-        self.index = value;
-        self.point = 0;
-    }
-
-    /// Increment the current `index` of the parser.
-    ///
-    /// This use case is common enough to warrant its own optimised method.
-    pub fn incr_index(&mut self) {
-        self.index += 1;
-        self.point = 0;
-    }
-}
-
-impl Iterator for Parser {
-    type Item = Result<Opt>;
-
-    /// Returns the next option, if any.
-    ///
-    /// Returns an [`Error`](struct.Error.html) if an unexpected option is
-	/// encountered or if an
-    /// expected argument is not found.
-    ///
-    /// Parsing stops at the first non-hyphenated argument; or at the first
-	/// argument matching "-";
-    /// or after the first argument matching "--".
-    ///
-    /// When no more options are available, `next` returns `None`.
-    ///
-    /// # Examples
-    ///
-    /// ## "-"
-    /// ```
-    /// use getopt::Parser;
-    ///
-    /// // args = ["program", "-", "-a"];
-    /// # let args: Vec<String> = vec!["program", "-", "-a"]
-    /// #     .into_iter()
-    /// #     .map(String::from)
-    /// #     .collect();
-    /// let mut opts = Parser::new(&args, "a");
-    ///
-    /// assert_eq!(None, opts.next());
-    /// assert_eq!("-", args[opts.index()]);
-    /// ```
-    ///
-    /// ## "--"
-    /// ```
-    /// use getopt::Parser;
-    ///
-    /// // args = ["program", "--", "-a"];
-    /// # let args: Vec<String> = vec!["program", "--", "-a"]
-    /// #     .into_iter()
-    /// #     .map(String::from)
-    /// #     .collect();
-    /// let mut opts = Parser::new(&args, "a");
-    ///
-    /// assert_eq!(None, opts.next());
-    /// assert_eq!("-a", args[opts.index()]);
-    /// ```
-    ///
-    /// ## Unexpected option:
-    /// ```
-    /// use getopt::Parser;
-    ///
-    /// // args = ["program", "-b"];
-    /// # let args: Vec<String> = vec!["program", "-b"]
-    /// #     .into_iter()
-    /// #     .map(String::from)
-    /// #     .collect();
-    /// let mut opts = Parser::new(&args, "a");
-    ///
-    /// assert_eq!(
-    ///     "unknown option -- 'b'".to_string(),
-    ///     opts.next().unwrap().unwrap_err().to_string()
-    /// );
-    /// ```
-    ///
-    /// ## Missing argument:
-    /// ```
-    /// use getopt::Parser;
-    ///
-    /// // args = ["program", "-a"];
-    /// # let args: Vec<String> = vec!["program", "-a"]
-    /// #     .into_iter()
-    /// #     .map(String::from)
-    /// #     .collect();
-    /// let mut opts = Parser::new(&args, "a:");
-    ///
-    /// assert_eq!(
-    ///     "option requires an argument -- 'a'".to_string(),
-    ///     opts.next().unwrap().unwrap_err().to_string()
-    /// );
-    /// ```
-    fn next(&mut self) -> Option<Result<Opt>> {
-        if self.point == 0 {
-            /*
-             * Rationale excerpts below taken verbatim from "The Open Group Base
-			 * Specifications Issue 7, 2018 edition", IEEE Std 1003.1-2017
-			 * (Revision of IEEE Std 1003.1-2008).
-             * Copyright © 2001-2018 IEEE and The Open Group.
-             */
-
-            /*
-             * If, when getopt() is called:
-             *      argv[optind]    is a null pointer
-             *      *argv[optind]   is not the character '-'
-             *      argv[optind]    points to the string "-"
-             * getopt() shall return -1 without changing optind.
-             */
-            if self.index >= self.args.len()
-                || self.args[self.index].is_empty()
-                || self.args[self.index][0] != '-'
-                || self.args[self.index].len() == 1
-            {
-                return None;
-            }
-
-            /*
-             * If:
-             *      argv[optind]    points to the string "--"
-             * getopt() shall return -1 after incrementing index.
-             */
-            if self.args[self.index][1] == '-' && self.args[self.index].len() == 2 {
-                self.incr_index();
-                return None;
-            }
-
-            // move past the starting '-'
-            self.point += 1;
-        }
-
-        let opt = self.args[self.index][self.point];
-        self.point += 1;
-
-        match self.opts.get(&opt) {
-            None => {
-                if self.point >= self.args[self.index].len() {
-                    self.incr_index();
-                }
-                Some(Err(Error::new(ErrorKind::UnknownOption, opt)))
-            }
-            Some(false) => {
-                if self.point >= self.args[self.index].len() {
-                    self.incr_index();
-                }
-
-                Some(Ok(Opt(opt, None)))
-            }
-            Some(true) => {
-                let arg: String = if self.point >= self.args[self.index].len() {
-                    self.incr_index();
-                    if self.index >= self.args.len() {
-                        return Some(Err(Error::new(
-									ErrorKind::MissingArgument,
-									opt,
-								)));
-                    }
-                    self.args[self.index].iter().collect()
-                } else {
-                    self.args[self.index]
-                        .clone()
-                        .split_off(self.point)
-                        .iter()
-                        .collect()
-                };
-
-                self.incr_index();
-
-                Some(Ok(Opt(opt, Some(arg))))
-            }
-        }
-    }
-}

src/getopt-rs/result.rs

@@ -1,59 +0,0 @@
-/*
- * Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
- * SPDX-License-Identifier: AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, either version 3 of the License, or (at your option) any
- * later version.
- * 
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see https://www.gnu.org/licenses/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * 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.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
- *     HOLDER 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.
- */
-
-use std::result;
-
-use crate::error::Error;
-
-/// A specialized `Result` type for use with [`Parser`](struct.Parser.html)
-pub type Result<T> = result::Result<T, Error>;

src/getopt-rs/tests.rs

@@ -1,228 +0,0 @@
-/*
- * Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
- * SPDX-License-Identifier: AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, either version 3 of the License, or (at your option) any
- * later version.
- * 
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see https://www.gnu.org/licenses/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * 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.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
- *     HOLDER 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.
- */
-
-use crate::{Opt, Parser};
-
-macro_rules! basic_test {
-    ($name:ident, $expect:expr, $next:expr, [$($arg:expr),+], $optstr:expr) => (
-        #[test]
-        fn $name() -> Result<(), String> {
-            let expect: Option<Opt> = $expect;
-            let args: Vec<String> = vec![$($arg),+]
-				.into_iter()
-				.map(String::from)
-				.collect();
-            let next: Option<String> = $next;
-            let mut opts = Parser::new(&args, $optstr);
-
-            match opts.next().transpose() {
-                Err(error) => {
-                    return Err(format!("next() returned {:?}", error))
-                },
-                Ok(actual) => if actual != expect {
-                    return Err(
-						format!("expected {:?}; got {:?}", expect, actual)
-					)
-                },
-            };
-
-            match next {
-                None => if opts.index() < args.len() {
-                    return Err(format!(
-							"expected end of args; got {:?}", args[opts.index()]
-					))
-                },
-                Some(n) => if args[opts.index()] != n {
-                    return Err(format!(
-							"next arg: expected {:?}; got {:?}",
-							n,
-							args[opts.index()]
-					))
-                },
-            };
-
-            Ok(())
-        }
-    )
-}
-
-#[rustfmt::skip] basic_test!(
-	blank_arg, None, Some(String::new()), ["x", ""], "a"
-);
-#[rustfmt::skip] basic_test!(
-	double_dash, None, Some("-a".to_string()), ["x", "--", "-a", "foo"], "a"
-);
-#[rustfmt::skip] basic_test!(no_opts_1, None, None, ["x"], "a");
-#[rustfmt::skip] basic_test!(
-	no_opts_2, None, Some("foo".to_string()), ["x", "foo"], "a"
-);
-#[rustfmt::skip] basic_test!(
-	no_opts_3, None, Some("foo".to_string()), ["x", "foo", "-a"], "a"
-);
-#[rustfmt::skip] basic_test!(
-	single_dash, None, Some("-".to_string()), ["x", "-", "-a", "foo"], "a"
-);
-#[rustfmt::skip] basic_test!(
-	single_opt,
-	Some(Opt('a', None)),
-	Some("foo".to_string()),
-	["x", "-a", "foo"],
-	"a"
-);
-#[rustfmt::skip] basic_test!(
-	single_optarg,
-	Some(Opt('a', Some("foo".to_string()))),
-	None,
-	["x", "-a", "foo"],
-	"a:"
-);
-
-macro_rules! error_test {
-    ($name:ident, $expect:expr, [$($arg:expr),+], $optstr:expr) => (
-        #[test]
-        fn $name() -> Result<(), String> {
-            let expect: String = $expect.to_string();
-            let args: Vec<String> = vec![$($arg),+]
-				.into_iter()
-				.map(String::from)
-				.collect();
-            let mut opts = Parser::new(&args, $optstr);
-
-            match opts.next() {
-                None => {
-                    return Err(format!(
-							"unexpected successful response: end of options"
-					))
-                },
-                Some(Err(actual)) => {
-                    let actual = actual.to_string();
-
-                    if actual != expect {
-                        return Err(
-							format!("expected {:?}; got {:?}", expect, actual)
-						);
-                    }
-                },
-                Some(Ok(opt)) => {
-                    return Err(
-						format!("unexpected successful response: {:?}", opt)
-					)
-                },
-            };
-
-            Ok(())
-        }
-    )
-}
-
-#[rustfmt::skip] error_test!(
-	bad_opt,
-	"unknown option -- 'b'",
-	["x", "-b"],
-	"a"
-);
-
-#[rustfmt::skip] error_test!(
-	missing_optarg,
-	"option requires an argument -- 'a'",
-	["x", "-a"],
-	"a:"
-);
-
-#[test]
-fn multiple() -> Result<(), String> {
-    let args: Vec<String> = vec!["x", "-abc", "-d", "foo", "-e", "bar"]
-        .into_iter()
-        .map(String::from)
-        .collect();
-    let optstring = "ab:d:e".to_string();
-    let mut opts = Parser::new(&args, &optstring);
-
-    macro_rules! check_result {
-        ($expect:expr) => {
-            let expect: Option<Opt> = $expect;
-            match opts.next().transpose() {
-                Err(error) => {
-					return Err(format!("next() returned {:?}", error));
-				},
-                Ok(actual) => {
-                    if actual != expect {
-                        return Err(
-							format!("expected {:?}; got {:?}", expect, actual)
-						);
-                    }
-                }
-            };
-        };
-    }
-
-    check_result!(Some(Opt('a', None)));
-    check_result!(Some(Opt('b', Some("c".to_string()))));
-    check_result!(Some(Opt('d', Some("foo".to_string()))));
-    check_result!(Some(Opt('e', None)));
-    check_result!(None);
-
-    Ok(())
-}
-
-#[test]
-fn continue_after_error() {
-    let args: Vec<String> = vec!["x", "-z", "-abc"]
-        .into_iter()
-        .map(String::from)
-        .collect();
-    let optstring = "ab:d:e".to_string();
-    for _opt in Parser::new(&args, &optstring) {
-        // do nothing, should not panic
-    }
-}

src/getopt.rs

@@ -0,0 +1,118 @@
+/*
+ * Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ * 
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see https://www.gnu.org/licenses/.
+ */
+
+use std::ffi::{ c_int, c_char, CString, CStr };
+
+pub struct Opt {
+	pub arg: Option<String>,
+	pub ind: i32,
+	pub opt: String,
+}
+
+pub enum OptError {
+	MissingArg(String),
+	UnknownOpt(String),
+}
+
+/* function signature */
+pub trait GetOpt {
+	fn getopt(&self, optstring: &str) -> Option<Result<Opt, OptError>>;
+}
+
+impl GetOpt for Vec<String> {
+    fn getopt(&self, optstring: &str) -> Option<Result<Opt, OptError>> {
+        let c_strings: Vec<_> = self
+			.iter()
+			.cloned()
+			.map(CString::new)
+			.map(Result::unwrap)
+			.collect();
+
+		/* these operations must be separated out into separate operations so
+		 * the CStrings can live long enough */
+        let argv: Vec<_> = c_strings.iter().map(|x| x.as_ptr()).collect();
+        let argv_ptr = argv.as_ptr() as *const *mut c_char;
+        let opts = CString::new(optstring).unwrap().into_raw();
+        let len = self.len() as c_int;
+
+        unsafe { // TODO: enable optind modification
+            match getopt(len, argv_ptr, opts) { 
+				/* From getopt(3p):
+				 *
+				 * The getopt() function shall return the next option character
+				 * specified on the command line.
+				 *
+				 * A <colon> (':') shall be returned if getopt() detects a
+				 * missing argument and the first character of optstring was a
+				 * <colon> (':').
+				 *
+				 * A <question-mark> ('?') shall be returned if getopt()
+				 * encounters an option character not in optstring or detects a
+				 * missing argument and the first character of optstring was not
+				 * a <colon> (':').
+				 *
+				 * Otherwise, getopt() shall return -1 when all command line
+				 * options are parsed. */
+                58 => { /* numerical ASCII value for ':' */
+					Some(Err(OptError::MissingArg(optopt.to_string())))
+				},
+                63 => { /* numerical ASCII value for '?' */
+					Some(Err(OptError::UnknownOpt(optopt.to_string())))
+				},
+				/* From getopt(3p):
+				 *
+				 * If, when getopt() is called:
+				 *
+				 * argv[optind]  is a null pointer
+				 * *argv[optind]  is not the character -
+				 * argv[optind]  points to the string "-"
+				 *
+				 * getopt() shall return -1 without changing optind.  If:
+				 *
+				 * argv[optind]   points to the string "--"
+				 *
+				 * getopt() shall return -1 after incrementing optind. */
+                -1 => return None,
+                opt => {
+					let arg = CStr::from_ptr(optarg)
+						.to_string_lossy()
+						.into_owned();
+
+					Some(Ok(Opt {
+						arg: Some(arg), /* opt argument */
+						ind: optind, /* opt index */
+						opt: opt.to_string(), /* option itself */
+					}))
+				},
+            }
+        }
+    }
+}
+/* binding to getopt(3p) */
+extern "C" {
+	static mut optarg: *mut c_char;
+	static mut _opterr: c_int;
+	static mut optind: c_int;
+	static mut optopt: c_int;
+
+	fn getopt(
+		___argc: c_int,
+		___argv: *const *mut c_char,
+		__shortopts: *const c_char,
+	) -> c_int;
+}

src/mm.c

@@ -106,15 +106,6 @@ oserr(char *s, char *r){
 	} \
 	return retval
 
-/* Prints a usage text, in which s is the program being run (i.e. argv[0]), and
- * returns an exit status appropriate for a usage error. */
-int usage(char *s){
-
-	fprintf(stderr, "Usage: %s (-aenu) (-i [input])... (-o [output])...\n", s);
-
-	return EX_USAGE;
-}
-
 int main(int argc, char *argv[]){
 	int c;
 	struct Files files[2]; /* {read, write} */
@@ -187,15 +178,12 @@ int main(int argc, char *argv[]){
 				k = 1;
 				break;
 			default:
-				retval = usage(argv[0]);
+				fprintf(stderr, "Usage: %s (-aenu) (-i [input])..."
+					" (-o [output])...\n", argv[0]);
+				retval = EX_USAGE;
 				terminate;
 			}
 
-	if(optind != argc){
-		retval = usage(argv[0]);
-		terminate;
-	}
-
 	files[0].s += files[0].s == 0;
 	files[1].s += files[1].s == 0;
 	

src/scrut.c

@@ -1,6 +1,5 @@
 /*
- * Copyright (c) 2023–2024 DTB <trinity@trinity.moe>
- * Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+ * Copyright (c) 2023 DTB <trinity@trinity.moe>
  * SPDX-License-Identifier: AGPL-3.0-or-later
  *
  * This program is free software: you can redistribute it and/or modify it under
@@ -18,15 +17,13 @@
  */
 
 #include <stdio.h> /* fprintf(3), stderr, NULL */
-#include <stdlib.h> /* EXIT_FAILURE, EXIT_SUCCESS */
+#include <stdlib.h> /* EXIT_FAILURE */
 #include <string.h> /* memset(3), strchr(3) */
-#ifndef EX_USAGE
-#	include <sysexits.h>
-#endif
 #include <unistd.h> /* access(3), getopt(3), F_OK, R_OK, W_OK, X_OK */
 #include <sys/stat.h> /* lstat(3), stat struct, S_ISBLK, S_ISCHR, S_ISDIR,
                        * S_ISFIFO, S_ISGID, S_ISREG, S_ISLNK, S_ISSOCK,
                        * S_ISUID, S_ISVTX */
+#include <sysexits.h>
 
 static char args[] = "bcdefghkprsuwxLS";
 static char ops[(sizeof args) / (sizeof *args)];
@@ -60,7 +57,7 @@ int main(int argc, char *argv[]){
 
 	argv += optind;
 	do{	if(access(*argv, F_OK) != 0 || lstat(*argv, &buf) == -1)
-			return EXIT_FAILURE; /* doesn't exist or isn't stattable */
+			return 1; /* doesn't exist or isn't stattable */
 
 		for(i = 0; ops[i] != '\0'; ++i)
 			if(ops[i] == 'e')
@@ -100,8 +97,8 @@ usage:				fprintf(stderr, "Usage: %s (-%s) [file...]\n",
 						&& !S_ISLNK(buf.st_mode))
 					|| (ops[i] == 'S'
 						&& !S_ISSOCK(buf.st_mode)))
-				return EXIT_FAILURE;
+				return 1;
 	}while(*++argv != NULL);
 
-	return EXIT_SUCCESS;
+	return 0;
 }

src/test.rs

@@ -0,0 +1,10 @@
+extern crate strerror;
+
+use strerror::raw_message;
+
+fn main() {
+	stdout.write_all(b"meow\n").unwrap_or_else(|e| {
+		eprintln!("{}", raw_message(e));
+		std::process::exit(1);
+	});
+}