aboutsummaryrefslogtreecommitdiff
path: root/_doc
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2022-05-13 22:58:22 +0700
committerShulhan <ms@kilabit.info>2022-05-14 01:22:49 +0700
commit69f34312061d5e5ef853fa28e271d93dbcfbbc6c (patch)
tree4254cfea5e3ea686426e549b3f36e46dfc8f4f35 /_doc
parent4e5ae6b15752c0a2a98b3414c5b88e0df43af4e4 (diff)
downloadrescached-69f34312061d5e5ef853fa28e271d93dbcfbbc6c.tar.xz
all: update documentation for resolver
Group each command and examples in its own section.
Diffstat (limited to '_doc')
-rw-r--r--_doc/resolver.adoc20
1 files changed, 17 insertions, 3 deletions
diff --git a/_doc/resolver.adoc b/_doc/resolver.adoc
index 9951ad5..3885315 100644
--- a/_doc/resolver.adoc
+++ b/_doc/resolver.adoc
@@ -63,6 +63,8 @@ Default to "https://127.0.0.1:5380" if its empty.
== COMMANDS
+=== QUERY
+
query <domain / ip-address> [type] [class]::
+
--
@@ -94,6 +96,9 @@ List of valid types,
The "class" parameter is optional, its either IN (default), CS, or HS.
--
+
+=== MANAGING BLOCK.D
+
block.d disable <name>::
+
--
@@ -116,6 +121,8 @@ restarted.
--
+=== MANAGING CACHES
+
caches::
+
--
@@ -137,6 +144,9 @@ Remove the domain name from rescached caches.
If the parameter is "all", it will remove all caches.
--
+
+=== MANAGING ENVIRONMENT
+
env::
+
--
@@ -151,6 +161,9 @@ If the argument is "-", the new environment is read from stdin.
If the environment is valid, the server will be restarted.
--
+
+=== MANAGING HOSTS.D
+
hosts.d create <name>::
+
--
@@ -171,6 +184,8 @@ Get the content of hosts file inside the hosts.d directory by file name.
--
+=== MANAGING RECORD IN HOSTS.D
+
hosts.d rr add <name> <domain> <value>::
+
--
@@ -180,7 +195,6 @@ If the domain name already exists, the new record will be appended
instead of replaced.
--
-
hosts.d rr delete <name> <domain>::
+
--
@@ -195,7 +209,7 @@ Upon exit and success +resolver+ will return 0, or 1 otherwise.
== EXAMPLES
-=== QUERY EXAMPLES
+=== QUERY
Query the IPv4 address for kilabit.info,
@@ -287,7 +301,7 @@ Get the content of hosts file named "myhosts" inside the hosts.d directory,
}
]
-=== MANAGING RECORD ON HOSTS.D
+=== MANAGING RECORD IN HOSTS.D
Add new record "127.0.0.1 my.hosts" to hosts file named "hosts",