From: Mike Brady <4265913+mikebrady@users.noreply.github.com> Date: Thu, 8 Jul 2021 13:38:51 +0000 (+0100) Subject: Update README.md X-Git-Tag: 1.2~105^2~6 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8b31fa4fbae6ba20b238bed58f03c9c43fbf3d79;p=thirdparty%2Fnqptp.git Update README.md --- diff --git a/README.md b/README.md index 74f6fb3..95f6160 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # NQPTP – Not Quite PTP -Briefly, `nqptp` monitors timing data from any [PTP](https://en.wikipedia.org/wiki/Precision_Time_Protocol) clocks – up to 32 – it sees on ports 319 and 320. It maintains records for each clock, identified by Clock ID and IP. +`nqptp` is a daemon that monitors timing data from any [PTP](https://en.wikipedia.org/wiki/Precision_Time_Protocol) clocks – up to 32 – it sees on ports 319 and 320. It maintains records for each clock, identified by Clock ID and IP. -A timing peer list can be sent to `nqptp` over port 9000. The list consists of the letter `T` followed by a space-separated list of the IP numbers of the timing peers. The list replaces any existing timing peer list. +A _timing peer list_ can be sent to `nqptp` over port 9000. The list consists of the letter `T` followed by a space-separated list of the IP numbers of the timing peers. The list replaces any existing timing peer list. Information about the timing peer list's *master clock* is provided via a [POSIX shared memory](https://pubs.opengroup.org/onlinepubs/007908799/xsh/shm_open.html) interface at `/nqptp`. @@ -22,6 +22,10 @@ struct shm_structure { # Installation +This guide is for a recent Linux system with the `systemd` startup system. + +As usual, you should ensure everything is up to date. + #### Please use `git`! As you probably know, you can download the repository in two ways: (1) using `git` to clone it -- recommended -- or (2) downloading the repository as a ZIP archive. Please us the `git` method. The reason it that when you use `git`, the build process can incorporate the `git` build information in the version string you get when you execute the command `$ nqptp -V`.