logo

utils-extra

Collection of extra tools for Unixes

README.md (1647B)

    

  1. # utils-extra: Collection of extra tools for Unixes
  2. Copyright 2017-2023 Haelwenn (lanodan) Monnier <contact+utils@hacktivis.me>
  3. SPDX-License-Identifier: MPL-2.0
  5. This is a repository of tools that are typically missing from Unix systems, in a fashion similar to [moreutils](https://joeyh.name/code/moreutils/).
  7. Tested on Linux(musl), FreeBSD, NetBSD, OpenBSD: <https://builds.sr.ht/~lanodan/utils-extra>
  9. ## Goals
  10. - Provide simple generic tools which can be composed with existing others
  11. - Code readability and hackability
  12. - Portability
  13. - Efficiency, but not without sacrificing the other goals
  15. ## Non-Goals
  16. - Implement commonly available tools, this is [utils-std](https://hacktivis.me/git/utils-std)'s purpose
  17. - Also shouldn't reimplement existing tools, although it may conflict with others from time to time
  19. ## Dependencies
  20. - POSIX System
  21. - (optional, test) ATF: <https://github.com/jmmv/atf>
  22. - (optional, test) Kyua: <https://github.com/jmmv/kyua>
  23. - (optional, test) bwrap: <https://github.com/containers/bubblewrap/> For safely overlaying false files on the root filesystem
  24. - (optional, lint) mandoc: <https://mdocml.bsd.lv/> For linting the manual pages
  25. - (optional, lint) shellcheck: <https://www.shellcheck.net/> For linting `./configure` and shell scripts
  27. ## Packaging
  28. - The `./configure` script isn't auto*hell based, you can pass it arguments via key-value arguments or environment variables
  29. - You can define the `NO_BWRAP` environment variable to skip the bwrap-based tests which can cause issues in some environments like Gentoo `sandbox`
  30. - If you want statically linked executables, define `LDSTATIC=-static` in the environment