From a209f6747f403f12be32bede27ac6e7859e99988 Mon Sep 17 00:00:00 2001 From: Eric Newberry Date: Fri, 26 Mar 2021 10:52:09 -0700 Subject: [PATCH] docs: use typed name components instead of markers refs #5044 Change-Id: I3083fd733dabca549e5e21d47b42e2dd1e4ea802 --- manpages/ndnpoke.rst | 2 +- manpages/ndnputchunks.rst | 2 +- tools/chunks/README.md | 29 ++++++++++++++--------------- 3 files changed, 16 insertions(+), 17 deletions(-) diff --git a/manpages/ndnpoke.rst b/manpages/ndnpoke.rst index 220464f..e7547d6 100644 --- a/manpages/ndnpoke.rst +++ b/manpages/ndnpoke.rst @@ -33,7 +33,7 @@ Options * Sign with the default certificate of the default key of an identity: ``id:/``. * Sign with the default certificate of a specific key: ``key://ksk-1``. - * Sign with a specific certificate: ``cert://KEY/ksk-1/ID-CERT/%FD%01``. + * Sign with a specific certificate: ``cert://KEY/ksk-1/ID-CERT/v=1``. * Sign with a SHA-256 digest: ``id:/localhost/identity/digest-sha256``. Note that this is only a hash function, not a real signature, but it can significantly speed up packet signing operations. diff --git a/manpages/ndnputchunks.rst b/manpages/ndnputchunks.rst index 6a3b8af..441f9eb 100644 --- a/manpages/ndnputchunks.rst +++ b/manpages/ndnputchunks.rst @@ -50,7 +50,7 @@ Options * Sign with the default certificate of the default key of an identity: ``id:/``. * Sign with the default certificate of a specific key: ``key://ksk-1``. - * Sign with a specific certificate: ``cert://KEY/ksk-1/ID-CERT/%FD%01``. + * Sign with a specific certificate: ``cert://KEY/ksk-1/ID-CERT/v=1``. * Sign with a SHA-256 digest: ``id:/localhost/identity/digest-sha256``. Note that this is only a hash function, not a real signature, but it can significantly speed up packet signing operations. diff --git a/tools/chunks/README.md b/tools/chunks/README.md index d92710f..8b47eea 100644 --- a/tools/chunks/README.md +++ b/tools/chunks/README.md @@ -3,9 +3,9 @@ **ndncatchunks** and **ndnputchunks** are a pair of programs to transfer a file as Data segments. * **ndnputchunks** is a producer program that reads a file from the standard input, and makes - it available as NDN Data segments. It appends version and segment number components - to the specified name, according to the - [NDN naming conventions](http://named-data.net/publications/techreports/ndn-tr-22-ndn-memo-naming-conventions/). + it available as a set of NDN Data segments. It appends version and segment number components + to the specified name as needed, according to the + [NDN naming conventions](https://named-data.net/publications/techreports/ndn-tr-22-2-ndn-memo-naming-conventions/). * **ndncatchunks** is a consumer program that fetches Data segments of a file, optionally discovering the latest version of the file, and writes the content of the retrieved file to @@ -16,8 +16,8 @@ If a version component is present at the end of the user-specified NDN name, the provided version number will be used, without any version discovery process. Otherwise, discovery Interest(s) will be sent out to fetch metadata of the solicited content from which the Data version will be resolved. -For more information about the packet format and naming convention of Interest and Data packets of -version discovery in ndncatchunks, please refer to: +For more information about the packet format and naming conventions of Interest and Data packets +used for version discovery in ndncatchunks, please refer to: [Realtime Data Retrieval (RDR) protocol wiki page](https://redmine.named-data.net/projects/ndn-tlv/wiki/RDR) ## Interest pipeline types in ndncatchunks @@ -50,17 +50,16 @@ for example: ndnputchunks -p /localhost/demo/gpl3 < /usr/share/common-licenses/GPL-3 -This command will print the published version to the standard output. +This command will print the published version to standard output. -To publish Data with a specific version, you must append a version component to the end of the -prefix. The version component must follow the aforementioned NDN naming conventions. -For example, the following command will publish the version `%FD%00%00%01Qc%CF%17v` of the -`/localhost/demo/gpl3` prefix: +To publish Data with a specific version, you need to append a version component to the end of the +prefix. The version component must follow the aforementioned NDN naming conventions. For example, +the following command will publish the version 1449078495094 of the `/localhost/demo/gpl3` prefix: - ndnputchunks /localhost/demo/gpl3/%FD%00%00%01Qc%CF%17v < /usr/share/common-licenses/GPL-3 + ndnputchunks -Nt /localhost/demo/gpl3/v=1449078495094 < /usr/share/common-licenses/GPL-3 -If the version component is not valid, a new well-formed version will be generated and appended -to the supplied NDN name. +If the specified version component is not valid, ndnputchunks will exit with an error. If no version +component is specified, one will be generated and appended to the name. ### Retrieval @@ -69,9 +68,9 @@ To retrieve the latest version of a published file, the following command can be ndncatchunks /localhost/demo/gpl3 To fetch a specific version of a published file, you can specify the version number at the end of -the name. For example, if the version is known to be `%FD%00%00%01Qc%CF%17v`, the following command +the name. For example, if the version is known to be 1449078495094, the following command will fetch that exact version of the file (without version discovery): - ndncatchunks /localhost/demo/gpl3/%FD%00%00%01Qc%CF%17v + ndncatchunks -Nt /localhost/demo/gpl3/v=1449078495094 For more information, run the programs with `--help` as argument.