Opened 4 years ago
Closed 4 years ago
#2341 closed defect (fixed)
rascontrol help needs to be improved
Reported by: | Dimitar Misev | Owned by: | Dimitar Misev |
---|---|---|---|
Priority: | major | Milestone: | 10.0 |
Component: | rasmgr | Version: | 9.8 |
Keywords: | Cc: | Peter Baumann | |
Complexity: | Medium |
Description
Try help define
in rascontrol for example, it prints
define user 'username' [-passwd 'password'] [-rights 'rightsstring'] - define user account with symbolic name 'username' 'password' defaults to 'username' (use the raspasswd utility to change) -rights 'rightsstring': the rights granted to the user (default: none; see documentation for valid rights)
The problem is that the arguments are listed in single quotes. It's easy to assume that one needs to specify the username/password/rightsstring in single quotes, which is wrong.
The way you define a new user is
define user myuser -passwd mypassword -rights RW
NOT
define user 'myuser' -passwd 'mypassword' -rights 'RW'
So I suggest to change the help text to
define user USERNAME [-passwd PASSWORD] [-rights RIGHTSSTRING] - define user account with symbolic name USERNAME; PASSWORD defaults to USERNAME if -passwd is not specified; RIGHTSSTRING is the rights granted to the user (default: none; see documentation for valid rights)
I.e. use capital case for the arguments instead of putting them in single quotes. Capital case is pretty standard practice, e.g. check ls --help
.
Note that this applies to all help text, not just define user.
Change History (2)
comment:1 by , 4 years ago
Owner: | changed from | to
---|
comment:2 by , 4 years ago
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
Note:
See TracTickets
for help on using tickets.