Rearrange wiki
Signed-off-by: Sam Therapy <sam@samtherapy.net>
parent
e56dc13e8e
commit
b900550a3c
5 changed files with 52 additions and 46 deletions
2
Home.md
2
Home.md
|
@ -1,3 +1,3 @@
|
|||
# awl wiki
|
||||
|
||||
--WIP--
|
||||
--WIP--
|
||||
|
|
37
Install.md
37
Install.md
|
@ -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
|
||||
```
|
48
Supported.md
Normal file
48
Supported.md
Normal file
|
@ -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 <!--why--> | 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 |
|
|
@ -1,4 +1,2 @@
|
|||
### Sidebar
|
||||
|
||||
[Installing awl](./Install) \
|
||||
[Manpage](./Man)
|
||||
[Manpage](./awl.1.md)
|
||||
[Feature List](./Supported.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
|
Loading…
Reference in a new issue