From b900550a3c7eb7977feb9da5590c67fa08798a83 Mon Sep 17 00:00:00 2001 From: Sam Therapy Date: Mon, 25 Jul 2022 23:09:11 +0200 Subject: [PATCH] Rearrange wiki Signed-off-by: Sam Therapy --- Home.md | 2 +- Install.md | 37 ----------------------------------- Supported.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++ _Sidebar.md | 6 ++---- Man.md => awl.1.md | 5 +---- 5 files changed, 52 insertions(+), 46 deletions(-) delete mode 100644 Install.md create mode 100644 Supported.md rename Man.md => awl.1.md (94%) diff --git a/Home.md b/Home.md index 28a86a8..95cad80 100644 --- a/Home.md +++ b/Home.md @@ -1,3 +1,3 @@ # awl wiki ---WIP-- \ No newline at end of file +--WIP-- diff --git a/Install.md b/Install.md deleted file mode 100644 index b7b0e78..0000000 --- a/Install.md +++ /dev/null @@ -1,37 +0,0 @@ -# Installing - -## From releases - -Binaries for the major operating systems can be found at [https://git.froth.zone/sam/awl/releases](https://git.froth.zone/sam/awl/releases). - -## From source -Dependencies: - * Go >= 1.18 - * GNU Make (optional, for makefile) - * Plan 9 Mk (optional, for makefile) - * scdoc (optional, for the manpage) - -### go install - -Running Go >= 1.18: -```sh -go install git.froth.zone/sam/awl@latest -``` -will install to your $GOPATH - -## From repo -A GNU makefile and Plan 9 mkfile are provided: -```sh -[g]make install -``` -```rc -mk install -``` - -For the documentation: -```sh -[g]make install_doc -``` -```rc -mk install_doc -``` diff --git a/Supported.md b/Supported.md new file mode 100644 index 0000000..cd73fb0 --- /dev/null +++ b/Supported.md @@ -0,0 +1,48 @@ +# Feature list + +Inspired by https://github.com/natesales/q#feature-comparison + +## DNS RFCs + +| RFC | Supported? | +| --------------- | -------------------------------- | +| RFC1034 (TCP) | Yes, `--tcp` or `+tcp` | +| RFC7858 (TLS) | Yes, `--tls` or `+tls` | +| RFC8484 (HTTPS) | Yes, `--https` or `+https` | +| RFC7858 (QUIC) | Yes, `--quic` or `+quic` | +| nil (DNSCrypt) | Yes, `--dnscrypt` or `+dnscrypt` | + +## Output Types + +| Format | Supported? | +| -------------- | -------------------- | +| Dig-style | Yes | +| Colours | _**NO**_ | +| JSON | Yes, `-j` or `+json` | +| XML | Yes, `-X` or `+xml` | +| YAML (QUIC) | Yes, `-y` or `+yaml` | + +## Output options + +| Toggle... | Supported? | +| ---------- | ----------------------------------------- | +| Header | No :( | +| Question | Yes, `--no-question` or `+noquestion` | +| Answer | Yes, `--no-answer` or `+noanswer` | +| Authority | Yes, `--no-authority` or `+noauthority` | +| Additional | Yes, `--no-additional` or `+noadditional` | +| Statistics | Yes, `--no-statistics` or `+nostats` | + +## Query flags + +| Flag | Supported? | +| ---- | ---------- | +| AA | Yes | +| AD | Yes | +| CD | Yes | +| RD | Yes | +| RA | Yes | +| QR | Yes | +| Z | Yes | +| TC | Yes | +| DO | Yes | diff --git a/_Sidebar.md b/_Sidebar.md index d6923eb..896934b 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -1,4 +1,2 @@ -### Sidebar - -[Installing awl](./Install) \ -[Manpage](./Man) \ No newline at end of file +[Manpage](./awl.1.md) +[Feature List](./Supported.md) \ No newline at end of file diff --git a/Man.md b/awl.1.md similarity index 94% rename from Man.md rename to awl.1.md index 04884ce..0799e0a 100644 --- a/Man.md +++ b/awl.1.md @@ -1,6 +1,3 @@ -This is potentially out of date (not updated automatically), check [here](https://git.froth.zone/sam/awl/src/branch/master/doc/awl.1.md) for the most up-to-date version - ---- awl(1) # NAME @@ -18,7 +15,7 @@ _type_ is the DNS resource type (*example: AAAA*) *awl* (*a*wls *w*ant *l*icorice) is a simple tool designed to make DNS queries, much like the venerable _dig_(1). An awl is a tool used to make small holes, -typically used in tannery (leatherworking). +typically used in leatherworking. *awl* is designed to be a more "modern" version of _drill_(1) by including some more recent RFCs and output options. *awl* is still heavily