summaryrefslogtreecommitdiff
path: root/README
blob: dc89f948f8b8a2c426d703fe57531924c182b173 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
URLTOOL
=======

URL tool is a simple shell tool to encode and decode URI encoding as set by
RFC3986.

* `urltool` reads lines from files or stdin and encodes/decodes them onto stdout
* `urlenc` and `urldec` are symlinks to `urltool` that read and encode/decode
   their arguments and output to stdout.


## Build & Install

Only tested on Linux, but should be POSIX compliant. The only dependency is
libc with getline(3).

Just run `./build.sh` to build "normally", you can set $CC and $CFLAGS from env.
If you have `musl-gcc` installed and prefer static executables like me, you can
run `./build-musl.sh` to do so.

By default a debug build with debug information is created. `./build.sh fast`
to build with optimizations on. Assumes GCC-like flags.

`./clean.sh` to remove the build artifacts.

`./install.sh` to install to "${DESTDIR}${PREFIX}/${BINDIR}"

The scripts are tiny so feel free to edit.


## Why?

To help me build shell pipelines that do HTTP GET requests and alike.
See examples/.


## Who?
dweller from cabin.digital