]> git.ipfire.org Git - thirdparty/nqptp.git/commitdiff
Update README.md
authorMike Brady <4265913+mikebrady@users.noreply.github.com>
Sun, 2 May 2021 17:19:08 +0000 (18:19 +0100)
committerGitHub <noreply@github.com>
Sun, 2 May 2021 17:19:08 +0000 (18:19 +0100)
README.md

index 1fb43e7bc8514ed6cfd0732eb674e7f7b36b2c68..68721dd34ece43a495599c9fe23788457da185e0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,10 @@
 # NQPTP – Not Quite PTP
-The `nqptp` daemon monitors PTP traffic. Briefly, `nqptp` monitors the times of 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 its Clock ID and IP. Information about the *master clock* is provided in a [POSIX shared memory](https://pubs.opengroup.org/onlinepubs/007908799/xsh/shm_open.html) interface at `/nqptp`. Here are details of the interface:
+The `nqptp` daemon monitors PTP traffic. Briefly, `nqptp` monitors the times of 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 its Clock ID and IP. Information about the *master clock* is provided in a [POSIX shared memory](https://pubs.opengroup.org/onlinepubs/007908799/xsh/shm_open.html) interface at `/nqptp`. 
+
+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 *completely replaces* any existing timing peer list.
+
+
+Here are details of the interface:
 ```c
 struct shm_structure {
   pthread_mutex_t shm_mutex; // for safely accessing the structure