From: Sergey Matveev <stargrave@stargrave.org>
Date: Sat, 12 Apr 2025 06:57:58 +0000 (+0300)
Subject: Slightly better usage information
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=a1591fdfed5d30a7486e728060727b16346e3fe34cbee8e1543b3b3ce79fa19e;p=keks.git

Slightly better usage information
---

diff --git a/c/cmd/pub-verify/pub-verify.c b/c/cmd/pub-verify/pub-verify.c
index 3041e12..d55e309 100644
--- a/c/cmd/pub-verify/pub-verify.c
+++ b/c/cmd/pub-verify/pub-verify.c
@@ -1,4 +1,4 @@
-// CKEKS -- C99 KEKS encoder implementation
+// pub-verify -- verify a chain of cm/pub keys
 // Copyright (C) 2024-2025 Sergey Matveev <stargrave@stargrave.org>
 //
 // This program is free software: you can redistribute it and/or modify
diff --git a/c/cmd/test-vector/test-vector.c b/c/cmd/test-vector/test-vector.c
index f49862f..ecb204c 100644
--- a/c/cmd/test-vector/test-vector.c
+++ b/c/cmd/test-vector/test-vector.c
@@ -1,3 +1,18 @@
+// test-vector -- KEKS test structure
+// Copyright (C) 2024-2025 Sergey Matveev <stargrave@stargrave.org>
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as
+// published by the Free Software Foundation, version 3 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 #include <assert.h>
 #include <stdbool.h>
 #include <stdint.h>
diff --git a/go/cmd/pp/main.go b/go/cmd/pp/main.go
index cedfd42..3099959 100644
--- a/go/cmd/pp/main.go
+++ b/go/cmd/pp/main.go
@@ -1,4 +1,4 @@
-// GoKEKS -- Go KEKS codec implementation
+// test-vector -- KEKS test structure
 // Copyright (C) 2024-2025 Sergey Matveev <stargrave@stargrave.org>
 //
 // This program is free software: you can redistribute it and/or modify
@@ -33,6 +33,19 @@ import (
 	"go.cypherpunks.su/tai64n/v4"
 )
 
+func usage() {
+	fmt.Fprintf(os.Stderr, `Usage: pp [options] <DATA.keks
+
+`)
+	flag.PrintDefaults()
+	fmt.Fprintf(os.Stderr, `
+/that/keks/path specifies some exact element of the structure.
+For example, /sigs/0/tbs will show only tbs field of the first signature in
+cm/pub structure. With "-v -p /sigs/0/tbs/sid" option you will get hexadecimal
+value of the signature's sid.
+`)
+}
+
 var (
 	MaxStrLen = flag.Uint("max-str-len", 64,
 		"Maximal string length to print")
@@ -144,7 +157,11 @@ func printer(iter *keks.Iterator, where []string, count int, inList, inMap bool)
 			}
 		case types.Hexlet:
 			h := iter.Hexlet()
-			fmt.Println(h.UUID(), h.IP())
+			if *onlyV {
+				fmt.Println(h.UUID())
+			} else {
+				fmt.Println(h.UUID(), h.IP())
+			}
 		case types.UInt:
 			fmt.Println(iter.UInt())
 		case types.Int:
@@ -234,6 +251,7 @@ func printer(iter *keks.Iterator, where []string, count int, inList, inMap bool)
 }
 
 func main() {
+	flag.Usage = usage
 	flag.Parse()
 	if *pthStr != "" {
 		pth = strings.Split(strings.TrimLeft(*pthStr, "/"), "/")
diff --git a/go/cmd/schema-validate/main.go b/go/cmd/schema-validate/main.go
index b5927ee..f78673b 100644
--- a/go/cmd/schema-validate/main.go
+++ b/go/cmd/schema-validate/main.go
@@ -1,4 +1,4 @@
-// schema-validate KEKS data structures validator
+// schema-validate -- KEKS data structures validator
 // Copyright (C) 2024-2025 Sergey Matveev <stargrave@stargrave.org>
 //
 // This program is free software: you can redistribute it and/or modify
diff --git a/go/cmd/test-vector-anys/main.go b/go/cmd/test-vector-anys/main.go
index f85c83e..80ca7b3 100644
--- a/go/cmd/test-vector-anys/main.go
+++ b/go/cmd/test-vector-anys/main.go
@@ -1,3 +1,18 @@
+// test-vector-anys -- KEKS test structure with any-types
+// Copyright (C) 2024-2025 Sergey Matveev <stargrave@stargrave.org>
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as
+// published by the Free Software Foundation, version 3 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 package main
 
 import (
diff --git a/go/cmd/test-vector-manual/main.go b/go/cmd/test-vector-manual/main.go
index d8d6679..6e71f39 100644
--- a/go/cmd/test-vector-manual/main.go
+++ b/go/cmd/test-vector-manual/main.go
@@ -1,3 +1,18 @@
+// test-vector-manual -- KEKS test structure with manually encoded fields
+// Copyright (C) 2024-2025 Sergey Matveev <stargrave@stargrave.org>
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as
+// published by the Free Software Foundation, version 3 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 package main
 
 import (
diff --git a/go/cmd/textdump-tester/main.go b/go/cmd/textdump-tester/main.go
index d9076bb..ad15cd7 100644
--- a/go/cmd/textdump-tester/main.go
+++ b/go/cmd/textdump-tester/main.go
@@ -1,4 +1,4 @@
-// GoKEKS -- Go KEKS codec implementation
+// textdump-tester -- test utility for Python's textdump-tester
 // Copyright (C) 2024-2025 Sergey Matveev <stargrave@stargrave.org>
 //
 // This program is free software: you can redistribute it and/or modify