]> git.proxmox.com Git - pve-docs.git/blobdiff - pveum.1-synopsis.adoc
build: refactor build process
[pve-docs.git] / pveum.1-synopsis.adoc
index 9fc272394dd46a1f8f7a3677e7351dc8ed8a713d..865c98362b61f5338d44139c30830177a52537e6 100644 (file)
 *pveum* `<COMMAND> [ARGS] [OPTIONS]`
 
-*pveum acldel* `<path> -roles <string>` `[OPTIONS]`
+*pveum acldel* `<path> --roles <string>` `[OPTIONS]`
 
 Update Access Control List (add or remove permissions).
 
-`<path>` `string` ::
+`<path>`: `<string>` ::
 
 Access control path
 
-`-groups` `string` ::
+`--groups` `<string>` ::
 
 List of groups.
 
-`-propagate` `boolean` (default=`1`)::
+`--propagate` `<boolean>` ('default =' `1`)::
 
 Allow to propagate (inherit) permissions.
 
-`-roles` `string` ::
+`--roles` `<string>` ::
 
 List of roles.
 
-`-users` `string` ::
+`--users` `<string>` ::
 
 List of users.
 
-
-
-*pveum aclmod* `<path> -roles <string>` `[OPTIONS]`
+*pveum aclmod* `<path> --roles <string>` `[OPTIONS]`
 
 Update Access Control List (add or remove permissions).
 
-`<path>` `string` ::
+`<path>`: `<string>` ::
 
 Access control path
 
-`-groups` `string` ::
+`--groups` `<string>` ::
 
 List of groups.
 
-`-propagate` `boolean` (default=`1`)::
+`--propagate` `<boolean>` ('default =' `1`)::
 
 Allow to propagate (inherit) permissions.
 
-`-roles` `string` ::
+`--roles` `<string>` ::
 
 List of roles.
 
-`-users` `string` ::
+`--users` `<string>` ::
 
 List of users.
 
-
-
-
 *pveum groupadd* `<groupid>` `[OPTIONS]`
 
 Create new group.
 
-`<groupid>` `string` ::
+`<groupid>`: `<string>` ::
 
 no description available
 
-`-comment` `string` ::
+`--comment` `<string>` ::
 
 no description available
 
-
-
 *pveum groupdel* `<groupid>`
 
 Delete group.
 
-`<groupid>` `string` ::
+`<groupid>`: `<string>` ::
 
 no description available
 
-
-
 *pveum groupmod* `<groupid>` `[OPTIONS]`
 
 Update group data.
 
-`<groupid>` `string` ::
+`<groupid>`: `<string>` ::
 
 no description available
 
-`-comment` `string` ::
+`--comment` `<string>` ::
 
 no description available
 
-
-
-
-*pveum help* `[<cmd>]` `[OPTIONS]`
+*pveum help* `[OPTIONS]`
 
 Get help about specified command.
 
-`<cmd>` `string` ::
+`--extra-args` `<array>` ::
 
-Command name
+Shows help for a specific command
 
-`-verbose` `boolean` ::
+`--verbose` `<boolean>` ::
 
 Verbose output format.
 
-
-
-
 *pveum passwd* `<userid>`
 
 Change user password.
 
-`<userid>` `string` ::
+`<userid>`: `<string>` ::
 
 User ID
 
-
-
-
 *pveum roleadd* `<roleid>` `[OPTIONS]`
 
 Create new role.
 
-`<roleid>` `string` ::
+`<roleid>`: `<string>` ::
 
 no description available
 
-`-privs` `string` ::
+`--privs` `<string>` ::
 
 no description available
 
-
-
 *pveum roledel* `<roleid>`
 
 Delete role.
 
-`<roleid>` `string` ::
+`<roleid>`: `<string>` ::
 
 no description available
 
-
-
-*pveum rolemod* `<roleid> -privs <string>` `[OPTIONS]`
+*pveum rolemod* `<roleid> --privs <string>` `[OPTIONS]`
 
 Create new role.
 
-`<roleid>` `string` ::
+`<roleid>`: `<string>` ::
 
 no description available
 
-`-append` `boolean` ::
+`--append` `<boolean>` ::
 
 no description available
 +
 NOTE: Requires option(s): `privs`
 
-`-privs` `string` ::
+`--privs` `<string>` ::
 
 no description available
 
-
-
-
 *pveum ticket* `<username>` `[OPTIONS]`
 
 Create or verify authentication ticket.
 
-`<username>` `string` ::
+`<username>`: `<string>` ::
 
 User name
 
-`-otp` `string` ::
+`--otp` `<string>` ::
 
 One-time password for Two-factor authentication.
 
-`-path` `string` ::
+`--path` `<string>` ::
 
 Verify ticket, and check if user have access 'privs' on 'path'
 +
 NOTE: Requires option(s): `privs`
 
-`-privs` `string` ::
+`--privs` `<string>` ::
 
 Verify ticket, and check if user have access 'privs' on 'path'
 +
 NOTE: Requires option(s): `path`
 
-`-realm` `string` ::
-
-You can optionally pass the realm using this parameter. Normally the realm
-is simply added to the username <username>@<relam>.
-
-
+`--realm` `<string>` ::
 
+You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
 
 *pveum useradd* `<userid>` `[OPTIONS]`
 
 Create new user.
 
-`<userid>` `string` ::
+`<userid>`: `<string>` ::
 
 User ID
 
-`-comment` `string` ::
+`--comment` `<string>` ::
 
 no description available
 
-`-email` `string` ::
+`--email` `<string>` ::
 
 no description available
 
-`-enable` `boolean` (default=`1`)::
+`--enable` `<boolean>` ('default =' `1`)::
 
 Enable the account (default). You can set this to '0' to disable the accout
 
-`-expire` `integer (0 - N)` ::
+`--expire` `<integer> (0 - N)` ::
 
-Account expiration date (seconds since epoch). '0' means no expiration
-date.
+Account expiration date (seconds since epoch). '0' means no expiration date.
 
-`-firstname` `string` ::
+`--firstname` `<string>` ::
 
 no description available
 
-`-groups` `string` ::
+`--groups` `<string>` ::
 
 no description available
 
-`-keys` `string` ::
+`--keys` `<string>` ::
 
 Keys for two factor auth (yubico).
 
-`-lastname` `string` ::
+`--lastname` `<string>` ::
 
 no description available
 
-`-password` ::
+`--password` `<password>` ::
 
 Initial password.
 
-
-
 *pveum userdel* `<userid>`
 
 Delete user.
 
-`<userid>` `string` ::
+`<userid>`: `<string>` ::
 
 User ID
 
-
-
 *pveum usermod* `<userid>` `[OPTIONS]`
 
 Update user configuration.
 
-`<userid>` `string` ::
+`<userid>`: `<string>` ::
 
 User ID
 
-`-append` `boolean` ::
+`--append` `<boolean>` ::
 
 no description available
 +
 NOTE: Requires option(s): `groups`
 
-`-comment` `string` ::
+`--comment` `<string>` ::
 
 no description available
 
-`-email` `string` ::
+`--email` `<string>` ::
 
 no description available
 
-`-enable` `boolean` ::
+`--enable` `<boolean>` ::
 
 Enable/disable the account.
 
-`-expire` `integer (0 - N)` ::
+`--expire` `<integer> (0 - N)` ::
 
-Account expiration date (seconds since epoch). '0' means no expiration
-date.
+Account expiration date (seconds since epoch). '0' means no expiration date.
 
-`-firstname` `string` ::
+`--firstname` `<string>` ::
 
 no description available
 
-`-groups` `string` ::
+`--groups` `<string>` ::
 
 no description available
 
-`-keys` `string` ::
+`--keys` `<string>` ::
 
 Keys for two factor auth (yubico).
 
-`-lastname` `string` ::
+`--lastname` `<string>` ::
 
 no description available
 
 
-
-