From: Josh Soref Date: Fri, 28 Sep 2018 17:56:00 +0000 (-0400) Subject: README.md: change markdown syntax for shell content X-Git-Tag: dnsdist-1.3.3~89^2~1 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d5f41e30c33b05823f9ba42cdb3931561f408c2e;p=pdns README.md: change markdown syntax for shell content prefer: ```sh command command ``` over ``` $ command $ command ``` --- diff --git a/README.md b/README.md index 884e0e1d8..9f072c7b2 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ SOURCE CODE / GIT ----------------- Source code is available on GitHub: -``` -$ git clone https://github.com/PowerDNS/pdns.git +```sh +git clone https://github.com/PowerDNS/pdns.git ``` This repository contains the sources for the PowerDNS Recursor, the PowerDNS @@ -35,22 +35,22 @@ compiler with C++-2011 support. On Debian 8.0, the following is useful: -``` -$ apt-get install g++ libboost-all-dev libtool make pkg-config libmysqlclient-dev libssl-dev virtualenv +```sh +apt-get install g++ libboost-all-dev libtool make pkg-config libmysqlclient-dev libssl-dev virtualenv ``` When building from git, the following packages are also required: autoconf, automake, ragel, bison and flex, then generate the configure file: -``` -$ autoreconf -vi +```sh +autoreconf -vi ``` To compile a very clean version, use: -``` -$ ./configure --with-modules="" --without-lua --disable-lua-records -$ make +```sh +./configure --with-modules="" --without-lua --disable-lua-records +make # make install ``` @@ -61,8 +61,8 @@ built-in by default and the pipe-backend is compiled for runtime loading. To add multiple modules, try: -``` -$ ./configure --with-modules="bind gmysql gpgsql" +```sh +./configure --with-modules="bind gmysql gpgsql" ``` Note that you will need the development headers for PostgreSQL as well in this case. @@ -91,8 +91,8 @@ You need to compile using gmake - regular make only appears to work, but doesn't The clang compiler installed through FreeBSD's package manager does not expose all of the C++11 features needed under `std=gnuc++11`. Force the compiler to use `std=c++11` mode instead. -``` -$ export CXXFLAGS=-std=c++11 +```sh +export CXXFLAGS=-std=c++11 ``` macOS Notes @@ -100,16 +100,16 @@ macOS Notes PowerDNS Authoritative Server is available through Homebrew: ``` -$ brew install pdns +brew install pdns ``` If you want to compile yourself, the dependencies can be installed using Homebrew. You need to tell configure where to find OpenSSL, too. -``` -$ brew install boost lua pkg-config ragel openssl -$ ./configure --with-modules="" --with-lua PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig -$ make -j4 +```sh +brew install boost lua pkg-config ragel openssl +./configure --with-modules="" --with-lua PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig +make -j4 ``` Additionally, for PostgreSQL support, run `brew install postgresql` and add `--with-modules="gpsql"` to `./configure`. diff --git a/pdns/README-dnsdist.md b/pdns/README-dnsdist.md index 296e56df0..778890993 100644 --- a/pdns/README-dnsdist.md +++ b/pdns/README-dnsdist.md @@ -17,13 +17,13 @@ Make sure to `autoreconf -vi` before running `configure`. Install dependencies from Homebrew: -``` -$ brew install autoconf automake boost libedit libsodium libtool lua pkg-config protobuf +```sh +brew install autoconf automake boost libedit libsodium libtool lua pkg-config protobuf ``` Let configure know where to find libedit: -``` -$ ./configure 'PKG_CONFIG_PATH=/usr/local/opt/libedit/lib/pkgconfig' -$ make +```sh +./configure 'PKG_CONFIG_PATH=/usr/local/opt/libedit/lib/pkgconfig' +make ``` diff --git a/regression-tests/README.md b/regression-tests/README.md index c3f8f1386..3586c5cca 100644 --- a/regression-tests/README.md +++ b/regression-tests/README.md @@ -26,15 +26,15 @@ Automated tests For a more hands-off approach, make sure PowerDNS is built with suitable modules, and use: -``` -$ ./start-test-stop 5300 gmysql +```sh +./start-test-stop 5300 gmysql ``` To start PowerDNS in gmysql mode (including DNSSEC), run all tests, and write reports, using udp port 5300 in the process. Use: -``` -$ ./start-test-stop help +```sh +./start-test-stop help ``` to see all available suites. @@ -80,16 +80,16 @@ feed it to your database if you want to test one of the sql backends. Run PowerDNS as (to test gmysql): -``` -$ ../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./ \ +```sh +../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./ \ --no-shuffle --launch=gmysql --gmysql-dbname=pdnstest --gmysql-user=root \ --fancy-records --query-logging --loglevel=9 \ --cache-ttl=0 --no-config ``` or (to test bind, without DNSSEC): -``` -$ ../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./ \ +```sh +../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./ \ --no-shuffle --launch=bind --bind-config=./named.conf \ --fancy-records --query-logging --loglevel=9 \ --cache-ttl=0 --no-config @@ -97,16 +97,16 @@ $ ../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./ \ or (to test bind with DNSSEC): -``` -$ ./bind-dnssec-setup -$ ../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./ \ +```sh +./bind-dnssec-setup +../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./ \ --no-shuffle --launch=bind --bind-config=./named.conf \ --query-logging --loglevel=9 \ --cache-ttl=0 --no-config ``` Or only sqlite3: -``` +```sh rm powerdns.sqlite3 sqlite3 powerdns.sqlite3 < ../pdns/no-dnssec.schema.sqlite3.sql sqlite3 powerdns.sqlite3 < ../pdns/dnssec.schema.sqlite3.sql @@ -114,7 +114,7 @@ sqlite3 powerdns.sqlite3 < ../pdns/dnssec.schema.sqlite3.sql --transactions --dnssec | sqlite3 powerdns.sqlite3 echo 'analyze;' | sqlite3 powerdns.sqlite3 -$ ../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./ \ +../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./ \ --no-shuffle --launch=gsqlite3 \ --gsqlite3-database=./powerdns.sqlite3 --gsqlite3-dnssec \ --query-logging --loglevel=9 \ @@ -124,8 +124,8 @@ $ ../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./ \ Set the `nameserver` and `port` variables to point to your pdns\_server instance: -``` -$ nameserver=127.0.0.1 port=5300 ./runtests +```sh +nameserver=127.0.0.1 port=5300 ./runtests ``` @@ -140,15 +140,15 @@ files in all subdirectories to see what happened. Debian Jessie notes ------------------- On debian-jessie, most of these tools can be retrieved with: -``` -$ sudo apt-get install validns ldnsutils bind9utils libnet-dns-perl -$ sudo apt-get -t jessie-backports install unbound-host libunbound2 +```sh +sudo apt-get install validns ldnsutils bind9utils libnet-dns-perl +sudo apt-get -t jessie-backports install unbound-host libunbound2 ``` libnet-dns-perl is needed for one dyndns test. This does not install the jdnssec-verifyzone tools. The test that will break without that can be disabled with: -``` +```sh touch tests/verify-dnssec-zone/allow-missing ```