refine msgtext

Author: xtaci

cmd/hppktool/cmd/encrypt.go

@@ -19,9 +19,9 @@ import (
 // encryptCmd represents the encrypt command
 var encryptCmd = &cobra.Command{
 	Use:   "encrypt",
-	Short: "encrypts a message from standard input",
-	Long: `Encrypt a message with HPPK from standard input.
-The message is first SHA256 hashed, unless -raw is specified`,
+	Short: "Encrypts a message from standard input",
+	Long: `Encrypt a message using HPPK from standard input.
+By default, the message is hashed with SHA256 before encryption, unless the -raw flag is specified.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		silent, err := cmd.Flags().GetBool("silent")
 		if err != nil {
@@ -117,5 +117,5 @@ func init() {
 	// is called directly, e.g.:
 	// encryptCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 	encryptCmd.Flags().StringP("pubkey", "p", "./id_hppk.pub", "the HPPK public key file")
-	encryptCmd.Flags().Bool("raw", false, "encrypt the raw message, the message length must not exceed 256 bytes")
+	encryptCmd.Flags().Bool("raw", false, "Encrypt the raw message without hashing. The message length must not exceed 256 bytes.")
 }

cmd/hppktool/cmd/keygen.go

@@ -16,8 +16,8 @@ import (
 // keygenCmd represents the keygen command
 var keygenCmd = &cobra.Command{
 	Use:     "keygen [directory]",
-	Short:   "generate a hppk private/public key pair",
-	Long:    "Generate a HPPK private/public key pair with given order and save them to the specified directory.",
+	Short:   "Generate an HPPK private/public key pair",
+	Long:    "Generate an HPPK private/public key pair with the specified order and save them to the specified directory.",
 	Example: "hppktool keygen /tmp\n" + "hppktool keygen /tmp --order 5",
 	Args:    cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
@@ -99,5 +99,5 @@ func init() {
 
 	// Cobra supports local flags which will only run when this command
 	// is called directly, e.g.:
-	keygenCmd.Flags().IntP("order", "o", 5, "the order of the polynomial")
+	keygenCmd.Flags().IntP("order", "o", 5, "The degree of the polynomial")
 }

cmd/hppktool/cmd/root.go

@@ -14,7 +14,7 @@ var rootCmd = &cobra.Command{
 	Use:   "hppktool",
 	Short: "HPPK key management tool",
 	Long: `HPPK key management tool.
-HPPK key generation, signing, verification, and secret encryption.`,
+Supports key generation, signing, verification, and secret encryption.`,
 	// Uncomment the following line if your bare application
 	// has an action associated with it:
 	// Run: func(cmd *cobra.Command, args []string) { },
@@ -38,5 +38,5 @@ func init() {
 
 	// Cobra also supports local flags, which will only run
 	// when this action is called directly.
-	rootCmd.PersistentFlags().BoolP("silent", "s", false, "Suppress non-vital message")
+	rootCmd.PersistentFlags().BoolP("silent", "s", false, "Suppress non-essential messages")
 }

cmd/hppktool/cmd/sign.go

@@ -19,9 +19,9 @@ import (
 // signCmd represents the sign command
 var signCmd = &cobra.Command{
 	Use:   "sign",
-	Short: "sign a message from standard input",
-	Long: `Sign a message with HPPK from standard input with a given public key.
-The message is first SHA256 hashed, unless -raw is specified`,
+	Short: "Sign a message from standard input",
+	Long: `Sign a message using HPPK from standard input with the specified public key.
+By default, the message is hashed with SHA256 before signing, unless the -raw flag is specified.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		silent, err := cmd.Flags().GetBool("silent")
 		if err != nil {
@@ -117,6 +117,6 @@ func init() {
 	// Cobra supports local flags which will only run when this command
 	// is called directly, e.g.:
 	// signCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
-	signCmd.Flags().StringP("identity", "p", "./id_hppk", "the hppk private key file")
-	signCmd.Flags().Bool("raw", false, "encrypt the raw message, the message length must not exceed 256 bytes")
+	signCmd.Flags().StringP("identity", "p", "./id_hppk", "the HPPK private key file")
+	signCmd.Flags().Bool("raw", false, "Sign the raw message without hashing. The message length must not exceed 256 bytes.")
 }

cmd/hppktool/cmd/verify.go

@@ -18,9 +18,9 @@ import (
 // verifyCmd represents the verify command
 var verifyCmd = &cobra.Command{
 	Use:   "verify",
-	Short: "verify a message from standard input",
-	Long: `Verify a HPPK signed message from standard input against the signature file and public key.
-The message is first SHA256 hashed, unless -raw is specified`,
+	Short: "Verify a message from standard input",
+	Long: `Verify an HPPK-signed message from standard input against the provided signature file and public key.
+By default, the message is hashed with SHA256 before verification, unless the -raw flag is specified.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		silent, err := cmd.Flags().GetBool("silent")
 		if err != nil {
@@ -130,6 +130,6 @@ func init() {
 	// is called directly, e.g.:
 	// verifyCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 	verifyCmd.Flags().StringP("pubkey", "p", "./id_hppk.pub", "the HPPK public key file to verify against.")
-	verifyCmd.Flags().String("sigfile", "./sigfile", "the signed signature file.")
-	verifyCmd.Flags().Bool("raw", false, "encrypt the raw message, the message length must not exceed 256 bytes.")
+	verifyCmd.Flags().String("sigfile", "./sigfile", "The generated signature file.")
+	verifyCmd.Flags().Bool("raw", false, "Verify the raw message without hashing. The message length must not exceed 256 bytes.")
 }