[MXS-771] implement maxkeys --help Created: 2016-06-16  Updated: 2016-06-17  Resolved: 2016-06-17

Status: Closed
Project: MariaDB MaxScale
Component/s: maxkeys
Affects Version/s: None
Fix Version/s: 2.1.0

Type: Task Priority: Major
Reporter: VAROQUI Stephane Assignee: Johan Wikman
Resolution: Fixed Votes: 0
Labels: None


 Description   

maxkeys have no description of what it is and how it works.
when no parameters are provide or --help or -h should dispaly a quick usage



 Comments   
Comment by Johan Wikman [ 2016-06-16 ]

Invoking maxkeys with -h or --help will now produce the following output:

usage: ./maxkeys [-h|--help] [directory]
 
This utility writes into the file .secrets, in the specified directory, the
AES encryption key and init vector that are used by the utility maxpasswd,
when encrypting passwords used in the MariaDB MaxScale configuration file.
 
Note that re-creating the .secrets file will invalidate all existing
passwords used in the configuration file.
 
 -h, --help: Display this help.
 
directory  : The directory where the .secrets file should be created.
 
If a specific directory is not provided, the file is created in
/home/wikman/maxscale/var/lib/maxscale.

The default directory depends upon how maxkeys has been build and will by default be /var/lib/maxscale.

Generated at Thu Feb 08 04:01:49 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.