midfavila/sbase
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
74dcd46c70
sbase/README

123 lines
5.7 KiB
Plaintext
Raw Normal View History

Add initial README
2014-02-12 09:34:09 -05:00
sbase - suckless unix tools
===========================
sbase is a collection of unix tools that are inherently portable
across UNIX and UNIX-like systems.
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
The following tools are implemented ('*' == finished, '#' == UTF-8 support,
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes.
2015-02-28 08:42:26 -05:00
'=' == implicit UTF-8 support, '|' == audited):
Add an easier to edit "table" of tools in README We need to go through the tools and update this table to reflect current state.
2014-11-20 18:01:56 -05:00
Audit basename(1) 1) be stricter which number of arguments is accepted (1 or 2) 2) basename already returns a pointer to "." is argv[0] is "" 3) No need to check for *p != '/', because basename() only returns a string beginning with '/' which has length 1, so if strlen(p) == 1, the only way for suffix to be "evaluated" is for off to be > 0, being equal to suffix being "", but "" != "/". 4) don't calculate strlen twice for each string. Store it in a ssize_t and check if it's > 0.
2015-02-28 08:48:44 -05:00
UTILITY POSIX 2008 COMPLIANT MISSING OPTIONS
------- -------------------- ---------------
=*| basename yes none
Audit cal(1) 1) Update manpage with the num-syntax. 2) Use size_t for years and derivatives. 3) Use putchar instead of printf wherever possible. 4) Update usage(). 5) Style changes.
2015-03-08 16:28:32 -04:00
=*| cal yes none
Audit cat(1) 1) Fix usage ... spacing 2) use *argv instead of argv[0] in the idiomatic for-loop 3) Stop the naïve usage of "/dev/fd/0" and use plain stdin instead (This also makes error-messages more consistent). 4) Add newline before return 5) Remove comma in manpage
2015-03-01 18:36:51 -05:00
=*| cat yes none
Audit chgrp(1) 1) Refactor manpage so it's actually fun to read. 2) BUGFIX: Call (l)chown properly when the H-flag is specified (only when depth > 0). 3) BUGFIX: Call (l)chown properly when the h-flag is specified (only when depth = 0). 4) BUGFIX: Only recurse() in chgrp() when the initial chownf() succeeds. 5) Style fixes, argv-basing. 6) Rename status to ret for consistency. 7) Add blank line before return.
2015-03-08 18:31:59 -04:00
=*| chgrp yes none
Audit chmod(1) 1) Update manpage, refactor the HLP-section and other wordings. 2) BUGFIX: If chmod() fails, don't recurse. 3) Rewrite the arg-loop, fixing several issues: BUGFIX: Handle multi-flags (e.g. -RH) BUGFIX: Properly handle the termination flag --, error on e.g. --x BUGFIX: Error out on an empty flag -. 4) Refactor logic after the arg-loop, which is now simpler thanks to argv-incremention.
2015-03-05 13:08:28 -05:00
=*| chmod yes none
Audit chown(1) Similar to the chgrp(1)-audit: 1) Refactor manpage so it's actually fun to read 2) BUGFIX: Call (l)chown properly when the H-flag is specified (only when depth > 0) 3) BUGFIX: Call (l)chown properly when the h-flag is specified (only when depth = 0). 4) BUGFIX: Only recurse() in chgrp() when the initial chownf() succeeds. 5) Style fixes, argv-basing. 6) Rename status to ret for consistency. 7) Add blank line before return.
2015-03-08 19:37:34 -04:00
=*| chown yes none
Audit chroot(1) 1) Fix usage() 2) Rename *p to *cmd 3) _exit trick with 126 + (savederrno == ENOENT) 4) return-style-fix
2015-03-02 11:41:58 -05:00
=*| chroot non-posix none
Audit cksum(1) 1) Reorder local variables. 2) Cleanup error messages, use %zu for size_t. 3) combine putchar(' ') and fputs to substitute printf(" %s", s). 4) Fix usage(). 5) argv-argc-usage-fix. 6) Add empty line before return.
2015-03-10 19:13:48 -04:00
=*| cksum yes none
Audit cmp(1) 1) Remove the return-value-enum, which is not necessary for a simple program like this. 2) Don't disallow both l and s to be specified. This is undefined behaviour defined by POSIX, so we don't start demanding things from the user. 3) Replace exit() with return (we are in main). 4) Refactor main loop to never return in the loop, but actually set the same-value and break, which increases readability. 5) Remove the final fclose()'s. The OS will take care of them, no need to become cleansy here. 6) Use idiomatic return-value using same. This concludes the increase of readability in the main-loop.
2015-03-11 06:16:40 -04:00
=*| cmp yes none
Audit cols(1) 1) Refactor manpage. 2) De-globalize local values. 3) update usage(). 4) sort local variable declarations. 5) fix wrong argument in strtonum (3 -> 1). 6) argc-argv style, boolean style. 7) check bytes > 0 before accessing b.lines[i][bytes - 1] relying on len only makes sense but let's not push it. 7) don't break on maxlen > (chars - 1) / 2. This didn't even make sense. 8) _correctly_ calculate cols and rows in a readable way. 9) Rewrite loop over rows and cols in a readable way and using putchar in a loop instead of printf-magic or fputs where not necessary.
2015-03-08 14:33:46 -04:00
#*| cols non-posix none
Add col command col is used to display troff documents in ttys, removing the reverse line feeds generated by .2C in ms. This implementation keeps the limit of 256 lines of 800 characteres of the original implementation.
2015-03-03 04:52:34 -05:00
col yes none
Mark comm(1) as audited in README
2015-03-11 08:47:33 -04:00
=*| comm yes none
Audit cp(1) 1) Refactor the manpage, which has been a bloody mess, documenting fantasy-flags (-d for example) and add a STANDARDS section 2) fix usage() 3) sort ARG-block 4) Check return-value of stat() separately, so a lack of permissions doesn't tell the user "the directory doesn't exist", which could be a bit confusing. 5) Add empty line before return.
2015-03-02 13:15:19 -05:00
=*| cp yes none (-i)
Mark cut(1) and cron(1) as audited in README I finished auditing cut(1) a few minutes ago, and cron(1) is an upstream project which needs to be taken care of upstream (sin's call).
2015-03-11 12:33:08 -04:00
=*| cron non-posix none
#*| cut yes none
Audit date(1) 1) Update usage as already done in the manpage 2) group and sort local variable declarations 3) Be pedantic about the number of options. Don't just ignore it if argc > 1.
2015-03-02 09:12:19 -05:00
=*| date yes none
Audit dirname(1) Be stricter about the number of arguments passed to it.
2015-02-28 13:50:12 -05:00
=*| dirname yes none
Mark du(1) as audited in README
2015-03-11 18:31:26 -04:00
=*| du yes none
Audit echo(1) Just a small change in the manpage.
2015-02-28 14:16:10 -05:00
=*| echo yes none
Audit env(1) 1) Shorten synopsis and reflect this in the manual 2) Use argv0 in usage() 3) Decrement argc in argv-loop for consistency 4) Make it clearer which error-code results from which errno in enprintf 5) Use idiomatic for-loop also for environ. Don't increment these pointers in the loop itself!
2015-03-02 08:50:43 -05:00
=*| env yes none
Audit expand(1) Not much to do here. Forgot a colon in the manpage and some style- changes in the code.
2015-03-12 19:37:37 -04:00
#*| expand yes none
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes.
2015-02-28 08:42:26 -05:00
#* expr yes none
Mark false(1) and true(1) as audited Nothing to be done there.
2015-02-28 09:12:19 -05:00
=*| false yes none
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes.
2015-02-28 08:42:26 -05:00
= find yes none
Audit fold(1) 1) Use num-wording in the manpage, remove offensive remark against the beloved -num-syntax <3. 2) Style changes. 3) Report errors of getline. 4) argv-argc-centric argument loop. 5) Rename r to ret for consistency.
2015-03-13 18:47:41 -04:00
#*| fold yes none
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes.
2015-02-28 08:42:26 -05:00
=* grep yes none
Audit head(1) 1) Use (s)size_t in head(). 2) BUGFIX: only check buf[len - 1] when len > 0, else there would be an overflow when getline returns 0 (which can happen) and a very potential segmentation fault. 3) fix error-messages. 4) update usage(). 5) argv-argc-style. 6) clear up the main loop with if (newline). 7) add newline before return.
2015-03-04 18:58:12 -05:00
=*| head yes none
Audit hostname(1) 1) Be strict about argc 2) Fix a small error in the manpage
2015-02-28 15:22:55 -05:00
=*| hostname non-posix none
Audit kill(1) 1) Refactor the manpage with num-options, optimize wording to be more concise and to the point, pid also specifies process groups. 2) Make int sig const. 3) Remove prototypes. 4) /* not reached */ consistency. 5) Refactor usage() with eprintf. 6) Refactor arg-parser with a switch, use estrtonum 7) Use return instead of exit() in main() 8) argc-argv-correctness.
2015-03-16 07:37:46 -04:00
=*| kill yes none
Audit link(1)
2015-02-28 13:42:26 -05:00
=*| link yes none
Audit ln(1) 1) Clarify behaviour when the f-flag is given and a target is in its own way. 2) Fix usage()-style. 3) Group local variable declarations. 4) reorder args 5) argc style, other boolean style changes 6) improve error messages 7) set argv[argc - 1] to NULL to allow argv-centric loop later 8) BUGFIX: POSIX specifies that when with the f-flag there's a situation where a file stands in its own way for linking it should be ignored. 9) Add weprintf() where possible, so we don't pussy out when there's a small issue. This is sbase ffs!
2015-03-05 15:14:43 -05:00
=*| ln yes none
Audit logger(1) 1) Update manpage to current style 2) Line spacing 3) Local variable grouping 4) check for getline >= 0 instead of != -1 5) error message cleanup
2015-03-06 18:08:43 -05:00
=*| logger yes none
Audit logname(1) 1) Add usage(). 2) Idiomatic argv0-setter. We don't use arg.h, as we do not process flags or arguments. 3) Remove program-name from eprintf-call. This is done in the eprintf- function itself when the DEBUG-define is set. We'll activate it by default later. 4) Add empty line before return.
2015-03-16 19:44:18 -04:00
=*| logname yes none
Update README in regard to ls(1) I marked out -m, -s and -x, because they are either visual flags for interactive mode, which are better solved with tools made for this job, or superfluous in another sense. For example, -s basically "steals" the job from du. In general, some of these options might still be easy to implement. The options -S and -f are important though, as they are sorting-options with real use.
2015-03-17 20:00:13 -04:00
= ls no (-C), -S, -f, (-m), (-s), (-x)
Update *sum(1)-manpages and mark them as finished and audited Now that -c behaves correctly, the tools are pretty much done. Only the manpages were not clear enough what happens when you specify the c-flag. This is fixed now.
2015-03-01 16:59:20 -05:00
=*| md5sum non-posix none
Audit mkdir(1) 1) No need for strchr() in mkdirp or a while-loop. Rewrite it in a sane and readable way. 2) fix usage according to the manpage. 3) order includes, don't align local variables. 4) argc-style-fix. 5) BUGFIX: Don't try to chmod() *argv when mkdir() / mkdirp() failed. 6) Add newline before return in two places.
2015-03-05 12:03:08 -05:00
=*| mkdir yes none
Audit mkfifo(1) 1) Fix usage() 2) Group local variables 3) Idiomatic argv-loop 4) BUGFIX: When the m-flag is specified, POSIX clearly says: "Set the file permission bits of the newly-created FIFO to the specified mode value." This means, that if mkfifo() fails for some reason, it should not try to chmod() the given path (which has been fixed with the "else if") A simple testcase is: $ touch testfile; mkfifo -m 000 testfile; GNU mkfifo(1): ls -l testfile -rw-r--r-- 1 testfile sbase mkfifo(1): ls -l testfile ---------- 1 testfile 5) Add blank line before return
2015-03-02 11:25:29 -05:00
=*| mkfifo yes none
Audit mktemp(1) 1) Unglobalize variables. 2) Sort local variables. 3) Use return instead of exit() in main(). 4) Add empty line before return.
2015-03-17 06:01:33 -04:00
=*| mktemp non-posix none
Audit mv(1) 1) Make argument-naming consistent with other tools (cp(1), ...) 2) style fixes 3) usage() fix 4) BUGFIX: Probably from the old non-arg.h days, the directory- check was only done when argc > 3, but with arg.h, this ignores the case when 3 arguments were given. This is actually a pretty serious issue and I'm glad it's fixed. 5) Moreover, be more verbose when stat() fails and make it clearer what the hell is going on at this checkpoint.
2015-03-04 17:22:43 -05:00
=*| mv yes none (-i)
Audit nice(1) 1) val is sufficient as "int" (read the standard) 2) BUGFIX: If getpriority fails, it returns -1 and sets errno. Previously, it would correctly catch the errno but not take care of the fact that by then val has been decremented by 1. Only change val if the getpriority-call has been successful. 3) Add LIMIT()-macro from st to increase readability. 4) setpriority returns < 0 on failure 5) Remove bikeshedding-comment. Read the standard if you wonder. 6) return-value trick from env(1)
2015-03-02 10:53:13 -05:00
=*| nice yes none
nl: add -l option
2015-03-10 07:49:56 -04:00
= nl no -d, -f, -h, -p
Audit nohup(1) 1) no need to include sys/stat.h 2) remove the enum which just added a layer too thick on this simple program 3) argc-style, other style 4) weprintf instead of enprintf, then save the error-message of execvp before and return the proper status. 5) write consistent "not reached" comment.
2015-03-04 16:39:12 -05:00
=*| nohup yes none
Audit paste(1) Well, basically there was not a lot to do, as I already (fortunately) audited this code a while back. There were only minor style-changes.
2015-03-17 16:30:12 -04:00
#*| paste yes none
Audit printenv(1) 1) argc style 2) safeguard argv-loop as already seen in echo(1) with argc-decrement.
2015-02-28 15:47:17 -05:00
=*| printenv non-posix none
Audit printf(1) Not a lot to do here, I wrote this less than a month ago. The only thing I missed was the newline before return.
2015-03-17 16:43:01 -04:00
#*| printf yes none
Audit pwd(1) Nothing special 1) Update manpage to current style. 2) Reorder functions 3) Logical trickery in getpwd()
2015-03-03 11:24:14 -05:00
=*| pwd yes none
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes.
2015-02-28 08:42:26 -05:00
= readlink non-posix none
Audit split(1) 1) Refactor manpage, add STANDARDS section. 2) Boolean-style-changes. 3) Update usage, reflecting num-idiom also changed in the manpage. 4) Refactor error messages. 5) Also fclose stdin. 6) Empty line before return.
2015-03-17 17:59:48 -04:00
=*| renice yes none
Audit rm(1) 1) One small argc-style-matter 2) manpage cleanup 3) NOTE: The utility-functions will be evaluated separately.
2015-02-28 15:30:20 -05:00
=*| rm yes none (-i)
Audit rmdir(1) 1) style fix (don't arrange local variables) 2) BUGFIX: Previously, if ret was turned 1 for some folder, it would disable the p-flag for every following folders, which is not desired. Instead, the "else if" makes sure that the p-flag-section is only entered when the initial rmdir succeeds. 3) BUGFIX: Previously, the program would cancel with eprintf if it failed to remove one folder in the parent-pathname. This is not desired, as we have other folders pending. Instead, print a warning for the current failing parent-folder, set ret to 1 and break off the loop at this point. This allows to finish the other pending folders without issues.
2015-03-02 09:39:39 -05:00
=*| rmdir yes none
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes.
2015-02-28 08:42:26 -05:00
# sed
seq non-posix none
Audit setsid(1) Nothing special, just a small style-fix.
2015-03-01 18:20:35 -05:00
=*| setsid non-posix none
Update *sum(1)-manpages and mark them as finished and audited Now that -c behaves correctly, the tools are pretty much done. Only the manpages were not clear enough what happens when you specify the c-flag. This is fixed now.
2015-03-01 16:59:20 -05:00
=*| sha1sum non-posix none
=*| sha256sum non-posix none
=*| sha512sum non-posix none
Audit sleep(1) 1) Be strict about argc 2) Use "unsigned" instead of "unsigned int"
2015-02-28 14:10:25 -05:00
=*| sleep yes none
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes.
2015-02-28 08:42:26 -05:00
sort no -m, -o, -d, -f, -i
Audit split(1) 1) Refactor manpage, add STANDARDS section. 2) Boolean-style-changes. 3) Update usage, reflecting num-idiom also changed in the manpage. 4) Refactor error messages. 5) Also fclose stdin. 6) Empty line before return.
2015-03-17 17:59:48 -04:00
=*| split yes none
Audit sponge(1) Just a little usage()-fix. Mark it as audited in README.
2015-03-01 17:42:16 -05:00
=*| sponge non-posix none
Audit strings(1) Only smaller style-changes. I already refactored the underlying logic a while ago.
2015-03-17 18:05:50 -04:00
#*| strings yes none
Mark sync(1) as audited Nothing to be done here.
2015-03-17 18:07:41 -04:00
=*| sync non-posix none
Audit tail(1) 1) Specify default in manpage under flag. 2) Boolean and return value style fixes. 3) argv-argc-centric loop. 4) No need to check for argc == 1 before the fflag-subroutine. 5) Remove indentation. 6) Empty line before return.
2015-03-17 18:24:43 -04:00
=*| tail yes none
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes.
2015-02-28 08:42:26 -05:00
=* tar non-posix none
Audit tee(1) 1) "duplicate" implies that you can only specify two outputs, "multiply" is a better word describing the functionality. 2) fix other wording in the manpage 3) fix usage() 4) reorder local variables 5) fix sizeof() style 6) we need argv later, don't increment argv and rather iterate over argc. 7) Improve error messages, print the filename which the write failed to instead of printing the buffer itself (how much sense does that make, printing 1024 Bytes of garbage?). Also, give the name of the function which failed.
2015-03-04 17:05:11 -05:00
=*| tee yes none
Audit test(1) Only add empty lines before returns, everything else is ok. Also add the STANDARDS-section to the manpage, which was only present as a heading until now.
2015-03-17 18:35:11 -04:00
=*| test yes none
Mark time(1) as finished and audited in README
2015-03-04 18:29:03 -05:00
=*| time yes none
Audit touch(1) Only minor things, as I already worked heavily on this tool a while ago. Fix style in the main loop and wording in the manpage.
2015-03-17 18:38:09 -04:00
=*| touch yes none
Audit tr(1) A tool of my own devising, except from a small style-fix this code has already been triple-checked.
2015-03-17 18:41:22 -04:00
#*| tr yes none
Mark false(1) and true(1) as audited Nothing to be done there.
2015-02-28 09:12:19 -05:00
=*| true yes none
Audit tty(1) 1) Be strict about number of arguments passed 2) Use a simpler logic while returning
2015-02-28 13:59:34 -05:00
=*| tty yes none
Mark uname(1) as audited in README No changes needed.
2015-03-04 18:33:28 -05:00
=*| uname yes none
Audit unexpand(1) I checked the algorithm already a while ago. What was left was a couple of style-fixes.
2015-03-17 18:45:03 -04:00
#*| unexpand yes none
Audit uniq(1) Refactor the manpage and small style-changes in uniq.c. Remove unnecessary "else", we catch argc > 2 earlier already.
2015-03-17 18:59:09 -04:00
=*| uniq yes none
Audit unlink(1) One small thing, use argv0 in usage. Also, add a blank line in link.c which I forgot earlier.
2015-02-28 14:05:22 -05:00
=*| unlink yes none
Audit uudecode(1) Style cleanup, Manpage refactoring.
2015-03-17 19:10:36 -04:00
=*| uudecode yes none
Audit uuencode(1) Style cleanup, Manpage refactoring.
2015-03-17 19:14:56 -04:00
=*| uuencode yes none
Audit wc(1) Style cleanup, Manpage refactoring.
2015-03-17 19:20:19 -04:00
#*| wc yes none
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes.
2015-02-28 08:42:26 -05:00
= xargs no -I, -L, -p, -s, -t, -x
Mark yes(1) as audited in README
2015-02-28 15:12:27 -05:00
=*| yes non-posix none
Add an easier to edit "table" of tools in README We need to go through the tools and update this table to reflect current state.
2014-11-20 18:01:56 -05:00
Minor fix for README
2014-02-12 13:39:13 -05:00
The complement of sbase is ubase[1] which is Linux-specific and
Add initial README
2014-02-12 09:34:09 -05:00
provides all the non-portable tools. Together they are intended to
form a base system similar to busybox but much smaller and suckless.
Building
--------
To build sbase, simply type make. You may have to fiddle with
config.mk depending on your system.
You can also build sbase-box, which generates a single binary
containing all the required tools. You can then symlink the
README: document sbase-box-install rule
2015-02-28 09:40:16 -05:00
individual tools to sbase-box or run: make sbase-box-install
Add initial README
2014-02-12 09:34:09 -05:00
Ideally you will want to statically link sbase. If you are on Linux
we recommend using musl-libc[2].
Portability
-----------
sbase has been compiled on a variety of different operating systems,
including Linux, *BSD, OSX, Haiku, Solaris, SCO OpenServer and others.
Various combinations of operating systems and architectures have also
been built.
You can build sbase with gcc, clang, tcc, nwcc and pcc.
[1] http://git.suckless.org/ubase/
[2] http://www.musl-libc.org/
Reference in New Issue Copy Permalink