opentimestamps: one last make doc.

wader · Sep 26, 2023 · 976a756 · 976a756
1 parent 912f411
commit 976a756
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -122,7 +122,7 @@ mpeg_ts,
 [msgpack](doc/formats.md#msgpack),
 ogg,
 ogg_page,
-opentimestamps,
+[opentimestamps](doc/formats.md#opentimestamps),
 opus_packet,
 [pcap](doc/formats.md#pcap),
 pcapng,

diff --git a/doc/formats.md b/doc/formats.md
@@ -92,7 +92,7 @@
 |[`msgpack`](#msgpack)                                   |MessagePack                                                                                                  |<sub></sub>|
 |`ogg`                                                   |OGG&nbsp;file                                                                                                |<sub>`ogg_page` `vorbis_packet` `opus_packet` `flac_metadatablock` `flac_frame`</sub>|
 |`ogg_page`                                              |OGG&nbsp;page                                                                                                |<sub></sub>|
-|`opentimestamps`                                        |OpenTimestamps&nbsp;file                                                                                     |<sub></sub>|
+|[`opentimestamps`](#opentimestamps)                     |OpenTimestamps&nbsp;file                                                                                     |<sub></sub>|
 |`opus_packet`                                           |Opus&nbsp;packet                                                                                             |<sub>`vorbis_comment`</sub>|
 |[`pcap`](#pcap)                                         |PCAP&nbsp;packet&nbsp;capture                                                                                |<sub>`link_frame` `tcp_stream` `ipv4_packet`</sub>|
 |`pcapng`                                                |PCAPNG&nbsp;packet&nbsp;capture                                                                              |<sub>`link_frame` `tcp_stream` `ipv4_packet`</sub>|
@@ -857,6 +857,33 @@ $ fq -d msgpack torepr file.msgpack
 ### References
 - https://github.com/msgpack/msgpack/blob/master/spec.md
 
+## opentimestamps
+
+### View a full OpenTimestamps file
+
+```
+$ fq dd file.ots
+```
+
+### List the names of the Calendar servers used
+
+```
+$ fq '.operations | map(select(.attestation_type == "calendar") | .url)' file.ots
+```
+
+### Check if there are Bitcoin attestations present
+
+```
+$ fq '.operations | map(select(.attestation_type == "bitcoin")) | length > 0' file.ots
+```
+
+### Authors
+- fiatjaf, https://fiatjaf.com
+
+### References
+- https://opentimestamps.org/
+- https://github.com/opentimestamps/python-opentimestamps
+
 ## pcap
 
 ### Build object with number of (reassembled) TCP bytes sent to/from client IP