ipa passwd: make help for --otp option clearer

Update help for the `--otp` option in `ipa passwd`
to actually explain its usage.

Fixes: https://pagure.io/freeipa/issue/8244
Signed-off-by: Antonio Torres <antorres@redhat.com>
Reviewed-By: Rob Crittenden <rcritten@redhat.com>
Reviewed-By: Florence Blanc-Renaud <frenaud@redhat.com>
This commit is contained in:
Antonio Torres 2021-02-17 13:49:39 +01:00 committed by Alexander Bokovoy
parent 6cd544d38e
commit e820e2d1a8

View File

@ -47,11 +47,17 @@ is used. This is so the end-user is the only one who knows the password.
The IPA password policy controls how often a password may be changed, The IPA password policy controls how often a password may be changed,
what strength requirements exist, and the length of the password history. what strength requirements exist, and the length of the password history.
If the user authentication method is set to password+OTP, the user should
pass the --otp option when resetting the password.
EXAMPLES: EXAMPLES:
To reset your own password: To reset your own password:
ipa passwd ipa passwd
To reset your own password when password+OTP is set as authentication method:
ipa passwd --otp
To change another user's password: To change another user's password:
ipa passwd tuser1 ipa passwd tuser1
""") """)
@ -105,7 +111,7 @@ class passwd(Command):
takes_options = ( takes_options = (
Password('otp?', Password('otp?',
label=_('OTP'), label=_('OTP'),
doc=_('One Time Password'), doc=_('The OTP if the user has a token configured'),
confirm=False, confirm=False,
), ),
) )