logo

blog

My website can't be that messy, right? git clone https://anongit.hacktivis.me/git/blog.git/

utils-std.shtml (6233B)

    

  1. <!DOCTYPE html>
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  3. 	<head>
  4. <!--#include file="/templates/head.shtml" -->
  5. 		<title>utils-std — lanodan’s cyber-home</title>
  6. 	<body>
  7. <!--#include file="/templates/en/nav.shtml" -->
  8. <!--#set var="baseName" value='utils-std-0.2.0' -->
  9. <!--#set var="signifyName" value='2026' -->
  10. 	<main>
  11. 		<nav>
  12. 			<a href="/projects/utils-std">Homepage</a>
  13. 			<a href="/git/utils-std.mdoc/">Documentation</a>
  14. 			<a href="/git/utils-std/" rel="vcs-git">Source Code</a>
  15. 			<a href="https://todo.sr.ht/~lanodan/utils-std">Tickets</a>
  16. 			<!--<a href="https://repology.org/project/utils-std/versions">Packages</a>-->
  17. 		</nav>
  19. 		<h1 itemprop="name"><a href="/projects">projects</a>/utils-std</h1>
  20. 		<p itemprop="description">
  21. 			utils-std is a collection of commonly available unix tools (cat, cp, rm, mkdir, …).
  22. 			POSIX is used as a guide, but current Unix systems are the biggest inspiration and compatibility with portable scripts is intended.
  23. 		</p>
  25. 		<h2>Design differences</h2>
  26. 		<ul>
  27. 			<li>Whenever possible programs prefix their messages with their name, then error messages contain "<code>error: </code>", and warning messages contain "<code>warning: </code>". This allows to more easily find what went wrong in logs.</li>
  28. 			<li>When the output is structured data, a terminal gets human-oriented output, others like piped programs get slightly more machine-oriented output.</li>
  29. 			<li>
  30. 				As the <code>utmp</code> and <code>wtmp</code> files are considered broken by design, utilities dependent on them like <code>who</code> and <code>lastlog</code> won't be implemented.
  31. 				Proper authentication logs shouldn't be writable into by multiple programs, some of them third-party (like SSH and Display Managers typically are).
  32. 			</li>
  33. 			<li>Minimal dependencies, allowing to bootstrap utils-std without already having the utilities it implements.</li>
  34. 			<li>No binary blobs, no pre-generated files, even in the testsuite.</li>
  35. 		</ul>
  37. 		<h2>Releases</h2>
  38. 		<p>
  39. 			<strong>Warning!</strong> While utils-std technically can be used
  40. 			in production, not all the utilities are implemented.
  41. 			And it's also not intended to be 100% compatible with another
  42. 			implementation such a coreutils.
  43. 			As such I would currently disrecommend it in environments where
  44. 			the users aren't also capable of debugging shell related issues.
  45. 		</p>
  46. 		<ul>
  47. 			<!--<li>From packages: <a href="https://repology.org/project/utils-std/versions">list of repositories</a></li>-->
  48. 			<li>From source:
  49. 				<code><a href="https://distfiles.hacktivis.me/releases/utils-std/<!--#echo var="baseName" -->.tar.gz"><!--#echo var="baseName" -->.tar.gz</a></code>
  50. 				(<a href="https://distfiles.hacktivis.me/releases/utils-std/<!--#echo var="baseName" -->.tar.gz.sign">signify/minisign</a>)
  51. 				<a href="https://distfiles.hacktivis.me/releases/utils-std/<!--#echo var="baseName" -->.txt">changelog</a>
  52. 			</li>
  53. 		</ul>
  54. 		<p>
  55. 			utils-std is using <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a> with considering that the User-Interface is part of the interface stabilisation.
  56. 			<!--Release branches (ie. <code>1.0.x</code>) are supported for 6 months for any bug fixes and 2 years for security fixes.-->
  57. 		</p>
  58. 		<p>
  59. 			Tarball is signed with signify, you can find the key at <a href="https://distfiles.hacktivis.me/releases/signify/<!--#echo var="signifyName" -->.pub">https://distfiles.hacktivis.me/releases/signify/<!--#echo var="signifyName" -->.pub</a>.
  60. 			For more information (signify implementations, key rotation / lifetime, …) see <a href="https://distfiles.hacktivis.me/releases/signify/README.html">https://distfiles.hacktivis.me/releases/signify/README.html</a>.
  61. 			<br />
  62. 			The command to verify the tarball looks like this: <code><kbd>signify -V -p signify/<!--#echo var="signifyName" -->.pub -x <!--#echo var="baseName" -->.tar.gz.sign -m <!--#echo var="baseName" -->.tar.gz</kbd></code>
  63. 		</p>
  65. 		<h2>Tested and supported platforms</h2>
  66. 		<dl>
  67. 			<dt>OS</dt>
  68. 				<dd>Linux-musl, Linux-glibc, NetBSD, FreeBSD. And Haiku at best effort due to lack of CI</dd>
  69. 			<dt>CPU Architectures</dt>
  70. 				<dd>x86_64/amd64. And armv8+/aarch64, aarch64_be, riscv64 at best effort due to lack of CI</dd>
  71. 			<dt>C Compilers</dt>
  72. 				<dd>GCC, Clang, TinyCC, cproc</dd>
  73. 		</dl>
  74. 		<p>
  75. 			Similar systems should work, feel free to reports tests/bugs and volunteer on testing before releases are published.<br />
  76. 			Proprietary systems (Windows, MacOS, Oracle Solaris, …) are unsupported.
  77. 		</p>
  79. 		<h2 id="contacts">Contacts / Discussions</h2>
  80. 		<dl>
  81. 			<dt>IRC Channel</dt>
  82. 				<dd><a href="ircs://irc.geeknode.org/#utils-std">#utils-std on GeekNode</a></dd>
  83. 			<dt>Reaching main author directly</dt>
  84. 				<dd><a href="/about">contact page</a></dd>
  85. 		</dl>
  87. 		<h2>Tickets (bug, feature request, …)</h2>
  88. 		<p>
  89. 			Use the contact methods above before to confirm where your bug comes from,
  90. 			then you may use <a href="https://todo.sr.ht/~lanodan/utils-std">https://todo.sr.ht/~lanodan/utils-std</a> (no accounts needed).
  91. 		</p>
  92. 		<p>For security issues, sending me an email to <a href="mailto:contact+utils-std@hacktivis.me">contact+utils-std@hacktivis.me</a> is the preferred way.</p>
  94. 		<h2>Contributing</h2>
  95. 		<p>Please try to use one of the contact methods shown above before doing modifications, it seriously helps on integrating your contribution and could also point you at resources if you need help. Feel free to drop me a repository or patches of your local modifications though.</p>
  97. 		<h3>Code</h3>
  98. 		<p>
  99. 			<kbd><code>git clone https://anongit.hacktivis.me/git/utils-std.git</code></kbd> (<a href="https://hacktivis.me/git/utils-std/">WebView</a>)
  100. 			You can then send patches or your repository URL to <a href="mailto:contact+utils-std@hacktivis.me"><code>contact+utils-std@hacktivis.me</code></a>. <code>git send-email</code> is highly recommended, <a href="https://git-send-email.io/">here is a tutorial</a>.
  101. 		</p>
  103. 		<h2>See also</h2>
  104. 		<h3>Own articles</h3>
  105. 		<ol>
  106. 			<li>2024-06-23: <a href="/articles/bootstrap-initrd">bootstrap-initrd: A self-building environment based on tcc+musl</a></li>
  107. 		</ol>
  108. 	</main>
  109. <!--#include file="/templates/en/footer.shtml" -->
  110. 	</body>
  111. </html>