summaryrefslogtreecommitdiff
path: root/src/psktool-args.def
diff options
context:
space:
mode:
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>2017-05-31 12:58:58 -0400
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2017-06-05 13:04:55 +0000
commit4feb42dc7a709272d6c198a21cbdeee7ebe27293 (patch)
tree1ef9f1c2ddfa88ea64daf02a5781e97d57f3b090 /src/psktool-args.def
parent417cfe18a10cd8c1f098bc1ca47a02d99c254520 (diff)
downloadgnutls-4feb42dc7a709272d6c198a21cbdeee7ebe27293.tar.gz
clarify documentation and arguments for psktool
* psktool's -p argument should really be short for --pskfile, not --passwd. there is no passwd involved. * the example documentation switches names halfway through, which is confusing. * there is no prompt for a password. do not mention it in the example.
Diffstat (limited to 'src/psktool-args.def')
-rw-r--r--src/psktool-args.def25
1 files changed, 16 insertions, 9 deletions
diff --git a/src/psktool-args.def b/src/psktool-args.def
index 819acdb327..176318b26b 100644
--- a/src/psktool-args.def
+++ b/src/psktool-args.def
@@ -27,11 +27,18 @@ flag = {
};
flag = {
- name = passwd;
+ name = pskfile;
value = p;
arg-type = string;
- descrip = "specify a password file";
- doc = "";
+ descrip = "Specify a pre-shared key file";
+ doc = "This option will specify the pre-shared key file to store the generated keys.";
+};
+
+flag = {
+ name = passwd;
+ aliases = pskfile;
+ descrip = "Specify a pre-shared key file";
+ deprecated;
};
doc-section = {
@@ -46,18 +53,18 @@ doc-section = {
ds-type = 'EXAMPLES';
ds-format = 'texi';
ds-text = <<-_EOT_
-To add a user 'psk_identity' in @file{passwd.psk} for use with GnuTLS run:
+To add a user 'psk_identity' in @file{keys.psk} for use with GnuTLS run:
@example
-$ ./psktool -u psk_identity -p passwd.psk
+$ ./psktool -u psk_identity -p keys.psk
Generating a random key for user 'psk_identity'
-Key stored to passwd.psk
-$ cat psks.txt
+Key stored to keys.psk
+$ cat keys.psk
psk_identity:88f3824b3e5659f52d00e959bacab954b6540344
$
@end example
-This command will create @file{passwd.psk} if it does not exist
-and will add user 'psk_identity' (you will also be prompted for a password).
+This command will create @file{keys.psk} if it does not exist
+and will add user 'psk_identity'.
_EOT_;
};