Skip to content

Commit f567ad2

Browse files
committed
fix docs/index
1 parent 0e08eab commit f567ad2

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

docs/index.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -18,54 +18,55 @@ pluggable storage mechanisms. This DNS server is good for creating services
1818
where your records may change frequently, or you would like to access records
1919
stored in a central system using a mechanism of your choosing.
2020

21-
2221
# Installation
2322

24-
$ npm install named
23+
`$ npm install named`
2524

2625
# Server API
2726

28-
var named = require('./lib/index');
29-
var server = named.createServer();
27+
```js
28+
var named = require('./lib/index');
29+
var server = named.createServer();
3030

31-
server.listen(9999, '127.0.0.1', function() {
32-
console.log('DNS server started on port 9999');
33-
});
31+
server.listen(9999, '127.0.0.1', function() {
32+
console.log('DNS server started on port 9999');
33+
});
3434

35-
server.on('query', function(query) {
36-
var domain = query.name();
37-
var target = new named.SOARecord(domain, {serial: 12345});
38-
// 300 is the ttl for this record
39-
query.addAnswer(domain, target, 300);
40-
server.send(query);
41-
});
35+
server.on('query', function(query) {
36+
var domain = query.name();
37+
var target = new named.SOARecord(domain, { serial: 12345 });
38+
// 300 is the ttl for this record
39+
query.addAnswer(domain, target, 300);
40+
server.send(query);
41+
});
42+
```
4243

4344
Hit this DNS server with `dig` to see some results. Because we are only
4445
handling DNS responses for one record type (SOA or 'Start of Authority'), that
4546
is the response we will see, regardless of the type we make a request for. Dig
4647
is nice about this.
48+
```
49+
$ dig @localhost -p9999 example.com SOA
4750
48-
$ dig @localhost -p9999 example.com SOA
49-
50-
; <<>> DiG 9.7.3-P3 <<>> @localhost -p9999 example.com SOA
51-
; (3 servers found)
52-
;; global options: +cmd
53-
;; Got answer:
54-
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 32739
55-
;; flags: qr rd; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0
56-
;; WARNING: recursion requested but not available
57-
58-
;; QUESTION SECTION:
59-
;example.com. IN SOA
51+
; <<>> DiG 9.7.3-P3 <<>> @localhost -p9999 example.com SOA
52+
; (3 servers found)
53+
;; global options: +cmd
54+
;; Got answer:
55+
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 32739
56+
;; flags: qr rd; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0
57+
;; WARNING: recursion requested but not available
6058
61-
;; ANSWER SECTION:
62-
example.com. 5 IN SOA example.com. hostmaster.example.com. 12345 10 10 10 10
59+
;; QUESTION SECTION:
60+
;example.com. IN SOA
6361
64-
;; Query time: 10 msec
65-
;; SERVER: ::1#9999(::1)
66-
;; WHEN: Wed May 23 19:24:09 2012
67-
;; MSG SIZE rcvd: 109
62+
;; ANSWER SECTION:
63+
example.com.5 IN SOA example.com. hostmaster.example.com. 12345 10 10 10 10
6864
65+
;; Query time: 10 msec
66+
;; SERVER: ::1#9999(::1)
67+
;; WHEN: Wed May 23 19:24:09 2012
68+
;; MSG SIZE rcvd: 109
69+
```
6970

7071
## Named API
7172

@@ -79,14 +80,15 @@ options is an object which may specify:
7980
- name: an optional name used to identify the server
8081

8182
Here is an example a named server listening on port 53
83+
```js
84+
var named = require('named');
8285

83-
var named = require('named');
86+
var server = named.createServer({
87+
name: 'named0'
88+
});
8489

85-
var server = named.createServer({
86-
name: 'named0'
87-
});
88-
89-
server.listen(53);
90+
server.listen(53);
91+
```
9092

9193
## Class: named.Server
9294

@@ -301,6 +303,4 @@ DnsErrors are:
301303
Returns the message that was passed in to the error. The message is a string,
302304
and can be used for logging purposes
303305

304-
## Server Properties
305-
306-
306+
<!--## Server Properties>

0 commit comments

Comments
 (0)