sh_quote/README.md

40 lines
886 B
Markdown
Raw Permalink Normal View History

2022-09-11 16:51:37 +02:00
# Shell quoting util
This tool was made to handle a specific edge case in shell scripting.
When you want to supply a command to some tool as a shell string, but you only have it as already expanded array.
This doesn't work as expected because `$@` is expanded, ending up as multiple arguments to `su`:
```
su -c "$@"
```
This does work as expected:
```
su -c "$(sh_quote "$@")"
```
Because all arguments must be relayed, `-h` or `--help` cannot be taken into account, so there is no helptext.
When no arguments are given, it returns without producing any output.
# Error messages
None. This program cannot fail.
If stdout is not writable, no sensible output will be generated.
If `$0` is not set, no output will be generated.
# Building
Run `make`.
# Testing
Run `make test`
2022-10-18 03:18:07 +02:00
The test script can also run on arbitrary programs: `./test_sh_quote /path/to/other_program`.