From abe427d9313c3c4376cd506efd1b6795d3bf084e Mon Sep 17 00:00:00 2001 From: Avril Date: Thu, 10 Mar 2022 14:57:06 +0000 Subject: [PATCH] Fix README.md formatting MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fortune for sink's current commit: Great curse − 大凶 --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4212970..96b96c1 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Command usage is in the form of: `./sink [ []]`. Example: ```shell -$ sink /usr/bin/cat sink.c # Identical to `>>/dev/null 2>&1 cat sink.c` +$ sink /usr/bin/cat sink.c # Identical to `>>/dev/null 0>&1 cat sink.c`, but will not cause cat to error on `stdin` being a redirect to an output stream. ``` When invoked with ``: `execve()`s into the program (if it exists or is found in `$PATH`) with `` and a passed-through `envp` (see below in *Compiler flags* on changing this behaviour.) @@ -19,9 +19,9 @@ Run `make && sudo make install` to build with full optimisations and install `si To build for debugging, run `make debug`. ### Compiler flags -`-DREPLACE_STDERR` - Add to `CFLAGS` when building a target to re-route the program's `stderr` stream to the sink as well. By default, it is left open. -`-DNO_SEARCH_PATH` - Add to `CFLAGS` when building to prevent the program looking up its argument in the `PATH` environment variable. -`-DNO_ENV` - Add to `CFLAGS` when building to prevent `envp` passthrough to the `execve()`'d program. +* `-DREPLACE_STDERR` - Add to `CFLAGS` when building a target to re-route the program's `stderr` stream to the sink as well. By default, it is left open. +* `-DNO_SEARCH_PATH` - Add to `CFLAGS` when building to prevent the program looking up its argument in the `PATH` environment variable. +* `-DNO_ENV` - Add to `CFLAGS` when building to prevent `envp` passthrough to the `execve()`'d program. ### Installation The program must have been built before installation, and installation and uninstallation must be done as root. @@ -41,10 +41,10 @@ To build optimised without stripping the symbol table, run `make release` or `ma For installing *without* stripping the symbol table, run `sudo make install STRIP=true`; the effect is the same as `STRIP=:` which does not work for the `install` target. ### Other targets -`sink` (**default**): stripped `release` target. output: `sink` -`release`: optimised build. output: `sink-release` -`debug`: unoptimised build with debuginfo. output: `sink-debug` -`clean`: remove all previous object and binary output files +* `sink` (**default**): stripped `release` target. output: `sink` +* `release`: optimised build. output: `sink-release` +* `debug`: unoptimised build with debuginfo. output: `sink-debug` +* `clean`: remove all previous object and binary output files ### Environment variables * `PREFIX` - The installation path prefix. Defaults to `/usr/local` if not set.